passenger 2.2.2 → 2.2.3

data/ext/common/SystemTime.h

@@ -49,7 +49,7 @@ 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 TimeRetrievalException Something went wrong while retrieving the time.
 	 * @throws boost::thread_interrupted
 	 */
 	static time_t get() {
@@ -58,7 +58,8 @@ public:
 		} else {
 			time_t ret = syscalls::time(NULL);
 			if (ret == -1) {
-				throw SystemException("Unable to retrieve the system time",
+				throw TimeRetrievalException(
+					"Unable to retrieve the system time",
 					errno);
 			}
 			return ret;

data/ext/common/Timer.h

@@ -0,0 +1,88 @@
+/*
+ *  Phusion Passenger - http://www.modrails.com/
+ *  Copyright (c) 2008, 2009 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.
+ */
+#ifndef _PASSENGER_TIMER_H_
+#define _PASSENGER_TIMER_H_
+
+#include <sys/time.h>
+
+namespace Passenger {
+
+/**
+ * A Timer which one can use to check how much time has elapsed since the timer started.
+ * This timer support microseconds-resolution, but the exact resolution depends on the OS
+ * and the hardware.
+ *
+ * @code
+ * Timer timer;
+ * sleep(10);
+ * timer.elapsed();   // => about 10000 (msec)
+ * @endcode
+ */
+class Timer {
+private:
+	struct timeval startTime;
+public:
+	/**
+	 * Creates a new Timer object.
+	 *
+	 * @param startNow Whether the timer should be started immediately.
+	 */
+	Timer(bool startNow = true) {
+		if (startNow) {
+			start();
+		} else {
+			startTime.tv_sec = 0;
+			startTime.tv_usec = 0;
+		}
+	}
+	
+	/**
+	 * Start the timer. If the timer was already started, then this will
+	 * restart the timer.
+	 */
+	void start() {
+		gettimeofday(&startTime, NULL);
+	}
+	
+	/**
+	 * Checks how much time has elapsed since the timer was last started.
+	 *
+	 * @pre The timer must have been started.
+	 * @return The elapsed time, in miliseconds.
+	 */
+	unsigned long long elapsed() const {
+		struct timeval t;
+		unsigned long long now, beginning;
+		
+		gettimeofday(&t, NULL);
+		now = (unsigned long long) t.tv_sec * 1000 + t.tv_usec / 1000;
+		beginning = (unsigned long long) startTime.tv_sec * 1000 + startTime.tv_usec / 1000;
+		return now - beginning;
+	}
+};
+
+} // namespace Passenger
+
+#endif /* _PASSENGER_TIMER_H_ */

data/ext/common/Utils.cpp

@@ -23,10 +23,16 @@
  *  THE SOFTWARE.
  */
 
+#include <oxt/system_calls.hpp>
+
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <sys/un.h>
 #include <cassert>
 #include <libgen.h>
 #include <pwd.h>
-#include "CachedFileStat.h"
+#include "CachedFileStat.hpp"
+#include "Exceptions.h"
 #include "Utils.h"
 
 #define SPAWN_SERVER_SCRIPT_NAME "passenger-spawn-server"
@@ -58,17 +64,17 @@ split(const string &str, char sep, vector<string> &output) {
 }
 
 bool
-fileExists(const char *filename, CachedMultiFileStat *mstat, unsigned int throttleRate) {
-	return getFileType(filename, mstat, throttleRate) == FT_REGULAR;
+fileExists(const char *filename, CachedFileStat *cstat, unsigned int throttleRate) {
+	return getFileType(filename, cstat, throttleRate) == FT_REGULAR;
 }
 
 FileType
-getFileType(const char *filename, CachedMultiFileStat *mstat, unsigned int throttleRate) {
+getFileType(const char *filename, CachedFileStat *cstat, unsigned int throttleRate) {
 	struct stat buf;
 	int ret;
 	
-	if (mstat != NULL) {
-		ret = cached_multi_file_stat_perform(mstat, filename, &buf, throttleRate);
+	if (cstat != NULL) {
+		ret = cstat->stat(filename, &buf, throttleRate);
 	} else {
 		ret = stat(filename, &buf);
 	}
@@ -267,6 +273,29 @@ escapeForXml(const string &input) {
 	return result;
 }
 
+string
+getProcessUsername() {
+	struct passwd pwd, *result;
+	char strings[1024];
+	int ret;
+	
+	result = (struct passwd *) NULL;
+	do {
+		ret = getpwuid_r(getuid(), &pwd, strings, sizeof(strings), &result);
+	} while (ret == -1 && errno == EINTR);
+	if (ret == -1) {
+		result = (struct passwd *) NULL;
+	}
+	
+	if (result == (struct passwd *) NULL) {
+		snprintf(strings, sizeof(strings), "UID %lld", (long long) getuid());
+		strings[sizeof(strings) - 1] = '\0';
+		return strings;
+	} else {
+		return result->pw_name;
+	}
+}
+
 void
 determineLowestUserAndGroup(const string &user, uid_t &uid, gid_t &gid) {
 	struct passwd *ent;
@@ -407,36 +436,6 @@ createPassengerTempDir(const string &parentDir, bool userSwitching,
 		 */
 		makeDirTree(tmpDir + "/backends", "u=wxs,g=,o=");
 	}
-	
-	if (geteuid() == 0) {
-		if (userSwitching) {
-			/* If user switching is possible and is on, then each backend
-			 * process may be running as a different user. So make the var
-			 * directory world-writable.
-			 *
-			 * The directory is not readable as a security precaution.
-			 */
-			makeDirTree(tmpDir + "/var", "u=wxs,g=wx,o=wx");
-		} else {
-			/* If user switching is off then all backend processes
-			 * will be running as lowestUser, so make lowestUser the
-			 * owner of the var directory. Only lowestUser may access
-			 * the directory.
-			 *
-			 * The directory is not readble as a security precaution.
-			 */
-			makeDirTree(tmpDir + "/var", "u=wxs,g=,o=", lowestUid, lowestGid);
-		}
-	} else {
-		/* If user switching is not possible then all backend processes will
-		 * be running as the same user as the web server. So we'll make the
-		 * var subdirectory only accessible by this user. Nobody else
-		 * (except root) may access this subdirectory.
-		 *
-		 * The directory is not readble as a security precaution.
-		 */
-		makeDirTree(tmpDir + "/var", "u=wxs,g=,o=");
-	}
 }
 
 void
@@ -513,24 +512,144 @@ removeDirTree(const string &path) {
 }
 
 bool
-verifyRailsDir(const string &dir, CachedMultiFileStat *mstat, unsigned int throttleRate) {
+verifyRailsDir(const string &dir, CachedFileStat *cstat, unsigned int throttleRate) {
 	string temp(dir);
 	temp.append("/config/environment.rb");
-	return fileExists(temp.c_str(), mstat, throttleRate);
+	return fileExists(temp.c_str(), cstat, throttleRate);
 }
 
 bool
-verifyRackDir(const string &dir, CachedMultiFileStat *mstat, unsigned int throttleRate) {
+verifyRackDir(const string &dir, CachedFileStat *cstat, unsigned int throttleRate) {
 	string temp(dir);
 	temp.append("/config.ru");
-	return fileExists(temp.c_str(), mstat, throttleRate);
+	return fileExists(temp.c_str(), cstat, throttleRate);
 }
 
 bool
-verifyWSGIDir(const string &dir, CachedMultiFileStat *mstat, unsigned int throttleRate) {
+verifyWSGIDir(const string &dir, CachedFileStat *cstat, unsigned int throttleRate) {
 	string temp(dir);
 	temp.append("/passenger_wsgi.py");
-	return fileExists(temp.c_str(), mstat, throttleRate);
+	return fileExists(temp.c_str(), cstat, throttleRate);
+}
+
+int
+createUnixServer(const char *filename, unsigned int backlogSize, bool autoDelete) {
+	struct sockaddr_un addr;
+	int fd, ret;
+	
+	if (strlen(filename) > sizeof(addr.sun_path) - 1) {
+		string message = "Cannot create Unix socket '";
+		message.append(filename);
+		message.append("': filename is too long.");
+		throw RuntimeException(message);
+	}
+	
+	fd = syscalls::socket(PF_UNIX, SOCK_STREAM, 0);
+	if (fd == -1) {
+		throw SystemException("Cannot create a Unix socket file descriptor", errno);
+	}
+	
+	addr.sun_family = AF_UNIX;
+	strncpy(addr.sun_path, filename, sizeof(addr.sun_path));
+	addr.sun_path[sizeof(addr.sun_path) - 1] = '\0';
+	
+	if (autoDelete) {
+		do {
+			ret = unlink(filename);
+		} while (ret == -1 && errno == EINTR);
+	}
+	
+	try {
+		ret = syscalls::bind(fd, (const struct sockaddr *) &addr, sizeof(addr));
+	} catch (...) {
+		do {
+			ret = close(fd);
+		} while (ret == -1 && errno == EINTR);
+		throw;
+	}
+	if (ret == -1) {
+		int e = errno;
+		string message = "Cannot bind Unix socket '";
+		message.append(filename);
+		message.append("'");
+		do {
+			ret = close(fd);
+		} while (ret == -1 && errno == EINTR);
+		throw SystemException(message, e);
+	}
+	
+	if (backlogSize == 0) {
+		#ifdef SOMAXCONN
+			backlogSize = SOMAXCONN;
+		#else
+			backlogSize = 128;
+		#endif
+	}
+	try {
+		ret = syscalls::listen(fd, backlogSize);
+	} catch (...) {
+		do {
+			ret = close(fd);
+		} while (ret == -1 && errno == EINTR);
+		throw;
+	}
+	if (ret == -1) {
+		int e = errno;
+		string message = "Cannot listen on Unix socket '";
+		message.append(filename);
+		message.append("'");
+		do {
+			ret = close(fd);
+		} while (ret == -1 && errno == EINTR);
+		throw SystemException(message, e);
+	}
+	
+	return fd;
+}
+
+int
+connectToUnixServer(const char *filename) {
+	int fd, ret;
+	struct sockaddr_un addr;
+	
+	if (strlen(filename) > sizeof(addr.sun_path) - 1) {
+		string message = "Cannot connect to Unix socket '";
+		message.append(filename);
+		message.append("': filename is too long.");
+		throw RuntimeException(message);
+	}
+	
+	do {
+		fd = syscalls::socket(PF_UNIX, SOCK_STREAM, 0);
+	} while (fd == -1 && errno == EINTR);
+	if (fd == -1) {
+		throw SystemException("Cannot create a Unix socket file descriptor", errno);
+	}
+	
+	addr.sun_family = AF_UNIX;
+	strncpy(addr.sun_path, filename, sizeof(addr.sun_path));
+	addr.sun_path[sizeof(addr.sun_path) - 1] = '\0';
+	
+	try {
+		ret = syscalls::connect(fd, (const sockaddr *) &addr, sizeof(addr));
+	} catch (...) {
+		do {
+			ret = close(fd);
+		} while (ret == -1 && errno == EINTR);
+		throw;
+	}
+	if (ret == -1) {
+		int e = errno;
+		string message("Cannot connect to Unix socket '");
+		message.append(filename);
+		message.append("'");
+		do {
+			ret = close(fd);
+		} while (ret == -1 && errno == EINTR);
+		throw SystemException(message, e);
+	}
+	
+	return fd;
 }
 
 } // namespace Passenger

data/ext/common/Utils.h

@@ -40,13 +40,13 @@
 #include <unistd.h>
 #include "Exceptions.h"
 
-typedef struct CachedMultiFileStat CachedMultiFileStat;
-
 namespace Passenger {
 
 using namespace std;
 using namespace boost;
 
+typedef struct CachedFileStat CachedFileStat;
+
 /** Enumeration which indicates what kind of file a file is. */
 typedef enum {
 	/** The file doesn't exist. */
@@ -158,31 +158,34 @@ 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.
+ * @param cstat A CachedFileStat object, if you want to use cached statting.
+ * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.
  * @return Whether the file exists.
  * @throws FileSystemException Unable to check because of a filesystem error.
+ * @throws TimeRetrievalException
+ * @throws boost::thread_interrupted
  * @ingroup Support
  */
-bool fileExists(const char *filename, CachedMultiFileStat *mstat = 0,
+bool fileExists(const char *filename, CachedFileStat *cstat = 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.
+ * @param mstat A CachedFileStat object, if you want to use cached statting.
+ * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.
  * @return The file type.
  * @throws FileSystemException Unable to check because of a filesystem error.
+ * @throws TimeRetrievalException
+ * @throws boost::thread_interrupted
  * @ingroup Support
  */
-FileType getFileType(const char *filename, CachedMultiFileStat *mstat = 0,
+FileType getFileType(const char *filename, CachedFileStat *cstat = 0,
                      unsigned int throttleRate = 0);
 
 /**
  * Find the location of the Passenger spawn server script.
- * If passengerRoot is given, t T
  *
  * @param passengerRoot The Passenger root folder. If NULL is given, then
  *      the spawn server is found by scanning $PATH. For security reasons,
@@ -246,6 +249,13 @@ string extractDirName(const string &path);
  */
 string escapeForXml(const string &input);
 
+/**
+ * Returns the username of the user that the current process is running as.
+ * If the user has no associated username, then the "UID xxxx" is returned,
+ * where xxxx is the current UID.
+ */
+string getProcessUsername();
+
 /**
  * Given a username that's supposed to be the "lowest user" in the user switching mechanism,
  * checks whether this username exists. If so, this users's UID and GID will be stored into
@@ -308,8 +318,6 @@ void setPassengerTempDir(const string &dir);
  *          about a running Phusion Passenger instance.
  * - backends - for storing Unix sockets created by backend processes.
  * - master - for storing files such as the Passenger HelperServer socket.
- * - var - for storing all other kinds of temp files that the backend processes
- *         create.
  *
  * If a (sub)directory already exists, then it will not result in an error.
  *
@@ -359,7 +367,7 @@ void createPassengerTempDir(const string &parentDir, bool userSwitching,
  * @throws SystemException Something went wrong.
  * @throws FileSystemException Something went wrong.
  */
-void makeDirTree(const string &path, const char *mode = "u=rwx,g=,o=", uid_t owner = -1, gid_t group = -1);
+void makeDirTree(const string &path, const char *mode = "u=rwx,g=,o=", uid_t owner = (uid_t) -1, gid_t group = (gid_t) -1);
 
 /**
  * Remove an entire directory tree recursively.
@@ -372,38 +380,69 @@ void removeDirTree(const string &path);
  * Check whether the specified directory is a valid Ruby on Rails
  * 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.
+ * @param cstat A CachedFileStat object, if you want to use cached statting.
+ * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.
  * @throws FileSystemException Unable to check because of a system error.
+ * @throws TimeRetrievalException
+ * @throws boost::thread_interrupted
  * @ingroup Support
  */
-bool verifyRailsDir(const string &dir, CachedMultiFileStat *mstat = 0,
+bool verifyRailsDir(const string &dir, CachedFileStat *cstat = 0,
                     unsigned int throttleRate = 0);
 
 /**
  * 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.
+ * @param cstat A CachedFileStat object, if you want to use cached statting.
+ * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.
  * @throws FileSystemException Unable to check because of a filesystem error.
+ * @throws TimeRetrievalException
+ * @throws boost::thread_interrupted
  * @ingroup Support
  */
-bool verifyRackDir(const string &dir, CachedMultiFileStat *mstat = 0,
+bool verifyRackDir(const string &dir, CachedFileStat *cstat = 0,
                    unsigned int throttleRate = 0);
 
 /**
  * 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.
+ * @param cstat A CachedFileStat object, if you want to use cached statting.
+ * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.
  * @throws FileSystemException Unable to check because of a filesystem error.
+ * @throws TimeRetrievalException
+ * @throws boost::thread_interrupted
  * @ingroup Support
  */
-bool verifyWSGIDir(const string &dir, CachedMultiFileStat *mstat = 0,
+bool verifyWSGIDir(const string &dir, CachedFileStat *cstat = 0,
                    unsigned int throttleRate = 0);
 
+/**
+ * Create a new Unix server socket which is bounded to <tt>filename</tt>.
+ *
+ * @param filename The filename to bind the socket to.
+ * @param backlogSize The size of the socket's backlog. Specify 0 to use the
+ *                    platform's maximum allowed backlog size.
+ * @param autoDelete Whether <tt>filename</tt> should be deleted, if it already exists.
+ * @return The file descriptor of the newly created Unix server socket.
+ * @throws RuntimeException Something went wrong.
+ * @throws SystemException Something went wrong while creating the Unix server socket.
+ * @throws boost::thread_interrupted A system call has been interrupted.
+ */
+int createUnixServer(const char *filename, unsigned int backlogSize = 0, bool autoDelete = true);
+
+/**
+ * Connect to a Unix server socket at <tt>filename</tt>.
+ *
+ * @param filename The filename of the socket to connect to.
+ * @return The file descriptor of the connected client socket.
+ * @throws RuntimeException Something went wrong.
+ * @throws SystemException Something went wrong while connecting to the Unix server.
+ * @throws boost::thread_interrupted A system call has been interrupted.
+ */
+int connectToUnixServer(const char *filename);
+
 /**
  * Represents a buffered upload file.
  *
@@ -419,11 +458,11 @@ public:
 	 *
 	 * @throws SystemException Something went wrong.
 	 */
-	BufferedUpload(const char *identifier = "temp") {
+	BufferedUpload(const string &dir, const char *identifier = "temp") {
 		char templ[PATH_MAX];
 		int fd;
 		
-		snprintf(templ, sizeof(templ), "%s/%s.XXXXXX", getDir().c_str(), identifier);
+		snprintf(templ, sizeof(templ), "%s/%s.XXXXXX", dir.c_str(), identifier);
 		templ[sizeof(templ) - 1] = '\0';
 		fd = mkstemp(templ);
 		if (fd == -1) {
@@ -450,14 +489,6 @@ public:
 	~BufferedUpload() {
 		fclose(handle);
 	}
-	
-	/**
-	 * Returns the directory in which upload buffer files are stored.
-	 * This is a subdirectory of the directory returned by getPassengerTempDir(). 
-	 */
-	static string getDir() {
-		return getPassengerTempDir() + "/webserver_private";
-	}
 };
 
 } // namespace Passenger