passenger 5.1.4 → 5.1.5

data/src/cxx_supportlib/ConfigKit/TableTranslator.h

@@ -0,0 +1,185 @@
+/*
+ *  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_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 <DataStructures/StringKeyTable.h>
+
+namespace Passenger {
+namespace ConfigKit {
+
+using namespace std;
+
+
+/**
+ * A translator that translates keys according to a table of rules. Anything
+ * not in the table is simply left as-is.
+ *
+ *     TableTranslator translator;
+ *     translator.add("foo", "bar");
+ *     translator.finalize();
+ *
+ *     translator.translateOne("foo");         // => "bar"
+ *     translator.reverseTranslateOne("bar");  // => "foo"
+ *
+ *     translator.translateOne("baz");         // => "baz"
+ *     translator.reverseTranslateOne("baz");  // => "baz"
+ *
+ * You can learn more about translators in the ConfigKit README, section
+ * "The special problem of overlapping configuration names and translation".
+ */
+class TableTranslator {
+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,
+		const StaticString &key)
+	{
+		const string *entry;
+
+		if (table.lookup(key, &entry)) {
+			return *entry;
+		} else {
+			return key;
+		}
+	}
+
+public:
+	TableTranslator()
+		: finalized(false)
+		{ }
+
+	void add(const StaticString &mainSchemaKeyName, const StaticString &subSchemaKeyName) {
+		assert(!finalized);
+		table.insert(mainSchemaKeyName, subSchemaKeyName);
+		reverseTable.insert(subSchemaKeyName, mainSchemaKeyName);
+	}
+
+	void finalize() {
+		assert(!finalized);
+		table.compact();
+		reverseTable.compact();
+		finalized = true;
+	}
+
+	bool isFinalized() const {
+		return finalized;
+	}
+
+	Json::Value translate(const Json::Value &doc) const {
+		assert(finalized);
+		return internalTranslate(table, doc);
+	}
+
+	Json::Value reverseTranslate(const Json::Value &doc) const {
+		assert(finalized);
+		return internalTranslate(reverseTable, doc);
+	}
+
+	vector<Error> translate(const vector<Error> &errors) const {
+		assert(finalized);
+		return internalTranslate(table, errors);
+	}
+
+	vector<Error> reverseTranslate(const vector<Error> &errors) const {
+		assert(finalized);
+		return internalTranslate(reverseTable, errors);
+	}
+
+	StaticString translateOne(const StaticString &key) const {
+		assert(finalized);
+		return internalTranslateOne(table, key);
+	}
+
+	StaticString reverseTranslateOne(const StaticString &key) const {
+		return internalTranslateOne(reverseTable, key);
+	}
+};
+
+
+} // namespace ConfigKit
+} // namespace Passenger
+
+#endif /* _PASSENGER_CONFIG_KIT_TABLE_TRANSLATOR_H_ */

data/src/cxx_supportlib/ConfigKit/Utils.h

@@ -0,0 +1,141 @@
+/*
+ *  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_UTILS_H_
+#define _PASSENGER_CONFIG_KIT_UTILS_H_
+
+#include <string>
+#include <vector>
+
+#include <jsoncpp/json.h>
+
+#include <ConfigKit/Common.h>
+#include <StaticString.h>
+#include <Utils/FastStringStream.h>
+
+namespace Passenger {
+namespace ConfigKit {
+
+using namespace std;
+
+class Error;
+
+
+template<typename Component, typename Translator>
+inline bool
+previewConfigUpdateSubComponent(Component &component,
+	const Json::Value &updates, const Translator &translator,
+	vector<Error> &errors)
+{
+	vector<Error> tempErrors;
+
+	component.previewConfigUpdate(translator.translate(updates),
+		tempErrors);
+	tempErrors = translator.reverseTranslate(tempErrors);
+	errors.insert(errors.end(), tempErrors.begin(), tempErrors.end());
+	return errors.empty();
+}
+
+template<typename Component, typename Translator>
+inline void
+configureSubComponent(Component &component,
+	const Json::Value &updates, const Translator &translator,
+	vector<ConfigKit::Error> &errors)
+{
+	vector<ConfigKit::Error> tempErrors;
+
+	component.configure(translator.translate(updates), tempErrors);
+	tempErrors = translator.reverseTranslate(tempErrors);
+	errors.insert(errors.end(), tempErrors.begin(), tempErrors.end());
+}
+
+template<typename Component>
+inline void
+callPreviewConfigUpdateAndCallback(Component *component, Json::Value updates,
+	ConfigKit::ConfigCallback callback)
+{
+	vector<ConfigKit::Error> errors;
+	Json::Value config = component->previewConfigUpdate(updates, errors);
+	callback(config, errors);
+}
+
+template<typename Component>
+inline void
+callConfigureAndCallback(Component *component, Json::Value updates,
+	ConfigKit::ConfigCallback callback)
+{
+	vector<ConfigKit::Error> errors;
+	if (component->configure(updates, errors)) {
+		callback(component->inspectConfig(), errors);
+	} else {
+		callback(Json::nullValue, errors);
+	}
+}
+
+template<typename Component>
+inline void
+callInspectConfigAndCallback(Component *component,
+	ConfigKit::InspectCallback callback)
+{
+	callback(component->inspectConfig());
+}
+
+inline StaticString
+getTypeString(Type type) {
+	switch (type) {
+	case STRING_TYPE:
+		return P_STATIC_STRING("string");
+	case INT_TYPE:
+		return P_STATIC_STRING("integer");
+	case UINT_TYPE:
+		return P_STATIC_STRING("unsigned integer");
+	case FLOAT_TYPE:
+		return P_STATIC_STRING("float");
+	case BOOL_TYPE:
+		return P_STATIC_STRING("boolean");
+	default:
+		return P_STATIC_STRING("unknown");
+	}
+}
+
+inline string
+toString(const vector<Error> &errors) {
+	FastStringStream<> stream;
+	vector<Error>::const_iterator it, end = errors.end();
+
+	for (it = errors.begin(); it != end; it++) {
+		if (it != errors.begin()) {
+			stream << "; ";
+		}
+		stream << it->getMessage();
+	}
+	return string(stream.data(), stream.size());
+}
+
+
+} // ConfigKit
+} // Passenger
+
+#endif /* _PASSENGER_CONFIG_KIT_UTILS_H_ */

data/src/cxx_supportlib/ConfigKit/VariantMapUtils.h

@@ -0,0 +1,81 @@
+/*
+ *  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_VARIANT_MAP_UTILS_H_
+#define _PASSENGER_CONFIG_KIT_VARIANT_MAP_UTILS_H_
+
+#include <Logging.h>
+#include <Exceptions.h>
+#include <ConfigKit/Schema.h>
+#include <Utils/StrIntUtils.h>
+#include <Utils/VariantMap.h>
+
+namespace Passenger {
+namespace ConfigKit {
+
+
+inline Json::Value
+variantMapToJson(const Schema &schema, const VariantMap &options) {
+	Json::Value doc;
+	Schema::ConstIterator it(schema.getIterator());
+
+	while (*it != NULL) {
+		const StaticString &key = it.getKey();
+		const Schema::Entry &entry = it.getValue();
+
+		if (options.has(key)) {
+			switch (entry.type) {
+			case STRING_TYPE:
+				doc[key.toString()] = options.get(key);
+				break;
+			case INT_TYPE:
+				doc[key.toString()] = options.getInt(key);
+				break;
+			case UINT_TYPE:
+				doc[key.toString()] = options.getUint(key);
+				break;
+			case FLOAT_TYPE:
+				throw RuntimeException("variantMapToJson(): unsupported type FLOAT_TYPE");
+				break;
+			case BOOL_TYPE:
+				doc[key.toString()] = options.getBool(key);
+				break;
+			default:
+				P_BUG("Unknown type " + Passenger::toString((int) entry.type));
+				break;
+			}
+		}
+
+		it.next();
+	}
+
+	return doc;
+}
+
+
+} // ConfigKit
+} // Passenger
+
+#endif /* _PASSENGER_CONFIG_KIT_VARIANT_MAP_UTILS_H_ */

data/src/cxx_supportlib/Constants.h

@@ -80,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.4"
+#define PASSENGER_VERSION "5.1.5"
 #define POOL_HELPER_THREAD_STACK_SIZE 262144
 #define PROCESS_SHUTDOWN_TIMEOUT 60
 #define PROCESS_SHUTDOWN_TIMEOUT_DISPLAY "1 minute"

data/src/cxx_supportlib/Crypto.cpp

@@ -176,7 +176,7 @@ void Crypto::killKey(const char *cLabel) {
 		if (oserr) {
 			CFStringRef str = SecCopyErrorMessageString(oserr, NULL);
 			logError(string("Removing Passenger Cert from keychain failed: ") + CFStringGetCStringPtr(str, kCFStringEncodingUTF8) +
-					" Please remove the certificate labeled " + cLabel + " in your keychain.");
+					". Please remove the certificate labeled " + cLabel + " in your keychain.");
 			CFRelease(str);
 		}
 		CFRelease(dict);
@@ -190,7 +190,7 @@ void Crypto::killKey(const char *cLabel) {
 			if (oserr) {
 				CFStringRef str = SecCopyErrorMessageString(oserr, NULL);
 				logError(string("Removing Passenger private key from keychain failed: ") + CFStringGetCStringPtr(str, kCFStringEncodingUTF8) +
-						 " Please remove the private key from the certificate labeled " + cLabel + " in your keychain.");
+						 ". Please remove the private key from the certificate labeled " + cLabel + " in your keychain.");
 				CFRelease(str);
 			}
 			CFRelease(dict);

data/src/cxx_supportlib/Logging.h

@@ -380,41 +380,6 @@ void setPrintAppOutputAsDebuggingMessages(bool enabled);
 	} while (false)
 
 
-class NotExpectingExceptions {
-private:
-	boost::this_thread::disable_interruption di;
-	boost::this_thread::disable_syscall_interruption dsi;
-	const char *filename;
-	const char *function;
-	unsigned int line;
-
-public:
-	NotExpectingExceptions(const char *_filename, unsigned int _line, const char *_function) {
-		filename = _filename;
-		line = _line;
-		function = _function;
-	}
-
-	~NotExpectingExceptions() {
-		if (std::uncaught_exception()) {
-			P_ERROR("Unexpected exception detected at " << filename <<
-				":" << line << ", function '" << function << "'!");
-		}
-	}
-};
-
-/**
- * Put this in code sections where you don't expect *any* exceptions to be thrown.
- * This macro will automatically disable interruptions in the current scope,
- * and will print an error message whenever the scope exits with an exception.
- *
- * When inside critical sections, you should put this macro right after the lock
- * object so that the error message is displayed before unlocking the lock;
- * otherwise other threads may run before the error message is displayed, and
- * those threads may see an inconsistant state and crash.
- */
-#define NOT_EXPECTING_EXCEPTIONS() NotExpectingExceptions __nee(__FILE__, __LINE__, __PRETTY_FUNCTION__)
-
 } // namespace Passenger
 
 #endif /* _PASSENGER_LOGGING_H_ */