passenger 2.2.2 → 2.2.3

data/ext/common/Logging.h

@@ -64,8 +64,9 @@ void setDebugFile(const char *logFile = NULL);
 			strftime(datetime_buf, sizeof(datetime_buf), "%F %H:%M:%S", the_tm); \
 			gettimeofday(&tv, NULL); \
 			sstream << \
-				"[ pid=" << getpid() << " file=" << __FILE__ << ":" << __LINE__ << \
-				" time=" << datetime_buf << "." << (tv.tv_usec / 1000) << " ]:" << \
+				"[ pid=" << ((unsigned long) getpid()) <<  \
+				" file=" << __FILE__ << ":" << (unsigned long) __LINE__ << \
+				" time=" << datetime_buf << "." << (unsigned long) (tv.tv_usec / 1000) << " ]:" << \
 				"\n  " << expr << std::endl;	\
 			*stream << sstream.str();		\
 			stream->flush();			\

data/ext/common/MessageChannel.h

@@ -570,11 +570,11 @@ public:
 		ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO,
 			&tv, sizeof(tv));
 		#ifndef __SOLARIS__
-		// SO_RCVTIMEO is unimplemented and retuns an error on Solaris
-		// 9 and 10 SPARC.  Seems to work okay without it.
-		if (ret == -1) {
-			throw SystemException("Cannot set read timeout for socket", errno);
-		}
+			// SO_RCVTIMEO is unimplemented and returns an error on Solaris
+			// 9 and 10 SPARC.  Seems to work okay without it.
+			if (ret == -1) {
+				throw SystemException("Cannot set read timeout for socket", errno);
+			}
 		#endif
 	}
 	
@@ -601,11 +601,11 @@ public:
 		ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO,
 			&tv, sizeof(tv));
 		#ifndef __SOLARIS__
-		// SO_SNDTIMEO is unimplemented and returns an error on Solaris
-		// 9 and 10 SPARC.  Seems to work okay without it.
-		if (ret == -1) {
-			throw SystemException("Cannot set read timeout for socket", errno);
-		}
+			// SO_SNDTIMEO is unimplemented and returns an error on Solaris
+			// 9 and 10 SPARC.  Seems to work okay without it.
+			if (ret == -1) {
+				throw SystemException("Cannot set read timeout for socket", errno);
+			}
 		#endif
 	}
 };

data/ext/common/PoolOptions.h

@@ -26,7 +26,8 @@
 #define _PASSENGER_SPAWN_OPTIONS_H_
 
 #include <string>
-#include "Utils.h"
+#include <vector>
+#include "StringListCreator.h"
 
 namespace Passenger {
 
@@ -147,6 +148,29 @@ struct PoolOptions {
 	 */
 	string restartDir;
 	
+	/**
+	 * If a new backend process is started, then the getItems() method
+	 * on this object will be called, which is to return environment
+	 * variables that should be passed to the newly spawned backend process.
+	 * Odd indices in the resulting array contain keys, even indices contain
+	 * the value for the key in the previous index.
+	 *
+	 * May be set to NULL.
+	 *
+	 * @invariant environmentVariables.size() is an even number.
+	 */
+	StringListCreatorPtr environmentVariables;
+	
+	/**
+	 * The base URI on which the application runs. If the application is
+	 * running on the root URI, then this value must be "/".
+	 *
+	 * @invariant baseURI != ""
+	 */
+	string baseURI;
+	
+	/*********************************/
+	
 	/**
 	 * Creates a new PoolOptions object with the default values filled in.
 	 * One must still set appRoot manually, after having used this constructor.
@@ -163,6 +187,7 @@ struct PoolOptions {
 		memoryLimit    = 0;
 		useGlobalQueue = false;
 		statThrottleRate        = 0;
+		baseURI        = "/";
 	}
 	
 	/**
@@ -180,7 +205,8 @@ struct PoolOptions {
 		unsigned long memoryLimit    = 0,
 		bool useGlobalQueue          = false,
 		unsigned long statThrottleRate = 0,
-		const string &restartDir  = ""
+		const string &restartDir  = "",
+		const string &baseURI     = "/"
 	) {
 		this->appRoot        = appRoot;
 		this->lowerPrivilege = lowerPrivilege;
@@ -195,6 +221,7 @@ struct PoolOptions {
 		this->useGlobalQueue = useGlobalQueue;
 		this->statThrottleRate        = statThrottleRate;
 		this->restartDir     = restartDir;
+		this->baseURI        = baseURI;
 	}
 	
 	/**
@@ -230,16 +257,24 @@ struct PoolOptions {
 		useGlobalQueue = vec[startIndex + 21] == "true";
 		statThrottleRate = atol(vec[startIndex + 23]);
 		restartDir     = vec[startIndex + 25];
+		baseURI        = vec[startIndex + 27];
+		if (vec.size() > startIndex + 29) {
+			environmentVariables = ptr(new SimpleStringListCreator(vec[startIndex + 29]));
+		}
 	}
 	
 	/**
 	 * Append the information in this PoolOptions object to the given
 	 * string vector. The resulting array could, for example, be used
 	 * as a message to be sent to the spawn server.
+	 *
+	 * @param vec The vector to store the information in.
+	 * @param storeEnvVars Whether to store environment variable information into vec as well.
+	 * @throws Anything thrown by environmentVariables->getItems().
 	 */
-	void toVector(vector<string> &vec) const {
-		if (vec.capacity() < vec.size() + 10) {
-			vec.reserve(vec.size() + 10);
+	void toVector(vector<string> &vec, bool storeEnvVars = true) const {
+		if (vec.capacity() < vec.size() + 30) {
+			vec.reserve(vec.size() + 30);
 		}
 		appendKeyValue (vec, "app_root",        appRoot);
 		appendKeyValue (vec, "lower_privilege", lowerPrivilege ? "true" : "false");
@@ -254,6 +289,38 @@ struct PoolOptions {
 		appendKeyValue (vec, "use_global_queue", useGlobalQueue ? "true" : "false");
 		appendKeyValue3(vec, "stat_throttle_rate", statThrottleRate);
 		appendKeyValue (vec, "restart_dir",     restartDir);
+		appendKeyValue (vec, "base_uri",        baseURI);
+		if (storeEnvVars) {
+			vec.push_back("environment_variables");
+			vec.push_back(serializeEnvironmentVariables());
+		}
+	}
+	
+	/**
+	 * Serializes the items in environmentVariables into a string, which
+	 * can be used to create a SimpleStringListCreator object.
+	 *
+	 * @throws Anything thrown by environmentVariables->getItems().
+	 */
+	string serializeEnvironmentVariables() const {
+		vector<string>::const_iterator it, end;
+		string result;
+		
+		if (environmentVariables) {
+			result.reserve(1024);
+			
+			StringListPtr items = environmentVariables->getItems();
+			end = items->end();
+			
+			for (it = items->begin(); it != end; it++) {
+				result.append(*it);
+				result.append(1, '\0');
+				it++;
+				result.append(*it);
+				result.append(1, '\0');
+			}
+		}
+		return Base64::encode(result);
 	}
 
 private:

data/ext/common/SpawnManager.h

@@ -265,15 +265,16 @@ private:
 	 * @param PoolOptions The spawn options to use.
 	 * @return An Application smart pointer, representing the spawned application.
 	 * @throws SpawnException Something went wrong.
+	 * @throws Anything thrown by options.environmentVariables->getItems().
 	 */
-	ApplicationPtr sendSpawnCommand(const PoolOptions &PoolOptions) {
+	ApplicationPtr sendSpawnCommand(const PoolOptions &options) {
 		TRACE_POINT();
 		vector<string> args;
 		int ownerPipe;
 		
 		try {
 			args.push_back("spawn_application");
-			PoolOptions.toVector(args);
+			options.toVector(args);
 			channel.write(args);
 		} catch (const SystemException &e) {
 			throw SpawnException(string("Could not write 'spawn_application' "
@@ -346,15 +347,16 @@ private:
 				ret = chown(args[1].c_str(), getuid(), getgid());
 			} while (ret == -1 && errno == EINTR);
 		}
-		return ApplicationPtr(new Application(PoolOptions.appRoot,
+		return ApplicationPtr(new Application(options.appRoot,
 			pid, args[1], args[2], ownerPipe));
 	}
 	
 	/**
 	 * @throws boost::thread_interrupted
+	 * @throws Anything thrown by options.environmentVariables->getItems().
 	 */
 	ApplicationPtr
-	handleSpawnException(const SpawnException &e, const PoolOptions &PoolOptions) {
+	handleSpawnException(const SpawnException &e, const PoolOptions &options) {
 		TRACE_POINT();
 		bool restarted;
 		try {
@@ -371,7 +373,7 @@ private:
 			restarted = false;
 		}
 		if (restarted) {
-			return sendSpawnCommand(PoolOptions);
+			return sendSpawnCommand(options);
 		} else {
 			throw SpawnException("The spawn server died unexpectedly, and restarting it failed.");
 		}
@@ -500,17 +502,18 @@ public:
 	 *         spawned application.
 	 * @throws SpawnException Something went wrong.
 	 * @throws boost::thread_interrupted
+	 * @throws Anything thrown by options.environmentVariables->getItems().
 	 */
-	ApplicationPtr spawn(const PoolOptions &PoolOptions) {
+	ApplicationPtr spawn(const PoolOptions &options) {
 		TRACE_POINT();
 		boost::mutex::scoped_lock l(lock);
 		try {
-			return sendSpawnCommand(PoolOptions);
+			return sendSpawnCommand(options);
 		} catch (const SpawnException &e) {
 			if (e.hasErrorPage()) {
 				throw;
 			} else {
-				return handleSpawnException(e, PoolOptions);
+				return handleSpawnException(e, options);
 			}
 		}
 	}

data/ext/common/StandardApplicationPool.h

@@ -52,8 +52,8 @@
 
 #include "ApplicationPool.h"
 #include "Logging.h"
-#include "FileChecker.h"
-#include "CachedFileStat.h"
+#include "FileChangeChecker.h"
+#include "CachedFileStat.hpp"
 #ifdef PASSENGER_USE_DUMMY_SPAWN_MANAGER
 	#include "DummySpawnManager.h"
 #else
@@ -121,25 +121,6 @@ private:
 		AppContainerList instances;
 		unsigned int size;
 		unsigned long maxRequests;
-		FileChecker restartFileChecker;
-		CachedFileStat alwaysRestartFileStatter;
-		
-		Domain(const PoolOptions &options)
-			: restartFileChecker(determineRestartDir(options) + "/restart.txt"),
-			  alwaysRestartFileStatter(determineRestartDir(options) + "/always_restart.txt")
-		{
-		}
-	
-	private:
-		static string determineRestartDir(const PoolOptions &options) {
-			if (options.restartDir.empty()) {
-				return options.appRoot + "/tmp";
-			} else if (options.restartDir[0] == '/') {
-				return options.restartDir;
-			} else {
-				return options.appRoot + "/" + options.restartDir;
-			}
-		}
 	};
 	
 	struct AppContainer {
@@ -267,6 +248,8 @@ private:
 	unsigned int maxIdleTime;
 	unsigned int waitingOnGlobalQueue;
 	condition cleanerThreadSleeper;
+	CachedFileStat cstat;
+	FileChangeChecker fileChangeChecker;
 	
 	// Shortcuts for instance variables in SharedData. Saves typing in get().
 	boost::mutex &lock;
@@ -364,12 +347,24 @@ private:
 	/**
 	 * Checks whether the given application domain needs to be restarted.
 	 *
-	 * @throws SystemException Something went wrong while retrieving the system time.
+	 * @throws TimeRetrievalException Something went wrong while retrieving the system time.
 	 * @throws boost::thread_interrupted
 	 */
-	bool needsRestart(const string &appRoot, Domain *domain, const PoolOptions &options) {
-		return domain->alwaysRestartFileStatter.refresh(options.statThrottleRate) == 0
-		    || domain->restartFileChecker.changed(options.statThrottleRate);
+	bool needsRestart(const string &appRoot, const PoolOptions &options) {
+		string restartDir;
+		if (options.restartDir.empty()) {
+			restartDir = appRoot + "/tmp";
+		} else if (options.restartDir[0] == '/') {
+			restartDir = options.restartDir;
+		} else {
+			restartDir = appRoot + "/" + options.restartDir;
+		}
+		
+		string alwaysRestartFile = restartDir + "/always_restart.txt";
+		string restartFile = restartDir + "/restart.txt";
+		struct stat buf;
+		return cstat.stat(alwaysRestartFile, &buf, options.statThrottleRate) == 0 ||
+		       fileChangeChecker.changed(restartFile, options.statThrottleRate);
 	}
 	
 	void cleanerThreadMainLoop() {
@@ -430,6 +425,7 @@ private:
 	 * @throws boost::thread_interrupted
 	 * @throws SpawnException
 	 * @throws SystemException
+	 * @throws TimeRetrievalException Something went wrong while retrieving the system time.
 	 */
 	pair<AppContainerPtr, Domain *>
 	spawnOrUseExisting(boost::mutex::scoped_lock &l, const PoolOptions &options) {
@@ -446,21 +442,24 @@ private:
 		try {
 			DomainMap::iterator it(domains.find(appRoot));
 			
-			if (it != domains.end() && needsRestart(appRoot, it->second.get(), options)) {
-				AppContainerList::iterator it2;
-				instances = &it->second->instances;
-				for (it2 = instances->begin(); it2 != instances->end(); it2++) {
-					container = *it2;
-					if (container->sessions == 0) {
-						inactiveApps.erase(container->ia_iterator);
-					} else {
-						active--;
+			if (needsRestart(appRoot, options)) {
+				if (it != domains.end()) {
+					AppContainerList::iterator it2;
+					instances = &it->second->instances;
+					for (it2 = instances->begin(); it2 != instances->end(); it2++) {
+						container = *it2;
+						if (container->sessions == 0) {
+							inactiveApps.erase(container->ia_iterator);
+						} else {
+							active--;
+						}
+						it2--;
+						instances->erase(container->iterator);
+						count--;
 					}
-					it2--;
-					instances->erase(container->iterator);
-					count--;
+					domains.erase(appRoot);
 				}
-				domains.erase(appRoot);
+				P_DEBUG("Restarting " << appRoot);
 				spawnManager.reload(appRoot);
 				it = domains.end();
 				activeOrMaxChanged.notify_all();
@@ -548,7 +547,7 @@ private:
 				container->sessions = 0;
 				it = domains.find(appRoot);
 				if (it == domains.end()) {
-					domain = new Domain(options);
+					domain = new Domain();
 					domain->size = 1;
 					domain->maxRequests = options.maxRequests;
 					domains[appRoot] = ptr(domain);

data/ext/common/StaticString.h

@@ -26,6 +26,7 @@
 #define _PASSENGER_STATIC_STRING_H_
 
 #include <string>
+#include <cstring>
 
 namespace Passenger {
 

data/ext/common/StringListCreator.h

@@ -0,0 +1,83 @@
+/*
+ *  Phusion Passenger - http://www.modrails.com/
+ *  Copyright (c) 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_STRING_LIST_CREATOR_H_
+#define _PASSENGER_STRING_LIST_CREATOR_H_
+
+#include <string>
+#include <vector>
+#include <boost/shared_ptr.hpp>
+#include "Base64.h"
+#include "Utils.h"
+
+namespace Passenger {
+
+using namespace std;
+using namespace boost;
+
+typedef vector<string> StringList;
+typedef shared_ptr<StringList> StringListPtr;
+
+
+class StringListCreator {
+public:
+	virtual ~StringListCreator() {}
+	
+	/** May throw arbitrary exceptions. */
+	virtual const StringListPtr getItems() const = 0;
+};
+
+typedef shared_ptr<StringListCreator> StringListCreatorPtr;
+
+class SimpleStringListCreator: public StringListCreator {
+public:
+	StringListPtr items;
+	
+	SimpleStringListCreator() {
+		items = ptr(new StringList());
+	}
+	
+	SimpleStringListCreator(const StaticString &data) {
+		items = ptr(new StringList());
+		string buffer = Base64::decode(data);
+		if (!buffer.empty()) {
+			string::size_type start = 0, pos;
+			const string &const_buffer(buffer);
+			while ((pos = const_buffer.find('\0', start)) != string::npos) {
+				items->push_back(const_buffer.substr(start, pos - start));
+				start = pos + 1;
+			}
+		}
+	}
+	
+	virtual const StringListPtr getItems() const {
+		return items;
+	}
+};
+
+typedef shared_ptr<SimpleStringListCreator> SimpleStringListCreatorPtr;
+
+} // namespace Passenger
+
+#endif /* _PASSENGER_STRING_LIST_CREATOR_H_ */