passenger 2.2.15 → 3.0.0.pre1

data/ext/common/Utils.h

@@ -1,6 +1,6 @@
 /*
  *  Phusion Passenger - http://www.modrails.com/
- *  Copyright (c) 2008, 2009 Phusion
+ *  Copyright (c) 2010 Phusion
  *
  *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
@@ -38,6 +38,7 @@
 #include <cstring>
 #include <errno.h>
 #include <unistd.h>
+#include "StaticString.h"
 #include "Exceptions.h"
 
 namespace Passenger {
@@ -45,7 +46,11 @@ namespace Passenger {
 using namespace std;
 using namespace boost;
 
+static const uid_t USER_NOT_GIVEN = (uid_t) -1;
+static const gid_t GROUP_NOT_GIVEN = (gid_t) -1;
+
 typedef struct CachedFileStat CachedFileStat;
+class ResourceLocator;
 
 /** Enumeration which indicates what kind of file a file is. */
 typedef enum {
@@ -82,78 +87,6 @@ ptr(T *pointer) {
 	return shared_ptr<T>(pointer);
 }
 
-/**
- * Used internally by toString(). Do not use directly.
- *
- * @internal
- */
-template<typename T>
-struct AnythingToString {
-	string operator()(T something) {
-		stringstream s;
-		s << something;
-		return s.str();
-	}
-};
-
-/**
- * Used internally by toString(). Do not use directly.
- *
- * @internal
- */
-template<>
-struct AnythingToString< vector<string> > {
-	string operator()(const vector<string> &v) {
-		string result("[");
-		vector<string>::const_iterator it;
-		unsigned int i;
-		for (it = v.begin(), i = 0; it != v.end(); it++, i++) {
-			result.append("'");
-			result.append(*it);
-			if (i == v.size() - 1) {
-				result.append("'");
-			} else {
-				result.append("', ");
-			}
-		}
-		result.append("]");
-		return result;
-	}
-};
-
-/**
- * Convert anything to a string.
- *
- * @param something The thing to convert.
- * @ingroup Support
- */
-template<typename T> string
-toString(T something) {
-	return AnythingToString<T>()(something);
-}
-
-/**
- * Converts the given string to an integer.
- * @ingroup Support
- */
-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.
- *
- * @param str The string to split.
- * @param sep The separator to use.
- * @param output The vector to write the output to.
- * @ingroup Support
- */
-void split(const string &str, char sep, vector<string> &output);
-
 /**
  * Check whether the specified file exists.
  *
@@ -166,7 +99,7 @@ void split(const string &str, char sep, vector<string> &output);
  * @throws boost::thread_interrupted
  * @ingroup Support
  */
-bool fileExists(const char *filename, CachedFileStat *cstat = 0,
+bool fileExists(const StaticString &filename, CachedFileStat *cstat = 0,
                 unsigned int throttleRate = 0);
 
 /**
@@ -181,33 +114,30 @@ bool fileExists(const char *filename, CachedFileStat *cstat = 0,
  * @throws boost::thread_interrupted
  * @ingroup Support
  */
-FileType getFileType(const char *filename, CachedFileStat *cstat = 0,
+FileType getFileType(const StaticString &filename, CachedFileStat *cstat = 0,
                      unsigned int throttleRate = 0);
 
 /**
- * Find the location of the Passenger spawn server script.
- *
- * @param passengerRoot The Passenger root folder. If NULL is given, then
- *      the spawn server is found by scanning $PATH. For security reasons,
- *      only absolute paths are scanned.
- * @return An absolute path to the spawn server script, or
- *         an empty string on error.
- * @throws FileSystemException Unable to access parts of the filesystem.
- * @ingroup Support
- */
-string findSpawnServer(const char *passengerRoot = NULL);
-
-/**
- * Find the location of the Passenger ApplicationPool server
- * executable.
- *
- * @param passengerRoot The Passenger root folder.
- * @return An absolute path to the executable.
- * @throws FileSystemException Unable to access parts of the filesystem.
- * @pre passengerRoot != NULL
+ * Create the given file with the given contents, permissions and ownership.
+ * This function does not leave behind junk files: if the ownership cannot be set
+ * or if not all data can be written then then the file will be deleted.
+ *
+ * @param filename The file to create.
+ * @param contents The contents to write to the file.
+ * @param permissions The desired file permissions.
+ * @param owner The desired file owner. Specify USER_NOT_GIVEN if you want to use the current
+ *              process's owner as the file owner.
+ * @param group The desired file group. Specify GROUP_NOT_GIVEN if you want to use the current
+ *              process's group as the file group.
+ * @param overwrite Whether to overwrite the file if it exists. If set to false
+ *                  and the file exists then nothing will happen.
+ * @throws FileSystemException Something went wrong.
  * @ingroup Support
  */
-string findApplicationPoolServer(const char *passengerRoot);
+void createFile(const string &filename, const StaticString &contents,
+                mode_t permissions = S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH,
+                uid_t owner = USER_NOT_GIVEN, gid_t group = GROUP_NOT_GIVEN,
+                bool overwrite = true);
 
 /**
  * Returns a canonical version of the specified path. All symbolic links
@@ -239,7 +169,14 @@ string resolveSymlink(const string &path);
  *
  * @ingroup Support
  */
-string extractDirName(const string &path);
+string extractDirName(const StaticString &path);
+
+/**
+ * Given a path, extracts its base name.
+ *
+ * @ingroup Support
+ */
+string extractBaseName(const StaticString &path);
 
 /**
  * Escape the given raw string into an XML value.
@@ -251,19 +188,32 @@ 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,
+ * If the user has no associated username, then "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
- * the arguments of the same names. If not, <em>uid</em> and <em>gid</em> will be set to
- * the UID and GID of the "nobody" user. If that user doesn't exist either, then <em>uid</em>
- * and <em>gid</em> will be set to -1.
+ * Converts a mode string into a mode_t value.
+ *
+ * At this time only the symbolic mode strings are supported, e.g. something like looks
+ * this: "u=rwx,g=w,o=rx". The grammar is as follows:
+ * @code
+ *   mode   ::= (clause ("," clause)*)?
+ *   clause ::= who "=" permission*
+ *   who    ::= "u" | "g" | "o"
+ *   permission ::= "r" | "w" | "x" | "s"
+ * @endcode
+ *
+ * Notes:
+ * - The mode value starts with 0. So if you specify "u=rwx", then the group and world
+ *   permissions will be empty (set to 0).
+ * - The "s" permission is only allowed for who == "u" or who == "g".
+ * - The return value does not depend on the umask.
+ *
+ * @throws InvalidModeStringException The mode string cannot be parsed.
  */
-void determineLowestUserAndGroup(const string &user, uid_t &uid, gid_t &gid);
+mode_t parseModeString(const StaticString &mode);
 
 /**
  * Return the path name for the directory in which the system stores general
@@ -275,38 +225,9 @@ void determineLowestUserAndGroup(const string &user, uid_t &uid, gid_t &gid);
  */
 const char *getSystemTempDir();
 
-/**
- * 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 calculated value will be stored in an internal variable, so that subsequent
- * calls will return the same value. To bypass the usage of this internal variable,
- * set <tt>bypassCache</tt> to true. In this case, the value of the internal
- * variable will be set to the newly calculated value.
- *
- * @param bypassCache Whether the value of the internal variable should be bypassed.
- * @param parentDir The directory under which the Phusion Passenger-specific
- *                  temp directory should be located. If set to the empty string,
- *                  then the return value of getSystemTempDir() will be used.
- *                  This argument only has effect if the value of the internal
- *                  variable is not consulted.
- * @ensure !result.empty()
- * @ingroup Support
- */
-string getPassengerTempDir(bool bypassCache = false, const string &parentDir = "");
-
-/**
- * Force subsequent calls to <tt>getPassengerTempDir(false, ...)</tt> to return the given value.
- * <tt>dir</tt> is not created automatically if it doesn't exist.
- *
- * <tt>dir</tt> may also be an empty string, in which case it will cause the next
- * call to <tt>getPassengerTempDir()</tt> to re-calculate the temp directory's path.
- */
-void setPassengerTempDir(const string &dir);
-
-/* Create a temporary directory for storing Phusion Passenger-specific temp files,
- * such as temporarily buffered uploads, sockets for backend processes, etc.
+/* Create a temporary directory for storing Phusion Passenger instance-specific
+ * temp files, such as temporarily buffered uploads, sockets for backend
+ * processes, etc.
  * The directory that will be created is the one returned by
  * <tt>getPassengerTempDir(false, parentDir)</tt>. This call stores the path to
  * this temp directory in an internal variable, so that subsequent calls to
@@ -350,27 +271,30 @@ void setPassengerTempDir(const string &dir);
  * @throws SystemException Something went wrong.
  * @throws FileSystemException Something went wrong.
  */
-void createPassengerTempDir(const string &parentDir, bool userSwitching,
+/* void createPassengerTempDir(const string &parentDir, bool userSwitching,
                             const string &lowestUser,
-                            uid_t workerUid, gid_t workerGid);
+                            uid_t workerUid, gid_t workerGid); */
 
 /**
  * Create the directory at the given path, creating intermediate directories
- * if necessary. The created directories' permissions are as specified by the
- * 'mode' parameter. You can specify this directory's owner and group through
- * the 'owner' and 'group' parameters. A value of -1 for 'owner' or 'group'
- * means that the owner/group should not be changed.
+ * if necessary. The created directories' permissions are exactly as specified
+ * by the 'mode' parameter (i.e. the umask will be ignored). You can specify
+ * this directory's owner and group through the 'owner' and 'group' parameters.
+ * A value of USER_NOT_GIVEN for 'owner' and/or GROUP_NOT_GIVEN 'group' means
+ * that the owner/group should not be changed.
  *
  * If 'path' already exists, then nothing will happen.
  *
- * @throws IOException Something went wrong.
- * @throws SystemException Something went wrong.
+ * @param mode A mode string, as supported by parseModeString().
  * @throws FileSystemException Something went wrong.
+ * @throws InvalidModeStringException The mode string cannot be parsed.
  */
-void makeDirTree(const string &path, const char *mode = "u=rwx,g=,o=", uid_t owner = (uid_t) -1, gid_t group = (gid_t) -1);
+void makeDirTree(const string &path, const StaticString &mode = "u=rwx,g=,o=",
+	uid_t owner = USER_NOT_GIVEN, gid_t group = GROUP_NOT_GIVEN);
 
 /**
- * Remove an entire directory tree recursively.
+ * Remove an entire directory tree recursively. If the directory doesn't exist then this
+ * function does nothing.
  *
  * @throws FileSystemException Something went wrong.
  */
@@ -418,30 +342,20 @@ bool verifyRackDir(const string &dir, CachedFileStat *cstat = 0,
 bool verifyWSGIDir(const string &dir, CachedFileStat *cstat = 0,
                    unsigned int throttleRate = 0);
 
+void prestartWebApps(const ResourceLocator &locator, const string &serializedprestartURLs);
+
 /**
- * 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.
+ * Returns the system's host name.
+ *
+ * @throws SystemException The host name cannot be retrieved.
  */
-int createUnixServer(const char *filename, unsigned int backlogSize = 0, bool autoDelete = true);
+string getHostName();
 
 /**
- * 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.
+ * Convert a signal number to its associated name.
  */
-int connectToUnixServer(const char *filename);
+string getSignalName(int sig);
+
 
 /**
  * Represents a buffered upload file.

data/ext/common/{Base64.h → Utils/Base64.h}

@@ -31,7 +31,7 @@
 
 #include <iostream>
 #include <string>
-#include "StaticString.h"
+#include "../StaticString.h"
 
 namespace Passenger {
 
@@ -43,6 +43,32 @@ public:
 		return encode((const unsigned char *) data.data(), data.size());
 	}
 	
+	/** Encode using a modified Base64 format, suitable for inclusion in URLs without
+	 * needing escaping.
+	 */
+	static string encodeForUrl(const StaticString &data) {
+		string result = encode(data);
+		string::size_type i;
+		int paddingSize = 0;
+		
+		for (i = 0; i < result.size(); i++) {
+			char c = result[i];
+			if (c == '+') {
+				result[i] = '-';
+			} else if (c == '/') {
+				result[i] = '_';
+			} else if (c == '=') {
+				paddingSize++;
+			}
+		}
+		
+		if (paddingSize > 0) {
+			result.resize(result.size() - paddingSize);
+		}
+		
+		return result;
+	}
+	
 	static string decode(const StaticString &base64_data) {
 		return decode((const unsigned char *) base64_data.data(), base64_data.size());
 	}

data/ext/common/Utils/BlockingQueue.h

@@ -0,0 +1,136 @@
+/*
+ *  Phusion Passenger - http://www.modrails.com/
+ *  Copyright (c) 2010 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_BLOCKING_QUEUE_H_
+#define _PASSENGER_BLOCKING_QUEUE_H_
+
+#include <boost/thread.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
+#include <queue>
+
+namespace Passenger {
+
+using namespace std;
+using namespace boost;
+
+template<typename T>
+class BlockingQueue {
+private:
+	timed_mutex lock;
+	condition_variable_any added;
+	condition_variable_any removed;
+	unsigned int max;
+	std::queue<T> queue;
+	
+	bool atMaxCapacity() const {
+		return max > 0 && queue.size() >= max;
+	}
+
+public:
+	BlockingQueue(unsigned int max = 0) {
+		this->max = max;
+	}
+	
+	void add(const T &item) {
+		unique_lock<timed_mutex> l(lock);
+		while (atMaxCapacity()) {
+			removed.wait(l);
+		}
+		queue.push(item);
+		added.notify_one();
+		if (!atMaxCapacity()) {
+			removed.notify_one();
+		}
+	}
+	
+	T get() {
+		unique_lock<timed_mutex> l(lock);
+		while (queue.empty()) {
+			added.wait(l);
+		}
+		T item = queue.front();
+		queue.pop();
+		removed.notify_one();
+		if (!queue.empty()) {
+			added.notify_one();
+		}
+		return item;
+	}
+	
+	bool timedGet(T &output, unsigned int timeout) {
+		unique_lock<timed_mutex> l(lock);
+		posix_time::ptime deadline = posix_time::microsec_clock::local_time() +
+			posix_time::milliseconds(timeout);
+		bool timedOut = false;
+		
+		while (queue.empty() && !timedOut) {
+			posix_time::time_duration diff = deadline -
+				posix_time::microsec_clock::local_time();
+			if (diff.is_negative() < 0) {
+				timedOut = true;
+			} else {
+				timedOut = !added.timed_wait(l,
+					posix_time::milliseconds(diff.total_milliseconds()));
+			}
+		}
+		if (!queue.empty()) {
+			output = queue.front();
+			queue.pop();
+			removed.notify_one();
+			if (!queue.empty()) {
+				added.notify_one();
+			}
+			return true;
+		} else {
+			return false;
+		}
+	}
+	
+	bool tryGet(T &output) {
+		unique_lock<timed_mutex> l(lock);
+		if (queue.empty()) {
+			return false;
+		} else {
+			output = queue.front();
+			queue.pop();
+			removed.notify_one();
+			if (!queue.empty()) {
+				added.notify_one();
+			}
+			return true;
+		}
+	}
+	
+	T peek() {
+		unique_lock<timed_mutex> l(lock);
+		while (queue.empty()) {
+			added.wait(l);
+		}
+		return queue.front();
+	}
+};
+
+} // namespace Passenger
+
+#endif /* _PASSENGER_BLOCKING_QUEUE_H_ */