passenger 5.1.12 → 5.2.0

data/src/cxx_supportlib/ConfigKit/SubComponentUtils.h

@@ -32,6 +32,7 @@
 
 #include <jsoncpp/json.h>
 #include <ConfigKit/Common.h>
+#include <ConfigKit/Translator.h>
 
 namespace Passenger {
 namespace ConfigKit {
@@ -39,7 +40,7 @@ namespace ConfigKit {
 using namespace std;
 
 
-template<typename Component, typename Translator>
+template<typename Component>
 inline void
 prepareConfigChangeForSubComponent(Component &component, const Translator &translator,
 	const Json::Value &updates, vector<ConfigKit::Error> &errors,

data/src/cxx_supportlib/ConfigKit/TableTranslator.h

@@ -26,15 +26,7 @@
 #ifndef _PASSENGER_CONFIG_KIT_TABLE_TRANSLATOR_H_
 #define _PASSENGER_CONFIG_KIT_TABLE_TRANSLATOR_H_
 
-#include <boost/bind.hpp>
-#include <string>
-#include <vector>
-#include <cassert>
-
-#include <jsoncpp/json.h>
-
-#include <ConfigKit/Common.h>
-#include <StaticString.h>
+#include <ConfigKit/Translator.h>
 #include <DataStructures/StringKeyTable.h>
 
 namespace Passenger {
@@ -60,61 +52,12 @@ using namespace std;
  * You can learn more about translators in the ConfigKit README, section
  * "The special problem of overlapping configuration names and translation".
  */
-class TableTranslator {
+class TableTranslator: public Translator {
 private:
 	StringKeyTable<string> table, reverseTable;
 	bool finalized;
 
-	static Json::Value internalTranslate(const StringKeyTable<string> &table,
-		const Json::Value &doc)
-	{
-		Json::Value result(Json::objectValue);
-		Json::Value::const_iterator it, end = doc.end();
-
-		for (it = doc.begin(); it != end; it++) {
-			const char *keyEnd;
-			const char *key = it.memberName(&keyEnd);
-			const string *entry;
-
-			if (table.lookup(StaticString(key, keyEnd - key), &entry)) {
-				result[*entry] = *it;
-			} else {
-				result[JSONCPP_STRING(key, keyEnd - key)] = *it;
-			}
-		}
-
-		return result;
-	}
-
-	static string translateErrorKey(const StringKeyTable<string> *table,
-		const StaticString &key)
-	{
-		const string *entry;
-
-		if (table->lookup(key, &entry)) {
-			return "{{" + *entry + "}}";
-		} else {
-			return "{{" + key + "}}";
-		}
-	}
-
-	static vector<Error> internalTranslate(const StringKeyTable<string> &table,
-		const vector<Error> &errors)
-	{
-		vector<Error> result;
-		vector<Error>::const_iterator it, end = errors.end();
-		Error::KeyProcessor keyProcessor =
-			boost::bind(translateErrorKey, &table, boost::placeholders::_1);
-
-		for (it = errors.begin(); it != end; it++) {
-			const Error &error = *it;
-			result.push_back(Error(error.getMessage(keyProcessor)));
-		}
-
-		return result;
-	}
-
-	static StaticString internalTranslateOne(const StringKeyTable<string> &table,
+	static string internalTranslateOne(const StringKeyTable<string> &table,
 		const StaticString &key)
 	{
 		const string *entry;
@@ -148,32 +91,32 @@ public:
 		return finalized;
 	}
 
-	Json::Value translate(const Json::Value &doc) const {
+	virtual Json::Value translate(const Json::Value &doc) const {
 		assert(finalized);
-		return internalTranslate(table, doc);
+		return Translator::translate(doc);
 	}
 
-	Json::Value reverseTranslate(const Json::Value &doc) const {
+	virtual Json::Value reverseTranslate(const Json::Value &doc) const {
 		assert(finalized);
-		return internalTranslate(reverseTable, doc);
+		return Translator::reverseTranslate(doc);
 	}
 
-	vector<Error> translate(const vector<Error> &errors) const {
+	virtual vector<Error> translate(const vector<Error> &errors) const {
 		assert(finalized);
-		return internalTranslate(table, errors);
+		return Translator::translate(errors);
 	}
 
-	vector<Error> reverseTranslate(const vector<Error> &errors) const {
+	virtual vector<Error> reverseTranslate(const vector<Error> &errors) const {
 		assert(finalized);
-		return internalTranslate(reverseTable, errors);
+		return Translator::reverseTranslate(errors);
 	}
 
-	StaticString translateOne(const StaticString &key) const {
+	virtual string translateOne(const StaticString &key) const {
 		assert(finalized);
 		return internalTranslateOne(table, key);
 	}
 
-	StaticString reverseTranslateOne(const StaticString &key) const {
+	virtual string reverseTranslateOne(const StaticString &key) const {
 		return internalTranslateOne(reverseTable, key);
 	}
 };

data/src/cxx_supportlib/ConfigKit/Translator.h

@@ -0,0 +1,125 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2017 Phusion Holding B.V.
+ *
+ *  "Passenger", "Phusion Passenger" and "Union Station" are registered
+ *  trademarks of Phusion Holding B.V.
+ *
+ *  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_CONFIG_KIT_TRANSLATOR_H_
+#define _PASSENGER_CONFIG_KIT_TRANSLATOR_H_
+
+#include <boost/bind.hpp>
+#include <string>
+#include <vector>
+#include <ConfigKit/Common.h>
+#include <StaticString.h>
+#include <jsoncpp/json.h>
+
+namespace Passenger {
+namespace ConfigKit {
+
+using namespace std;
+
+
+/**
+ * An abstract base class for all translators.
+ *
+ * You can learn more about translators in the ConfigKit README, section
+ * "The special problem of overlapping configuration names and translation".
+ */
+class Translator {
+private:
+	string translateErrorKey(const StaticString &key) const {
+		return "{{" + translateOne(key) + "}}";
+	}
+
+	string reverseTranslateErrorKey(const StaticString &key) const {
+		return "{{" + reverseTranslateOne(key) + "}}";
+	}
+
+public:
+	virtual ~Translator() { }
+
+	virtual Json::Value translate(const Json::Value &doc) const {
+		Json::Value result(Json::objectValue);
+		Json::Value::const_iterator it, end = doc.end();
+
+		for (it = doc.begin(); it != end; it++) {
+			const char *keyEnd;
+			const char *key = it.memberName(&keyEnd);
+			result[translateOne(StaticString(key, keyEnd - key))] = *it;
+		}
+
+		return result;
+	}
+
+	virtual Json::Value reverseTranslate(const Json::Value &doc) const {
+		Json::Value result(Json::objectValue);
+		Json::Value::const_iterator it, end = doc.end();
+
+		for (it = doc.begin(); it != end; it++) {
+			const char *keyEnd;
+			const char *key = it.memberName(&keyEnd);
+			result[reverseTranslateOne(StaticString(key, keyEnd - key))] = *it;
+		}
+
+		return result;
+	}
+
+	virtual vector<Error> translate(const vector<Error> &errors) const {
+		vector<Error> result;
+		vector<Error>::const_iterator it, end = errors.end();
+		Error::KeyProcessor keyProcessor =
+			boost::bind(&Translator::translateErrorKey, this,
+				boost::placeholders::_1);
+
+		for (it = errors.begin(); it != end; it++) {
+			const Error &error = *it;
+			result.push_back(Error(error.getMessage(keyProcessor)));
+		}
+
+		return result;
+	}
+
+	virtual vector<Error> reverseTranslate(const vector<Error> &errors) const {
+		vector<Error> result;
+		vector<Error>::const_iterator it, end = errors.end();
+		Error::KeyProcessor keyProcessor =
+			boost::bind(&Translator::reverseTranslateErrorKey, this,
+				boost::placeholders::_1);
+
+		for (it = errors.begin(); it != end; it++) {
+			const Error &error = *it;
+			result.push_back(Error(error.getMessage(keyProcessor)));
+		}
+
+		return result;
+	}
+
+	virtual string translateOne(const StaticString &key) const = 0;
+	virtual string reverseTranslateOne(const StaticString &key) const = 0;
+};
+
+
+} // namespace ConfigKit
+} // namespace Passenger
+
+#endif /* _PASSENGER_CONFIG_KIT_TRANSLATOR_H_ */

data/src/cxx_supportlib/Constants.h

@@ -69,8 +69,6 @@
 #define DEFAULT_START_TIMEOUT 90000
 #define DEFAULT_STAT_THROTTLE_RATE 10
 #define DEFAULT_STICKY_SESSIONS_COOKIE_NAME "_passenger_route"
-#define DEFAULT_UNION_STATION_GATEWAY_ADDRESS "gateway.unionstationapp.com"
-#define DEFAULT_UNION_STATION_GATEWAY_PORT 443
 #define DEFAULT_WEB_APP_USER "nobody"
 #define ENTERPRISE_URL "https://www.phusionpassenger.com/enterprise"
 #define FEEDBACK_FD 3
@@ -82,7 +80,7 @@
 #define PASSENGER_API_VERSION_MAJOR 0
 #define PASSENGER_API_VERSION_MINOR 3
 #define PASSENGER_DEFAULT_USER "nobody"
-#define PASSENGER_VERSION "5.1.12"
+#define PASSENGER_VERSION "5.2.0"
 #define POOL_HELPER_THREAD_STACK_SIZE 262144
 #define PROCESS_SHUTDOWN_TIMEOUT 60
 #define PROCESS_SHUTDOWN_TIMEOUT_DISPLAY "1 minute"

data/src/cxx_supportlib/FileTools/FileManip.cpp

@@ -0,0 +1,297 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2010-2017 Phusion Holding B.V.
+ *
+ *  "Passenger", "Phusion Passenger" and "Union Station" are registered
+ *  trademarks of Phusion Holding B.V.
+ *
+ *  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.
+ */
+
+#include <boost/thread.hpp>
+#include <oxt/system_calls.hpp>
+
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+
+#include <cstdio>
+#include <cerrno>
+
+#include <FileTools/FileManip.h>
+#include <FileDescriptor.h>
+#include <Exceptions.h>
+#include <FileTools/PathManip.h>
+#include <ProcessManagement/Spawn.h>
+#include <ProcessManagement/Utils.h>
+#include <Utils.h> // parseModeString
+#include <Utils/CachedFileStat.hpp>
+#include <Utils/IOUtils.h>
+
+namespace Passenger {
+
+using namespace std;
+using namespace oxt;
+
+
+FileGuard::FileGuard(const StaticString &_filename)
+	: filename(_filename.data(), _filename.size()),
+	  committed(false)
+{
+	// Do nothing
+}
+
+FileGuard::~FileGuard() {
+	if (!committed) {
+		int ret;
+		do {
+			ret = unlink(filename.c_str());
+		} while (ret == -1 && errno == EINTR);
+	}
+}
+
+void
+FileGuard::commit() {
+	committed = true;
+}
+
+
+bool
+fileExists(const StaticString &filename, CachedFileStat *cstat, boost::mutex *cstatMutex,
+	unsigned int throttleRate)
+{
+	return getFileType(filename, cstat, cstatMutex, throttleRate) == FT_REGULAR;
+}
+
+FileType
+getFileType(const StaticString &filename, CachedFileStat *cstat, boost::mutex *cstatMutex,
+	unsigned int throttleRate)
+{
+	struct stat buf;
+	int ret;
+
+	if (cstat != NULL) {
+		boost::unique_lock<boost::mutex> l;
+		if (cstatMutex != NULL) {
+			l = boost::unique_lock<boost::mutex>(*cstatMutex);
+		}
+		ret = cstat->stat(filename, &buf, throttleRate);
+	} else {
+		ret = stat(string(filename.data(), filename.size()).c_str(), &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 FT_NONEXISTANT;
+		} else {
+			int e = errno;
+			string message("Cannot stat '");
+			message.append(filename.data(), filename.size());
+			message.append("'");
+			throw FileSystemException(message, e, filename);
+		}
+	}
+}
+
+void
+createFile(const string &filename, const StaticString &contents, mode_t permissions, uid_t owner,
+	gid_t group, bool overwrite, const char *callerFile, unsigned int callerLine)
+{
+	FileDescriptor fd;
+	int ret, e, options;
+
+	options = O_WRONLY | O_CREAT | O_TRUNC;
+	if (!overwrite) {
+		options |= O_EXCL;
+	}
+	do {
+		fd.assign(open(filename.c_str(), options, permissions),
+			(callerFile == NULL) ? __FILE__ : callerFile,
+			(callerLine == 0) ? __LINE__ : callerLine);
+	} while (fd == -1 && errno == EINTR);
+	if (fd != -1) {
+		FileGuard guard(filename);
+
+		// The file permission may not be as expected because of the active
+		// umask, so fchmod() it here to ensure correct permissions.
+		do {
+			ret = fchmod(fd, permissions);
+		} while (ret == -1 && errno == EINTR);
+		if (ret == -1) {
+			e = errno;
+			throw FileSystemException("Cannot set permissions on " + filename,
+				e, filename);
+		}
+
+		if (owner != USER_NOT_GIVEN && group != GROUP_NOT_GIVEN) {
+			if (owner == USER_NOT_GIVEN) {
+				owner = (uid_t) -1; // Don't let fchown change file owner.
+			}
+			if (group == GROUP_NOT_GIVEN) {
+				group = (gid_t) -1; // Don't let fchown change file group.
+			}
+			do {
+				ret = fchown(fd, owner, group);
+			} while (ret == -1 && errno == EINTR);
+			if (ret == -1) {
+				e = errno;
+				throw FileSystemException("Cannot set ownership for " + filename,
+					e, filename);
+			}
+		}
+
+		try {
+			writeExact(fd, contents);
+			fd.close();
+		} catch (const SystemException &e) {
+			throw FileSystemException("Cannot write to file " + filename,
+				e.code(), filename);
+		}
+		guard.commit();
+	} else {
+		e = errno;
+		if (overwrite || e != EEXIST) {
+			throw FileSystemException("Cannot create file " + filename,
+				e, filename);
+		}
+	}
+}
+
+void
+makeDirTree(const string &path, const StaticString &mode, uid_t owner, gid_t group) {
+	struct stat buf;
+	vector<string> paths;
+	vector<string>::reverse_iterator rit;
+	string current = path;
+	mode_t modeBits;
+	int ret;
+
+	if (stat(path.c_str(), &buf) == 0) {
+		return;
+	}
+
+	modeBits = parseModeString(mode);
+
+	/* Create a list of parent paths that don't exist. For example, given
+	 * path == "/a/b/c/d/e" and that only /a exists, the list will become
+	 * as follows:
+	 *
+	 * /a/b/c/d
+	 * /a/b/c
+	 * /a/b
+	 */
+	while (current != "/" && current != "." && getFileType(current) == FT_NONEXISTANT) {
+		paths.push_back(current);
+		current = extractDirName(current);
+	}
+
+	/* Now traverse the list in reverse order and create directories that don't exist. */
+	for (rit = paths.rbegin(); rit != paths.rend(); rit++) {
+		current = *rit;
+
+		do {
+			ret = mkdir(current.c_str(), modeBits);
+		} while (ret == -1 && errno == EINTR);
+		if (ret == -1) {
+			if (errno == EEXIST) {
+				// Ignore error and don't chmod/chown.
+				continue;
+			} else {
+				int e = errno;
+				throw FileSystemException("Cannot create directory '" + current + "'",
+					e, current);
+			}
+		}
+
+		/* Chmod in order to override the umask. */
+		do {
+			ret = chmod(current.c_str(), modeBits);
+		} while (ret == -1 && errno == EINTR);
+
+		if (owner != USER_NOT_GIVEN && group != GROUP_NOT_GIVEN) {
+			if (owner == USER_NOT_GIVEN) {
+				owner = (uid_t) -1; // Don't let chown change file owner.
+			}
+			if (group == GROUP_NOT_GIVEN) {
+				group = (gid_t) -1; // Don't let chown change file group.
+			}
+			do {
+				ret = chown(current.c_str(), owner, group);
+			} while (ret == -1 && errno == EINTR);
+			if (ret == -1) {
+				char message[1024];
+				int e = errno;
+
+				snprintf(message, sizeof(message) - 1,
+					"Cannot change the directory '%s' its UID to %lld and GID to %lld",
+					current.c_str(), (long long) owner, (long long) group);
+				message[sizeof(message) - 1] = '\0';
+				throw FileSystemException(message, e, path);
+			}
+		}
+	}
+}
+
+static void
+redirectStderrToDevNull() {
+	int devnull = open("/dev/null", O_RDONLY);
+	if (devnull > 2) {
+		dup2(devnull, 2);
+		close(devnull);
+	}
+}
+
+void
+removeDirTree(const string &path) {
+	{
+		const char *command[] = {
+			"chmod",
+			"-R",
+			"u+rwx",
+			path.c_str(),
+			NULL
+		};
+		SubprocessInfo info;
+		runCommand(command, info, true, true, redirectStderrToDevNull);
+	}
+	{
+		const char *command[] = {
+			"rm",
+			"-rf",
+			path.c_str(),
+			NULL
+		};
+		SubprocessInfo info;
+		runCommand(command, info, true, true, redirectStderrToDevNull);
+		if (info.status != 0 && info.status != -2) {
+			throw RuntimeException("Cannot remove directory '" + path + "'");
+		}
+	}
+}
+
+
+} // namespace Passenger