Rakefile

# kate: syntax ruby

#  Phusion Passenger - http://www.modrails.com/
#  Copyright (C) 2008, 2009  Phusion
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; version 2 of the License.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License along
#  with this program; if not, write to the Free Software Foundation, Inc.,
#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/misc")
require 'rubygems'
require 'pathname'
require 'rake/rdoctask'
require 'rake/gempackagetask'
require 'rake/extensions'
require 'rake/cplusplus'
require 'phusion_passenger/platform_info'
require 'phusion_passenger/constants'

verbose true

##### Configuration

PACKAGE_VERSION = PhusionPassenger::VERSION_STRING
OPTIMIZE = ["yes", "on", "true"].include?(ENV['OPTIMIZE'])

include PlatformInfo

CXX = "g++"
LIBEXT = PlatformInfo.library_extension
if OPTIMIZE
	OPTIMIZATION_FLAGS = "#{PlatformInfo.debugging_cflags} -O2 -DBOOST_DISABLE_ASSERTS"
else
	OPTIMIZATION_FLAGS = "#{PlatformInfo.debugging_cflags} -DPASSENGER_DEBUG -DBOOST_DISABLE_ASSERTS"
end

# Extra compiler flags that should always be passed to the C/C++ compiler.
# Should be included last in the command string.
EXTRA_CXXFLAGS = "-Wall #{OPTIMIZATION_FLAGS}"

# Extra linker flags that should always be passed to the linker.
# Should be included last in the command string.
EXTRA_LDFLAGS  = ""


#### Default tasks

desc "Build everything"
task :default => [
	:native_support,
	:apache2,
	:nginx,
	'test/oxt/oxt_test_main',
	'test/CxxTests'
]

desc "Remove compiled files"
task :clean

desc "Remove all generated files"
task :clobber


##### Ruby C extension

task :native_support => "ext/phusion_passenger/native_support.#{LIBEXT}"

file 'ext/phusion_passenger/Makefile' => 'ext/phusion_passenger/extconf.rb' do
	sh "cd ext/phusion_passenger && #{RUBY} extconf.rb"
end

file "ext/phusion_passenger/native_support.#{LIBEXT}" => [
	'ext/phusion_passenger/Makefile',
	'ext/phusion_passenger/native_support.c'
] do
	sh "cd ext/phusion_passenger && make"
end

task :clean do
	sh "cd ext/phusion_passenger && make clean" if File.exist?('ext/phusion_passenger/Makefile')
	sh "rm -f ext/phusion_passenger/Makefile"
end


##### Boost and OXT static library

def define_libboost_oxt_task(output_dir, extra_compiler_flags = nil)
	output_file = "#{output_dir}/libboost_oxt.a"
	output_dir_base = "#{output_dir}/libboost_oxt"
	flags = "-Iext #{extra_compiler_flags} #{PlatformInfo.portability_cflags} #{EXTRA_CXXFLAGS}"
	
	# Define compilation targets for .cpp files in ext/boost/src/pthread.
	boost_object_files = []
	Dir['ext/boost/src/pthread/*.cpp'].each do |source_file|
		object_name = File.basename(source_file.sub(/\.cpp$/, '.o'))
		boost_output_dir  = "#{output_dir_base}/boost"
		object_file = "#{boost_output_dir}/#{object_name}"
		boost_object_files << object_file
		
		file object_file => source_file do
			sh "mkdir -p #{boost_output_dir}" if !File.directory?(boost_output_dir)
			compile_cxx(source_file, "#{flags} -o #{object_file}")
		end
	end
	
	# Define compilation targets for .cpp files in ext/oxt.
	oxt_object_files = []
	oxt_dependency_files = Dir["ext/oxt/*.hpp"] + Dir["ext/oxt/detail/*.hpp"]
	Dir['ext/oxt/*.cpp'].each do |source_file|
		object_name = File.basename(source_file.sub(/\.cpp$/, '.o'))
		oxt_output_dir  = "#{output_dir_base}/oxt"
		object_file = "#{oxt_output_dir}/#{object_name}"
		oxt_object_files << object_file
		
		file object_file => [source_file, *oxt_dependency_files] do
			sh "mkdir -p #{oxt_output_dir}" if !File.directory?(oxt_output_dir)
			compile_cxx(source_file, "#{flags} -o #{object_file}")
		end
	end
	
	file(output_file => boost_object_files + oxt_object_files) do
		sh "mkdir -p #{output_dir_base}/boost #{output_dir_base}/oxt"
		create_static_library(output_file,
			"#{output_dir_base}/boost/*.o " <<
			"#{output_dir_base}/oxt/*.o")
	end
	
	task :clean do
		sh "rm -rf #{output_file} #{output_dir_base}"
	end
	
	return output_file
end


##### Static library for Passenger source files that are shared between
##### the Apache module and the Nginx helper server.

def define_common_library_task(output_dir, extra_compiler_flags = nil,
                               with_application_pool_server_exe = false,
                               boost_oxt_library = nil,
                               extra_compiler_flags_for_server_exe = nil,
                               extra_linker_flags_for_server_exe = nil)
	static_library = "#{output_dir}/libpassenger_common.a"
	objects_output_dir = "#{output_dir}/libpassenger_common"
	targets = [static_library]
	
	# Define compilation targets for the object files in libpassenger_common.
	flags =  "-Iext -Iext/common #{extra_compiler_flags} "
	flags << "#{PlatformInfo.portability_cflags} #{EXTRA_CXXFLAGS}"
	common_object_files = []
	['Utils.cpp', 'Logging.cpp', 'SystemTime.cpp', 'CachedFileStat.cpp',
	 'Base64.cpp'].each do |source_file|
		object_name = source_file.sub(/\.cpp$/, '.o')
		object_file = "#{objects_output_dir}/#{object_name}"
		header_file = source_file.sub(/\.cpp$/, '.h')
		common_object_files << object_file
		
		file object_file => ["ext/common/#{source_file}", "ext/common/#{header_file}"] do
			sh "mkdir -p #{objects_output_dir}" if !File.directory?(objects_output_dir)
			compile_cxx("ext/common/#{source_file}", "#{flags} -o #{object_file}")
		end
	end
	
	file(static_library => common_object_files) do
		sh "mkdir -p #{objects_output_dir}"
		create_static_library(static_library, "#{objects_output_dir}/*.o")
	end
	
	if with_application_pool_server_exe
		exe_file = "#{output_dir}/ApplicationPoolServerExecutable"
		targets << exe_file
		
		file(exe_file => [
			'ext/common/ApplicationPoolServerExecutable.cpp',
			'ext/common/ApplicationPool.h',
			'ext/common/Application.h',
			'ext/common/StandardApplicationPool.h',
			'ext/common/ApplicationPoolStatusReporter.h',
			'ext/common/MessageChannel.h',
			'ext/common/SpawnManager.h',
			'ext/common/PoolOptions.h',
			'ext/common/StringListCreator.h',
			'ext/common/FileChecker.h',
			'ext/common/SystemTime.h',
			'ext/common/CachedFileStat.h',
			boost_oxt_library,
			static_library
		]) do
			create_executable(exe_file,
				"ext/common/ApplicationPoolServerExecutable.cpp",
				"-Iext -Iext/common " <<
				"#{extra_compiler_flags_for_server_exe} " <<
				"#{extra_compiler_flags} " <<
				"#{PlatformInfo.portability_cflags} " <<
				"#{EXTRA_CXXFLAGS} " <<
				"#{static_library} " <<
				"#{boost_oxt_library} " <<
				"#{extra_linker_flags_for_server_exe} " <<
				"#{PlatformInfo.portability_ldflags} " <<
				EXTRA_LDFLAGS
			)
		end
	end
	
	task :clean do
		sh "rm -rf #{targets.join(' ')} #{objects_output_dir}"
	end
	
	return targets
end


##### Apache 2 module

	APACHE2_CXXFLAGS = "-Iext -Iext/common #{PlatformInfo.apache2_module_cflags} " <<
		"#{PlatformInfo.portability_cflags} #{EXTRA_CXXFLAGS}"
	APACHE2_INPUT_FILES = {
		'ext/apache2/Configuration.o' => %w(
			ext/apache2/Configuration.cpp
			ext/apache2/Configuration.h),
		'ext/apache2/Bucket.o' => %w(
			ext/apache2/Bucket.cpp
			ext/apache2/Bucket.h),
		'ext/apache2/Hooks.o' => %w(
			ext/apache2/Hooks.cpp
			ext/apache2/Hooks.h
			ext/apache2/Configuration.h
			ext/apache2/Bucket.h
			ext/apache2/DirectoryMapper.h
			ext/common/ApplicationPool.h
			ext/common/ApplicationPoolServer.h
			ext/common/SpawnManager.h
			ext/common/Exceptions.h
			ext/common/Application.h
			ext/common/MessageChannel.h
			ext/common/PoolOptions.h
			ext/common/StringListCreator.h
			ext/common/Version.h
			ext/common/Timer.h
			ext/common/Utils.h)
	}
	APACHE2_OBJECTS = APACHE2_INPUT_FILES.keys
	
	# NOTE: APACHE2_BOOST_OXT_LIBRARY is a task name, while APACHE2_COMMON_LIBRARY
	# is an array of task names.
	APACHE2_BOOST_OXT_LIBRARY = define_libboost_oxt_task("ext/apache2",
		PlatformInfo.apache2_module_cflags)
	APACHE2_COMMON_LIBRARY    = define_common_library_task("ext/apache2",
		PlatformInfo.apache2_module_cflags,
		true, APACHE2_BOOST_OXT_LIBRARY)
	
	
	desc "Build Apache 2 module"
	task :apache2 => ['ext/apache2/mod_passenger.so', :native_support]
	
	mod_passenger_dependencies = [APACHE2_COMMON_LIBRARY,
		APACHE2_BOOST_OXT_LIBRARY,
		'ext/apache2/mod_passenger.o',
		APACHE2_OBJECTS].flatten
	file 'ext/apache2/mod_passenger.so' => mod_passenger_dependencies do
		PlatformInfo.apxs2.nil?      and raise "Could not find 'apxs' or 'apxs2'."
		PlatformInfo.apache2ctl.nil? and raise "Could not find 'apachectl' or 'apache2ctl'."
		PlatformInfo.httpd.nil?      and raise "Could not find the Apache web server binary."
		
		# 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
		# Apache module ourselves.
		#
		# Oh, and libtool sucks too. Do we even need it anymore in 2008?
		
		sources = APACHE2_OBJECTS.join(' ')
		sources << ' ext/apache2/mod_passenger.o'
		
		linkflags =
			"#{PlatformInfo.apache2_module_cflags} " <<
			"#{PlatformInfo.portability_cflags} " <<
			"#{EXTRA_CXXFLAGS} " <<
			"#{APACHE2_COMMON_LIBRARY[0]} " <<
			"#{APACHE2_BOOST_OXT_LIBRARY} " <<
			"#{PlatformInfo.apache2_module_ldflags} " <<
			"#{PlatformInfo.portability_ldflags} " <<
			"#{EXTRA_LDFLAGS} "
		
		create_shared_library('ext/apache2/mod_passenger.so',
			sources, linkflags)
	end

	file 'ext/apache2/mod_passenger.o' => ['ext/apache2/mod_passenger.c'] do
		compile_c('ext/apache2/mod_passenger.c',
			APACHE2_CXXFLAGS +
			" -o ext/apache2/mod_passenger.o")
	end

	APACHE2_INPUT_FILES.each_pair do |target, sources|
		file(target => sources) do
			object_basename = File.basename(target)
			compile_cxx(sources[0],
				APACHE2_CXXFLAGS +
				" -o ext/apache2/#{object_basename}")
		end
	end

	task :clean => 'apache2:clean'

	# Remove generated files for the Apache 2 module
	task 'apache2:clean' do
		files = [APACHE2_OBJECTS, %w(ext/apache2/mod_passenger.o
			ext/apache2/mod_passenger.so)]
		sh("rm", "-rf", *files.flatten)
	end


##### Nginx helper server

	# NOTE: NGINX_BOOST_OXT_LIBRARY is a task name, while NGINX_COMMON_LIBRARY
	# is an array of task names.
	NGINX_BOOST_OXT_LIBRARY = define_libboost_oxt_task("ext/nginx")
	NGINX_COMMON_LIBRARY    = define_common_library_task("ext/nginx")
	
	desc "Build Nginx helper server"
	task :nginx => ['ext/nginx/HelperServer', :native_support]
	
	helper_server_dependencies = [
		NGINX_BOOST_OXT_LIBRARY,
		NGINX_COMMON_LIBRARY[0],
		'ext/nginx/HelperServer.cpp',
		'ext/nginx/ScgiRequestParser.h',
		'ext/nginx/HttpStatusExtractor.h',
		'ext/common/StaticString.h',
		'ext/common/StandardApplicationPool.h'
		]
	file 'ext/nginx/HelperServer' => helper_server_dependencies do
		create_executable "ext/nginx/HelperServer",
			'ext/nginx/HelperServer.cpp',
			"-Iext -Iext/common " <<
			"#{PlatformInfo.portability_cflags} " <<
			"#{EXTRA_CXXFLAGS}  " <<
			"#{NGINX_COMMON_LIBRARY[0]} " <<
			"#{NGINX_BOOST_OXT_LIBRARY} " <<
			"#{PlatformInfo.portability_ldflags} " <<
			"#{EXTRA_LDFLAGS}"
	end
	
	task :clean => 'nginx:clean'
	
	# Remove Nginx helper server
	task 'nginx:clean' do
		sh("rm", "-rf", "ext/nginx/HelperServer")
	end


##### Unit tests

	TEST_BOOST_OXT_LIBRARY = define_libboost_oxt_task("test")
	TEST_COMMON_LIBRARY    = define_common_library_task("test",
		nil, true, TEST_BOOST_OXT_LIBRARY)
	
	TEST_COMMON_CFLAGS = "-DTESTING_SPAWN_MANAGER -DTESTING_APPLICATION_POOL " <<
		"#{PlatformInfo.portability_cflags} #{EXTRA_CXXFLAGS}"
	
	TEST_OXT_CFLAGS = "-I../../ext -I../support #{TEST_COMMON_CFLAGS}"
	TEST_OXT_LDFLAGS = "#{TEST_BOOST_OXT_LIBRARY} #{PlatformInfo.portability_ldflags} #{EXTRA_LDFLAGS}"
	TEST_OXT_OBJECTS = {
		'oxt_test_main.o' => %w(oxt_test_main.cpp),
		'backtrace_test.o' => %w(backtrace_test.cpp),
		'syscall_interruption_test.o' => %w(syscall_interruption_test.cpp)
	}
	
	TEST_CXX_CFLAGS = "-Iext -Iext/common -Iext/nginx -Itest/support " <<
		"#{PlatformInfo.apr_flags} #{PlatformInfo.apu_flags} #{TEST_COMMON_CFLAGS}"
	TEST_CXX_LDFLAGS = "#{PlatformInfo.apr_libs} #{PlatformInfo.apu_libs} " <<
		"#{TEST_COMMON_LIBRARY[0]} #{TEST_BOOST_OXT_LIBRARY} " <<
		"#{PlatformInfo.portability_ldflags} #{EXTRA_LDFLAGS}"
	TEST_CXX_OBJECTS = {
		'test/CxxTestMain.o' => %w(
			test/CxxTestMain.cpp),
		'test/support/Support.o' => %w(
			test/support/Support.cpp
			test/support/Support.h),
		'test/MessageChannelTest.o' => %w(
			test/MessageChannelTest.cpp
			ext/common/MessageChannel.h),
		'test/SpawnManagerTest.o' => %w(
			test/SpawnManagerTest.cpp
			ext/common/SpawnManager.h
			ext/common/PoolOptions.h
			ext/common/StringListCreator.h
			ext/common/Application.h
			ext/common/MessageChannel.h),
		'test/ApplicationPoolServerTest.o' => %w(
			test/ApplicationPoolServerTest.cpp
			ext/common/ApplicationPoolServer.h
			ext/common/PoolOptions.h
			ext/common/StringListCreator.h
			ext/common/MessageChannel.h),
		'test/ApplicationPoolServer_ApplicationPoolTest.o' => %w(
			test/ApplicationPoolServer_ApplicationPoolTest.cpp
			test/ApplicationPoolTest.cpp
			ext/common/ApplicationPoolServer.h
			ext/common/ApplicationPool.h
			ext/common/SpawnManager.h
			ext/common/PoolOptions.h
			ext/common/StringListCreator.h
			ext/common/Application.h
			ext/common/MessageChannel.h),
		'test/StandardApplicationPoolTest.o' => %w(
			test/StandardApplicationPoolTest.cpp
			test/ApplicationPoolTest.cpp
			ext/common/ApplicationPool.h
			ext/common/StandardApplicationPool.h
			ext/common/SpawnManager.h
			ext/common/PoolOptions.h
			ext/common/StringListCreator.h
			ext/common/FileChecker.h
			ext/common/Application.h),
		'test/PoolOptionsTest.o' => %w(
			test/PoolOptionsTest.cpp
			ext/common/PoolOptions.h
			ext/common/StringListCreator.h),
		'test/StaticStringTest.o' => %w(
			test/StaticStringTest.cpp
			ext/common/StaticString.h),
		'test/Base64Test.o' => %w(
			test/Base64Test.cpp
			ext/common/Base64.h
			ext/common/Base64.cpp),
		'test/ScgiRequestParserTest.o' => %w(
			test/ScgiRequestParserTest.cpp
			ext/nginx/ScgiRequestParser.h
			ext/common/StaticString.h),
		'test/HttpStatusExtractorTest.o' => %w(
			test/HttpStatusExtractorTest.cpp
			ext/nginx/HttpStatusExtractor.h),
		'test/FileCheckerTest.o' => %w(
			test/FileCheckerTest.cpp
			ext/common/FileChecker.h
			ext/common/CachedFileStat.h),
		'test/SystemTimeTest.o' => %w(
			test/SystemTimeTest.cpp
			ext/common/SystemTime.h
			ext/common/SystemTime.cpp),
		'test/CachedFileStatTest.o' => %w(
			test/CachedFileStatTest.cpp
			ext/common/CachedFileStat.h
			ext/common/CachedFileStat.cpp),
		'test/UtilsTest.o' => %w(
			test/UtilsTest.cpp
			ext/common/Utils.h)
	}

	desc "Run all unit tests and integration tests"
	task :test => ['test:oxt', 'test:cxx', 'test:ruby', 'test:integration']
	
	desc "Run unit tests for the OXT library"
	task 'test:oxt' => 'test/oxt/oxt_test_main' do
		sh "cd test && ./oxt/oxt_test_main"
	end
	
	desc "Run unit tests for the Apache 2 and Nginx C++ components"
	task 'test:cxx' => ['test/CxxTests', :native_support] do
		sh "cd test && ./CxxTests"
	end
	
	desc "Run unit tests for the Ruby libraries"
	task 'test:ruby' => :native_support do
		if PlatformInfo.rspec.nil?
			abort "RSpec is not installed for Ruby interpreter '#{PlatformInfo::RUBY}'. Please install it."
		else
			Dir.chdir("test") do
				ruby "#{PlatformInfo.rspec} -c -f s ruby/*.rb ruby/*/*.rb"
			end
		end
	end
	
	desc "Run coverage tests for the Ruby libraries"
	task 'test:rcov' => :native_support do
		if PlatformInfo.rspec.nil?
			abort "RSpec is not installed for Ruby interpreter '#{PlatformInfo::RUBY}'. Please install it."
		else
			Dir.chdir("test") do
				sh "rcov", "--exclude",
					"lib\/spec,\/spec$,_spec\.rb$,support\/,platform_info,integration_tests",
					PlatformInfo.rspec, "--", "-c", "-f", "s",
					*Dir["ruby/*.rb", "ruby/*/*.rb", "integration_tests.rb"]
			end
		end
	end
	
	desc "Run all integration tests"
	task 'test:integration' => ['test:integration:apache2', 'test:integration:nginx'] do
	end
	
	desc "Run Apache 2 integration tests"
	task 'test:integration:apache2' => [:apache2, :native_support] do
		if PlatformInfo.rspec.nil?
			abort "RSpec is not installed for Ruby interpreter '#{PlatformInfo::RUBY}'. Please install it."
		else
			Dir.chdir("test") do
				ruby "#{PlatformInfo.rspec} -c -f s integration_tests/apache2_tests.rb"
			end
		end
	end
	
	desc "Run Nginx integration tests"
	task 'test:integration:nginx' => :nginx do
		if PlatformInfo.rspec.nil?
			abort "RSpec is not installed for Ruby interpreter '#{PlatformInfo::RUBY}'. Please install it."
		else
			Dir.chdir("test") do
				ruby "#{PlatformInfo.rspec} -c -f s integration_tests/nginx_tests.rb"
			end
		end
	end
	
	oxt_test_main_dependencies = TEST_OXT_OBJECTS.keys.map do |object|
		"test/oxt/#{object}"
	end
	oxt_test_main_dependencies << TEST_BOOST_OXT_LIBRARY
	file 'test/oxt/oxt_test_main' => oxt_test_main_dependencies do
		objects = TEST_OXT_OBJECTS.keys.map{ |x| "test/oxt/#{x}" }.join(' ')
		create_executable("test/oxt/oxt_test_main", objects, TEST_OXT_LDFLAGS)
	end
	
	TEST_OXT_OBJECTS.each_pair do |target, sources|
		file "test/oxt/#{target}" => sources.map{ |x| "test/oxt/#{x}" } + ['test/support/Support.h'] do
			Dir.chdir('test/oxt') do
				puts "### In test/oxt:"
				compile_cxx sources[0], TEST_OXT_CFLAGS
			end
		end
	end

	cxx_tests_dependencies = [TEST_CXX_OBJECTS.keys,
		TEST_BOOST_OXT_LIBRARY, TEST_COMMON_LIBRARY]
	file 'test/CxxTests' => cxx_tests_dependencies.flatten do
		objects = TEST_CXX_OBJECTS.keys.join(' ')
		create_executable("test/CxxTests", objects, TEST_CXX_LDFLAGS)
	end
	
	TEST_CXX_OBJECTS.each_pair do |target, sources|
		file(target => sources) do
			compile_cxx sources[0], "-o #{target} #{TEST_CXX_CFLAGS}"
		end
	end
	
	desc "Run the 'restart' integration test infinitely, and abort if/when it fails"
	task 'test:restart' => [:apache2, :native_support] do
		Dir.chdir("test") do
			color_code_start = "\e[33m\e[44m\e[1m"
			color_code_end = "\e[0m"
			i = 1
			while true do
				puts "#{color_code_start}Test run #{i} (press Ctrl-C multiple times to abort)#{color_code_end}"
				sh "spec -c -f s integration_tests/apache2.rb -e 'mod_passenger running in Apache 2 : MyCook(tm) beta running on root URI should support restarting via restart.txt'"
				i += 1
			end
		end
	end
	
	task :clean do
		sh("rm -rf test/oxt/oxt_test_main test/oxt/*.o test/CxxTests test/*.o")
	end


##### Documentation

subdir 'doc' do
	ASCIIDOC = 'asciidoc'
	ASCIIDOC_FLAGS = "-a toc -a numbered -a toclevels=3 -a icons"
	ASCII_DOCS = ['Security of user switching support',
		'Users guide Apache', 'Users guide Nginx',
		'Architectural overview']

	DOXYGEN = 'doxygen'
	
	desc "Generate all documentation"
	task :doc => [:rdoc]
	
	if PlatformInfo.find_command(DOXYGEN)
		task :doc => :doxygen
	end

	task :doc => ASCII_DOCS.map{ |x| "#{x}.html" }

	ASCII_DOCS.each do |name|
		file "#{name}.html" => ["#{name}.txt"] do
			if PlatformInfo.find_command(ASCIIDOC)
		  		sh "#{ASCIIDOC} #{ASCIIDOC_FLAGS} '#{name}.txt'"
			else
				sh "echo 'asciidoc required to build docs' > '#{name}.html'"
			end
		end
	end
	
	task :clobber => [:'doxygen:clobber'] do
		sh "rm -f *.html"
	end
	
	desc "Generate Doxygen C++ API documentation if necessary"
	task :doxygen => ['cxxapi']
	file 'cxxapi' => Dir['../ext/apache2/*.{h,c,cpp}'] do
		sh "doxygen"
	end

	desc "Force generation of Doxygen C++ API documentation"
	task :'doxygen:force' do
		sh "doxygen"
	end

	desc "Remove generated Doxygen C++ API documentation"
	task :'doxygen:clobber' do
		sh "rm -rf cxxapi"
	end
end

Rake::RDocTask.new(:clobber_rdoc => "rdoc:clobber", :rerdoc => "rdoc:force") do |rd|
	rd.main = "README"
	rd.rdoc_dir = "doc/rdoc"
	rd.rdoc_files.include("README", "DEVELOPERS.TXT",
		"lib/phusion_passenger/*.rb",
		"lib/phusion_passenger/*/*.rb",
		"misc/rake/extensions.rb",
		"ext/phusion_passenger/*.c")
	rd.template = "./doc/template/horo"
	rd.title = "Passenger Ruby API"
	rd.options << "-S" << "-N" << "-p" << "-H"
end


##### Gem

spec = Gem::Specification.new do |s|
	s.platform = Gem::Platform::RUBY
	s.homepage = "http://www.modrails.com/"
	s.summary = "Apache module for Ruby on Rails support."
	s.name = "passenger"
	s.version = PACKAGE_VERSION
	s.rubyforge_project = "passenger"
	s.author = "Phusion - http://www.phusion.nl/"
	s.email = "info@phusion.nl"
	s.requirements << "fastthread" << "Apache 2 with development headers"
	s.require_paths = ["lib", "ext"]
	s.add_dependency 'rake', '>= 0.8.1'
	s.add_dependency 'fastthread', '>= 1.0.1'
	s.extensions << 'ext/phusion_passenger/extconf.rb'
	s.files = FileList[
		'Rakefile',
		'README',
		'DEVELOPERS.TXT',
		'LICENSE',
		'INSTALL',
		'NEWS',
		'lib/**/*.rb',
		'lib/**/*.py',
		'lib/phusion_passenger/templates/*',
		'lib/phusion_passenger/templates/apache2/*',
		'lib/phusion_passenger/templates/nginx/*',
		'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 Apache.html',
		'doc/Users guide Nginx.html',
		'doc/Security of user switching support.html',
		
		'doc/*/*',
		'doc/*/*/*',
		'doc/*/*/*/*',
		'doc/*/*/*/*/*',
		'doc/*/*/*/*/*/*',
		'man/*',
		'debian/*',
		'ext/common/*.{cpp,c,h}',
		'ext/apache2/*.{cpp,h,c,TXT}',
		'ext/nginx/*.{c,cpp,h}',
		'ext/nginx/config',
		'ext/boost/*.{hpp,TXT}',
		'ext/boost/**/*.{hpp,cpp,pl,inl,ipp}',
		'ext/oxt/*.hpp',
		'ext/oxt/*.cpp',
		'ext/oxt/detail/*.hpp',
		'ext/phusion_passenger/*.{c,rb}',
		'benchmark/*.{cpp,rb}',
		'misc/*',
		'misc/*/*',
		'vendor/**/*',
		'test/*.{rb,cpp,example}',
		'test/support/*.{cpp,h,rb}',
		'test/oxt/*.cpp',
		'test/ruby/*',
		'test/ruby/*/*',
		'test/integration_tests/*',
		'test/stub/*',
		'test/stub/*/*',
		'test/stub/*/*/*',
		'test/stub/*/*/*/*',
		'test/stub/*/*/*/*/*',
		'test/stub/*/*/*/*/*/*',
		'test/stub/*/*/*/*/*/*/*'
	] - Dir['test/stub/*/log/*'] \
	  - Dir['test/stub/*/tmp/*/*'] \
	  - Dir['test/stub/apache2/*.{pid,lock,log}']
	s.executables = [
		'passenger-spawn-server',
		'passenger-install-apache2-module',
		'passenger-install-nginx-module',
		'passenger-config',
		'passenger-memory-stats',
		'passenger-make-enterprisey',
		'passenger-status',
		'passenger-stress-test'
	]
	s.has_rdoc = true
	s.extra_rdoc_files = ['README']
	s.rdoc_options <<
		"-S" << "-N" << "-p" << "-H" <<
		'--main' << 'README' <<
		'--title' << 'Passenger Ruby API'
	s.description = "Passenger is an Apache module for Ruby on Rails support."
end

Rake::GemPackageTask.new(spec) do |pkg|
	pkg.need_tar_gz = true
end

Rake::Task['package'].prerequisites.unshift(:doc)
Rake::Task['package:gem'].prerequisites.unshift(:doc)
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/phusion_passenger"
	libexecdir = "#{fakeroot}/usr/lib/phusion_passenger"
	
	sh "rm -rf #{fakeroot}"
	sh "mkdir -p #{fakeroot}"
	
	sh "mkdir -p #{libdir}"
	sh "cp -R lib/phusion_passenger #{libdir}/"

	sh "mkdir -p #{extdir}/phusion_passenger"
	sh "cp -R ext/phusion_passenger/*.#{LIBEXT} #{extdir}/phusion_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"
	raw_arch = `uname -m`.strip
	arch = case raw_arch
	when /^i.86$/
		"i386"
	when /^x86_64/
		"amd64"
	else
		raw_arch
	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"
task :sloccount do
	ENV['LC_ALL'] = 'C'
	begin
		# sloccount doesn't recognize the scripts in
		# bin/ as Ruby, so we make symlinks with proper
		# extensions.
		tmpdir = ".sloccount"
		system "rm -rf #{tmpdir}"
		mkdir tmpdir
		Dir['bin/*'].each do |file|
			safe_ln file, "#{tmpdir}/#{File.basename(file)}.rb"
		end
		sh "sloccount", *Dir[
			"#{tmpdir}/*",
			"lib/phusion_passenger",
			"lib/rake/{cplusplus,extensions}.rb",
			"ext/apache2",
			"ext/nginx",
			"ext/common",
			"ext/oxt",
			"ext/phusion_passenger/*.c",
			"test/**/*.{cpp,rb}",
			"benchmark/*.{cpp,rb}"
		]
	ensure
		system "rm -rf #{tmpdir}"
	end
end