passenger 2.0.6 → 2.1.2

data/ext/apache2/SystemTime.cpp

@@ -0,0 +1,28 @@
+/*
+ *  Phusion Passenger - http://www.modrails.com/
+ *  Copyright (C) 2009  Phusion
+ *
+ *  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+ *
+ *  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.
+ */
+
+#include <time.h>
+
+namespace Passenger {
+	namespace SystemTimeData {
+		bool hasForcedValue = false;
+		time_t forcedValue = 0;
+	}
+}

data/ext/apache2/SystemTime.h

@@ -0,0 +1,82 @@
+/*
+ *  Phusion Passenger - http://www.modrails.com/
+ *  Copyright (C) 2009  Phusion
+ *
+ *  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+ *
+ *  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.
+ */
+#ifndef _PASSENGER_SYSTEM_TIME_H_
+#define _PASSENGER_SYSTEM_TIME_H_
+
+#include <boost/thread.hpp>
+#include <oxt/system_calls.hpp>
+#include "Exceptions.h"
+
+namespace Passenger {
+
+using namespace oxt;
+
+namespace SystemTimeData {
+	extern bool hasForcedValue;
+	extern time_t forcedValue;
+}
+
+/**
+ * This class allows one to obtain the system time, similar to time(). Unlike
+ * time(), it is possible to force a certain time to be returned, which is
+ * useful for testing code that depends on the system time.
+ */
+class SystemTime {
+public:
+	/**
+	 * Returns the time since the Epoch, measured in seconds. Or, if a time
+	 * was forced, then the forced time is returned instead.
+	 *
+	 * @throws SystemException Something went wrong while retrieving the time.
+	 * @throws boost::thread_interrupted
+	 */
+	static time_t get() {
+		if (SystemTimeData::hasForcedValue) {
+			return SystemTimeData::forcedValue;
+		} else {
+			time_t ret = syscalls::time(NULL);
+			if (ret == -1) {
+				throw SystemException("Unable to retrieve the system time",
+					errno);
+			}
+			return ret;
+		}
+	}
+
+	/**
+	 * Force get() to return the given value.
+	 */
+	static void force(time_t value) {
+		SystemTimeData::hasForcedValue = true;
+		SystemTimeData::forcedValue = value;
+	}
+
+	/**
+	 * Release the previously forced value, so that get()
+	 * returns the system time once again.
+	 */
+	static void release() {
+		SystemTimeData::hasForcedValue = false;
+	}
+};
+
+} // namespace Passenger
+
+#endif /* _PASSENGER_SYSTEM_TIME_H_ */

data/ext/apache2/Utils.cpp

@@ -19,7 +19,7 @@
  */
 
 #include <cassert>
-#include <unistd.h>
+#include "CachedFileStat.h"
 #include "Utils.h"
 
 #define SPAWN_SERVER_SCRIPT_NAME "passenger-spawn-server"
@@ -31,6 +31,11 @@ atoi(const string &s) {
 	return ::atoi(s.c_str());
 }
 
+long
+atol(const string &s) {
+	return ::atol(s.c_str());
+}
+
 void
 split(const string &str, char sep, vector<string> &output) {
 	string::size_type start, pos;
@@ -44,14 +49,31 @@ split(const string &str, char sep, vector<string> &output) {
 }
 
 bool
-fileExists(const char *filename) {
+fileExists(const char *filename, CachedMultiFileStat *mstat, unsigned int throttleRate) {
+	return getFileType(filename, mstat, throttleRate) == FT_REGULAR;
+}
+
+FileType
+getFileType(const char *filename, CachedMultiFileStat *mstat, unsigned int throttleRate) {
 	struct stat buf;
+	int ret;
 	
-	if (stat(filename, &buf) == 0) {
-		return S_ISREG(buf.st_mode);
+	if (mstat != NULL) {
+		ret = cached_multi_file_stat_perform(mstat, filename, &buf, throttleRate);
+	} else {
+		ret = stat(filename, &buf);
+	}
+	if (ret == 0) {
+		if (S_ISREG(buf.st_mode)) {
+			return FT_REGULAR;
+		} else if (S_ISDIR(buf.st_mode)) {
+			return FT_DIRECTORY;
+		} else {
+			return FT_OTHER;
+		}
 	} else {
 		if (errno == ENOENT) {
-			return false;
+			return FT_NONEXISTANT;
 		} else {
 			int e = errno;
 			string message("Cannot stat '");
@@ -76,7 +98,7 @@ findSpawnServer(const char *passengerRoot) {
 			return path;
 		} else {
 			path.assign(root);
-			path.append("lib/passenger/passenger-spawn-server");
+			path.append("lib/phusion_passenger/passenger-spawn-server");
 			return path;
 		}
 		return path;
@@ -115,7 +137,7 @@ findApplicationPoolServer(const char *passengerRoot) {
 		return path;
 	} else {
 		path.assign(root);
-		path.append("lib/passenger/ApplicationPoolServerExecutable");
+		path.append("lib/phusion_passenger/ApplicationPoolServerExecutable");
 		return path;
 	}
 }
@@ -128,7 +150,13 @@ canonicalizePath(const string &path) {
 		// rationale.
 		char *tmp = realpath(path.c_str(), NULL);
 		if (tmp == NULL) {
-			return "";
+			int e = errno;
+			string message;
+			
+			message = "Cannot resolve the path '";
+			message.append(path);
+			message.append("'");
+			throw FileSystemException(message, e, path);
 		} else {
 			string result(tmp);
 			free(tmp);
@@ -137,32 +165,158 @@ canonicalizePath(const string &path) {
 	#else
 		char tmp[PATH_MAX];
 		if (realpath(path.c_str(), tmp) == NULL) {
-			return "";
+			int e = errno;
+			string message;
+			
+			message = "Cannot resolve the path '";
+			message.append(path);
+			message.append("'");
+			throw FileSystemException(message, e, path);
 		} else {
 			return tmp;
 		}
 	#endif
 }
 
+string
+escapeForXml(const string &input) {
+	string result(input);
+	string::size_type input_pos = 0;
+	string::size_type input_end_pos = input.size();
+	string::size_type result_pos = 0;
+	
+	while (input_pos < input_end_pos) {
+		const unsigned char ch = input[input_pos];
+		
+		if ((ch >= 'A' && ch <= 'z')
+		 || (ch >= '0' && ch <= '9')
+		 || ch == '/' || ch == ' ' || ch == '_' || ch == '.') {
+			// This is an ASCII character. Ignore it and
+			// go to next character.
+			result_pos++;
+		} else {
+			// Not an ASCII character; escape it.
+			char escapedCharacter[sizeof("&#255;") + 1];
+			int size;
+			
+			size = snprintf(escapedCharacter,
+				sizeof(escapedCharacter) - 1,
+				"&#%d;",
+				(int) ch);
+			if (size < 0) {
+				throw std::bad_alloc();
+			}
+			escapedCharacter[sizeof(escapedCharacter) - 1] = '\0';
+			
+			result.replace(result_pos, 1, escapedCharacter, size);
+			result_pos += size;
+		}
+		input_pos++;
+	}
+	
+	return result;
+}
+
+const char *
+getTempDir() {
+	const char *temp_dir = getenv("TMPDIR");
+	if (temp_dir == NULL || *temp_dir == '\0') {
+		temp_dir = "/tmp";
+	}
+	return temp_dir;
+}
+
+string
+getPassengerTempDir(bool bypassCache) {
+	if (bypassCache) {
+		goto calculateResult;
+	} else {
+		const char *tmp = getenv("PHUSION_PASSENGER_TMP");
+		if (tmp != NULL && *tmp != '\0') {
+			return tmp;
+		} else {
+			goto calculateResult;
+		}
+	}
+
+	calculateResult:
+	const char *temp_dir = getTempDir();
+	char buffer[PATH_MAX];
+	
+	snprintf(buffer, sizeof(buffer), "%s/passenger.%lu",
+		temp_dir, (unsigned long) getpid());
+	buffer[sizeof(buffer) - 1] = '\0';
+	setenv("PHUSION_PASSENGER_TMP", buffer, 1);
+	return buffer;
+}
+
+void
+createPassengerTempDir() {
+	makeDirTree(getPassengerTempDir().c_str(), "u=rwxs,g=wx,o=wx");
+}
+
+void
+makeDirTree(const char *path, const char *mode) {
+	char command[PATH_MAX + 10];
+	snprintf(command, sizeof(command), "mkdir -p -m \"%s\" \"%s\"", mode, path);
+	command[sizeof(command) - 1] = '\0';
+	
+	int result;
+	do {
+		result = system(command);
+	} while (result == -1 && errno == EINTR);
+	if (result != 0) {
+		char message[1024];
+		int e = errno;
+		
+		snprintf(message, sizeof(message) - 1, "Cannot create directory '%s'", path);
+		message[sizeof(message) - 1] = '\0';
+		if (result == -1) {
+			throw SystemException(message, e);
+		} else {
+			throw IOException(message);
+		}
+	}
+}
+
+void
+removeDirTree(const char *path) {
+	char command[PATH_MAX + 10];
+	snprintf(command, sizeof(command), "rm -rf \"%s\"", path);
+	command[sizeof(command) - 1] = '\0';
+	
+	int result;
+	do {
+		result = system(command);
+	} while (result == -1 && errno == EINTR);
+	if (result == -1) {
+		char message[1024];
+		
+		snprintf(message, sizeof(message) - 1, "Cannot create directory '%s'", path);
+		message[sizeof(message) - 1] = '\0';
+		throw IOException(message);
+	}
+}
+
 bool
-verifyRailsDir(const string &dir) {
+verifyRailsDir(const string &dir, CachedMultiFileStat *mstat, unsigned int throttleRate) {
 	string temp(dir);
-	temp.append("/../config/environment.rb");
-	return fileExists(temp.c_str());
+	temp.append("/config/environment.rb");
+	return fileExists(temp.c_str(), mstat, throttleRate);
 }
 
 bool
-verifyRackDir(const string &dir) {
+verifyRackDir(const string &dir, CachedMultiFileStat *mstat, unsigned int throttleRate) {
 	string temp(dir);
-	temp.append("/../config.ru");
-	return fileExists(temp.c_str());
+	temp.append("/config.ru");
+	return fileExists(temp.c_str(), mstat, throttleRate);
 }
 
 bool
-verifyWSGIDir(const string &dir) {
+verifyWSGIDir(const string &dir, CachedMultiFileStat *mstat, unsigned int throttleRate) {
 	string temp(dir);
-	temp.append("/../passenger_wsgi.py");
-	return fileExists(temp.c_str());
+	temp.append("/passenger_wsgi.py");
+	return fileExists(temp.c_str(), mstat, throttleRate);
 }
 
 } // namespace Passenger

data/ext/apache2/Utils.h

@@ -32,13 +32,28 @@
 #include <cstdlib>
 #include <cstring>
 #include <errno.h>
+#include <unistd.h>
 #include "Exceptions.h"
 
+typedef struct CachedMultiFileStat CachedMultiFileStat;
+
 namespace Passenger {
 
 using namespace std;
 using namespace boost;
 
+/** Enumeration which indicates what kind of file a file is. */
+typedef enum {
+	/** The file doesn't exist. */
+	FT_NONEXISTANT,
+	/** A regular file or a symlink to a regular file. */
+	FT_REGULAR,
+	/** A directory. */
+	FT_DIRECTORY,
+	/** Something else, e.g. a pipe or a socket. */
+	FT_OTHER
+} FileType;
+
 /**
  * Convenience shortcut for creating a <tt>shared_ptr</tt>.
  * Instead of:
@@ -118,6 +133,12 @@ toString(T something) {
  */
 int atoi(const string &s);
 
+/**
+ * Converts the given string to a long integer.
+ * @ingroup Support
+ */
+long atol(const string &s);
+
 /**
  * Split the given string using the given separator.
  *
@@ -132,11 +153,27 @@ void split(const string &str, char sep, vector<string> &output);
  * Check whether the specified file exists.
  *
  * @param filename The filename to check.
+ * @param mstat A CachedMultiFileStat object, if you want to use cached statting.
+ * @param throttleRate A throttle rate for mstat. Only applicable if mstat is not NULL.
  * @return Whether the file exists.
  * @throws FileSystemException Unable to check because of a filesystem error.
  * @ingroup Support
  */
-bool fileExists(const char *filename);
+bool fileExists(const char *filename, CachedMultiFileStat *mstat = 0,
+                unsigned int throttleRate = 0);
+
+/**
+ * Check whether 'filename' exists and what kind of file it is.
+ *
+ * @param filename The filename to check.
+ * @param mstat A CachedMultiFileStat object, if you want to use cached statting.
+ * @param throttleRate A throttle rate for mstat. Only applicable if mstat is not NULL.
+ * @return The file type.
+ * @throws FileSystemException Unable to check because of a filesystem error.
+ * @ingroup Support
+ */
+FileType getFileType(const char *filename, CachedMultiFileStat *mstat = 0,
+                     unsigned int throttleRate = 0);
 
 /**
  * Find the location of the Passenger spawn server script.
@@ -167,38 +204,109 @@ string findApplicationPoolServer(const char *passengerRoot);
 /**
  * Returns a canonical version of the specified path. All symbolic links
  * and relative path elements are resolved.
- * Returns an empty string if something went wrong.
  *
+ * @throws FileSystemException Something went wrong.
  * @ingroup Support
  */
 string canonicalizePath(const string &path);
 
+/**
+ * Escape the given raw string into an XML value.
+ *
+ * @throws std::bad_alloc Something went wrong.
+ * @ingroup Support
+ */
+string escapeForXml(const string &input);
+
+/**
+ * Return the path name for the directory in which temporary files are
+ * to be stored.
+ *
+ * @ensure result != NULL
+ * @ingroup Support
+ */
+const char *getTempDir();
+
+/**
+ * Return the path name for the directory in which Phusion Passenger-specific
+ * temporary files are to be stored. This directory is unique for this instance
+ * of the web server in which Phusion Passenger is running.
+ *
+ * The result will be cached into the PHUSION_PASSENGER_TMP environment variable,
+ * which will be used for future calls to this function. To bypass this cache,
+ * set 'bypassCache' to true.
+ *
+ * @ensure !result.empty()
+ * @ingroup Support
+ */
+string getPassengerTempDir(bool bypassCache = false);
+
+/* Create a temp folder for storing Phusion Passenger-specific temp files,
+ * such as temporarily buffered uploads, sockets for backend processes, etc.
+ * This call also sets the PHUSION_PASSENGER_TMP environment variable, which
+ * allows backend processes to find this temp folder.
+ *
+ * Does nothing if this folder already exists.
+ *
+ * @throws IOException Something went wrong.
+ * @throws SystemException Something went wrong.
+ */
+void createPassengerTempDir();
+
+/**
+ * Create the directory at the given path, creating intermediate directories
+ * if necessary. The created directories' permissions are as specified by the
+ * 'mode' parameter.
+ *
+ * If 'path' already exists, then nothing will happen.
+ *
+ * @throws IOException Something went wrong.
+ * @throws SystemException Something went wrong.
+ */
+void makeDirTree(const char *path, const char *mode = "u=rwx,g=,o=");
+
+/**
+ * Remove an entire directory tree recursively.
+ *
+ * @throws SystemException Something went wrong.
+ */
+void removeDirTree(const char *path);
+
 /**
  * Check whether the specified directory is a valid Ruby on Rails
- * 'public' directory.
+ * application root directory.
  *
+ * @param mstat A CachedMultiFileStat object, if you want to use cached statting.
+ * @param throttleRate A throttle rate for mstat. Only applicable if mstat is not NULL.
  * @throws FileSystemException Unable to check because of a system error.
  * @ingroup Support
  */
-bool verifyRailsDir(const string &dir);
+bool verifyRailsDir(const string &dir, CachedMultiFileStat *mstat = 0,
+                    unsigned int throttleRate = 0);
 
 /**
- * Check whether the specified directory is a valid Rack 'public'
- * directory.
+ * Check whether the specified directory is a valid Rack application
+ * root directory.
  *
+ * @param mstat A CachedMultiFileStat object, if you want to use cached statting.
+ * @param throttleRate A throttle rate for mstat. Only applicable if mstat is not NULL.
  * @throws FileSystemException Unable to check because of a filesystem error.
  * @ingroup Support
  */
-bool verifyRackDir(const string &dir);
+bool verifyRackDir(const string &dir, CachedMultiFileStat *mstat = 0,
+                   unsigned int throttleRate = 0);
 
 /**
- * Check whether the specified directory is a valid WSGI 'public'
- * directory.
+ * Check whether the specified directory is a valid WSGI application
+ * root directory.
  *
+ * @param mstat A CachedMultiFileStat object, if you want to use cached statting.
+ * @param throttleRate A throttle rate for mstat. Only applicable if mstat is not NULL.
  * @throws FileSystemException Unable to check because of a filesystem error.
  * @ingroup Support
  */
-bool verifyWSGIDir(const string &dir);
+bool verifyWSGIDir(const string &dir, CachedMultiFileStat *mstat = 0,
+                   unsigned int throttleRate = 0);
 
 /**
  * Represents a temporary file. The associated file is automatically
@@ -221,21 +329,18 @@ public:
 	 *        a big not-in-memory buffer to work with.
 	 * @throws SystemException Something went wrong.
 	 */
-	TempFile(bool anonymous = true) {
-		const char *temp_dir;
+	TempFile(const char *identifier = "temp", bool anonymous = true) {
 		char templ[PATH_MAX];
 		int fd;
 		
-		temp_dir = getenv("TMP");
-		if (temp_dir == NULL || *temp_dir == '\0') {
-			temp_dir = "/tmp";
-		}
-		
-		snprintf(templ, sizeof(templ), "%s/passenger.XXXXXX", temp_dir);
+		snprintf(templ, sizeof(templ), "%s/%s.XXXXXX", getPassengerTempDir().c_str(), identifier);
 		templ[sizeof(templ) - 1] = '\0';
 		fd = mkstemp(templ);
 		if (fd == -1) {
-			throw SystemException("Cannot create a temporary file", errno);
+			char message[1024];
+			snprintf(message, sizeof(message), "Cannot create a temporary file '%s'", templ);
+			message[sizeof(message) - 1] = '\0';
+			throw SystemException(message, errno);
 		}
 		if (anonymous) {
 			fchmod(fd, 0000);