passenger 5.1.6 → 5.1.7

data/src/agent/Core/SpawningKit/PipeWatcher.h

@@ -77,7 +77,7 @@ private:
 		}
 
 		UPDATE_TRACE_POINT();
-		while (!this_thread::interruption_requested()) {
+		while (!boost::this_thread::interruption_requested()) {
 			char buf[1024 * 8];
 			ssize_t ret;
 

data/src/agent/UstRouter/RemoteSender.h

@@ -336,7 +336,11 @@ private:
 			prepareRequest(pingURL);
 
 			curl_easy_setopt(curl, CURLOPT_HTTPGET, 1);
-			if (curl_easy_perform(curl) != 0) {
+			CURLcode code;
+			if (CURLE_OK == (code = setCurlDefaultCaInfo(curl))) {
+				code = curl_easy_perform(curl);
+			}
+			if (code != 0) {
 				setPingError(
 					"Could not ping Union Station gateway server " +
 					ip + ": " + lastCurlErrorMessage);
@@ -406,7 +410,10 @@ private:
 			P_DEBUG("Sending Union Station packet: key=" << item.unionStationKey <<
 				", node=" << item.nodeName << ", category=" << item.category <<
 				", compressedDataSize=" << item.data.size());
-			CURLcode code = curl_easy_perform(curl);
+			CURLcode code;
+			if (CURLE_OK == (code = setCurlDefaultCaInfo(curl))) {
+				code = curl_easy_perform(curl);
+			}
 			curl_formfree(post);
 
 			if (code == CURLE_OK) {

data/src/cxx_supportlib/ConfigKit/Common.h

@@ -44,10 +44,15 @@ class Store;
 
 enum Type {
 	STRING_TYPE,
+	PASSWORD_TYPE, // Like STRING_TYPE, but inspect() won't show its value
 	INT_TYPE,
 	UINT_TYPE,
 	FLOAT_TYPE,
 	BOOL_TYPE,
+
+	ARRAY_TYPE,
+	STRING_ARRAY_TYPE,
+
 	UNKNOWN_TYPE
 };
 

data/src/cxx_supportlib/ConfigKit/DummyTranslator.h

@@ -0,0 +1,76 @@
+/*
+ *  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_DUMMY_TRANSLATOR_H_
+#define _PASSENGER_CONFIG_KIT_DUMMY_TRANSLATOR_H_
+
+#include <vector>
+#include <ConfigKit/Common.h>
+#include <StaticString.h>
+
+namespace Passenger {
+namespace ConfigKit {
+
+using namespace std;
+
+
+/**
+ * A translator that does nothing.
+ *
+ * You can learn more about translators in the ConfigKit README, section
+ * "The special problem of overlapping configuration names and translation".
+ */
+class DummyTranslator {
+public:
+	Json::Value translate(const Json::Value &doc) const {
+		return doc;
+	}
+
+	Json::Value reverseTranslate(const Json::Value &doc) const {
+		return doc;
+	}
+
+	vector<Error> translate(const vector<Error> &errors) const {
+		return errors;
+	}
+
+	vector<Error> reverseTranslate(const vector<Error> &errors) const {
+		return errors;
+	}
+
+	StaticString translateOne(const StaticString &key) const {
+		return key;
+	}
+
+	StaticString reverseTranslateOne(const StaticString &key) const {
+		return key;
+	}
+};
+
+
+} // namespace ConfigKit
+} // namespace Passenger
+
+#endif /* _PASSENGER_CONFIG_KIT_DUMMY_TRANSLATOR_H_ */

data/src/cxx_supportlib/ConfigKit/PrefixTranslator.h

@@ -0,0 +1,166 @@
+/*
+ *  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_PREFIX_TRANSLATOR_H_
+#define _PASSENGER_CONFIG_KIT_PREFIX_TRANSLATOR_H_
+
+#include <boost/bind.hpp>
+#include <cassert>
+#include <string>
+#include <vector>
+#include <jsoncpp/json.h>
+
+#include <ConfigKit/Common.h>
+#include <StaticString.h>
+
+namespace Passenger {
+namespace ConfigKit {
+
+using namespace std;
+
+
+/**
+ * A translator that translates keys by adding a prefix.
+ *
+ * You can learn more about translators in the ConfigKit README, section
+ * "The special problem of overlapping configuration names and translation".
+ */
+class PrefixTranslator {
+private:
+	string prefix;
+	bool finalized;
+
+	string translateErrorKey(const StaticString &key) const {
+		return "{{" + translateOne(key) + "}}";
+	}
+
+	string reverseTranslateErrorKey(const StaticString &key) const {
+		return "{{" + reverseTranslateOne(key) + "}}";
+	}
+
+public:
+	PrefixTranslator()
+		: finalized(false)
+		{ }
+
+	PrefixTranslator(const string &_prefix)
+		: prefix(_prefix),
+		  finalized(true)
+		{ }
+
+	void setPrefixAndFinalize(const string &_prefix) {
+		assert(!finalized);
+		prefix = _prefix;
+		finalized = true;
+	}
+
+	bool isFinalized() const {
+		return finalized;
+	}
+
+	Json::Value translate(const Json::Value &doc) const {
+		assert(finalized);
+		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;
+	}
+
+	Json::Value reverseTranslate(const Json::Value &doc) const {
+		assert(finalized);
+		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;
+	}
+
+	vector<Error> translate(const vector<Error> &errors) const {
+		assert(finalized);
+		vector<Error> result;
+		vector<Error>::const_iterator it, end = errors.end();
+		Error::KeyProcessor keyProcessor =
+			boost::bind(&PrefixTranslator::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;
+	}
+
+	vector<Error> reverseTranslate(const vector<Error> &errors) const {
+		assert(finalized);
+		vector<Error> result;
+		vector<Error>::const_iterator it, end = errors.end();
+		Error::KeyProcessor keyProcessor =
+			boost::bind(&PrefixTranslator::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;
+	}
+
+	string translateOne(const StaticString &key) const {
+		assert(finalized);
+		if (key.substr(0, prefix.size()) == prefix) {
+			return key.substr(prefix.size());
+		} else {
+			return key;
+		}
+	}
+
+	string reverseTranslateOne(const StaticString &key) const {
+		assert(finalized);
+		if (key.substr(0, prefix.size()) != prefix) {
+			return prefix + key;
+		} else {
+			return key;
+		}
+	}
+};
+
+
+} // namespace ConfigKit
+} // namespace Passenger
+
+#endif /* _PASSENGER_CONFIG_KIT_PREFIX_TRANSLATOR_H_ */

data/src/cxx_supportlib/ConfigKit/README.md

@@ -4,34 +4,41 @@ ConfigKit is a configuration management system that lets you define configuratio
 
 **Table of contents:**
 
- * Motivations
-   - Configuration flow from high-level to low-level with a minimum of repeated code
-   - Unifying configuration management
- * Status inside the Passenger codebase
- * Features and class overview
-   - ConfigKit::Schema
-   - ConfigKit::Store
-   - Translators
- * Using the schema
-   - Defining the schema
-   - Defining default values
-   - Defining custom validators
-   - Inspecting the schema
- * Using the store
-   - Putting data in the store
-   - Updating data
-   - Unregistered keys are ignored
-   - Deleting data
-   - Fetching data
-   - Default values
-   - Inspecting all data
- * Putting it all together: synchronous version
-   - SecurityChecker example: a configurable, low-level component
-   - DnsQuerier example: a low-level component with post-configuration application operations
-   - Downloader example: a high-level component that combines subcomponents
-     - The special problem of conflicting overlapping configuration names and translation
-     - Code example
- * Putting it all together: asynchronous version
+<!-- MarkdownTOC depth=3 autolink="true" bracket="round" -->
+
+- [Motivations](#motivations)
+  - [Configuration flow from high-level to low-level with a minimum of repeated code](#configuration-flow-from-high-level-to-low-level-with-a-minimum-of-repeated-code)
+  - [Unifying configuration management](#unifying-configuration-management)
+- [Status inside the Passenger codebase](#status-inside-the-passenger-codebase)
+- [Features and class overview](#features-and-class-overview)
+  - [ConfigKit::Schema](#configkitschema)
+  - [ConfigKit::Store](#configkitstore)
+  - [Translators](#translators)
+- [Using the schema](#using-the-schema)
+  - [Defining the schema](#defining-the-schema)
+    - [Types](#types)
+    - [Flags](#flags)
+  - [Defining default values](#defining-default-values)
+  - [Defining custom validators](#defining-custom-validators)
+  - [Inspecting the schema](#inspecting-the-schema)
+- [Using the store](#using-the-store)
+  - [Putting data in the store](#putting-data-in-the-store)
+    - [Updating data](#updating-data)
+  - [Unregistered keys are ignored](#unregistered-keys-are-ignored)
+  - [Deleting data](#deleting-data)
+  - [Fetching data](#fetching-data)
+  - [Default values](#default-values)
+  - [Inspecting all data](#inspecting-all-data)
+- [Putting it all together: synchronous version](#putting-it-all-together-synchronous-version)
+  - [SecurityChecker example: a configurable, low-level component](#securitychecker-example-a-configurable-low-level-component)
+  - [DnsQuerier example: a low-level component with post-configuration application operations](#dnsquerier-example-a-low-level-component-with-post-configuration-application-operations)
+  - [Downloader example: a high-level component that combines subcomponents](#downloader-example-a-high-level-component-that-combines-subcomponents)
+    - [The special problem of conflicting overlapping configuration names and translation](#the-special-problem-of-conflicting-overlapping-configuration-names-and-translation)
+    - [Code example](#code-example)
+  - [Main function example](#main-function-example)
+- [Putting it all together: asynchronous version](#putting-it-all-together-asynchronous-version)
+
+<!-- /MarkdownTOC -->
 
 ## Motivations
 
@@ -109,13 +116,13 @@ There is also `ConfigKit::Store`. This is a class that stores configuration valu
 
 ### Translators
 
-And finally there is a "translator" class: `ConfigKit::TableTranslator`. The role of translators are described in the section "The special problem of conflicting overlapping configuration names and translation".
+And finally there are "translator" classes: `ConfigKit::TableTranslator` and `ConfigKit::PrefixTranslator`. The role of translators are described in the section "The special problem of conflicting overlapping configuration names and translation".
 
 ## Using the schema
 
 ### Defining the schema
 
-Start using ConfigKit by defining a schema. There are two ways to do this. The first one is to simply create ConfigKit::Schema object and adding definitions to it:
+Start using ConfigKit by defining a schema. There are two ways to do this. The first one is to simply create ConfigKit::Schema object and adding definitions to it with `schema.add(name, type, flags, [default value])`:
 
 ~~~c++
 ConfigKit::Schema schema;
@@ -150,7 +157,25 @@ struct YourSchema: public ConfigKit::Schema {
 YourSchema schema;
 ~~~
 
-Tip: see ConfigKit/Common.h for all supported types and flags.
+#### Types
+
+The following types are available:
+
+ * `STRING_TYPE` -- a string.
+ * `PASSWORD_TYPE` -- a password string. Unlike `STRING_TYPE`, the value of password fields will be filtered out in the output generated by `ConfigKit::Store::inspect()`. Learn more about `inspect()` in [Using the store -- Inspecting all data](#inspecting-all-data).
+ * `INT_TYPE` -- a signed integer.
+ * `UINT_TYPE` -- an unsigned integer.
+ * `FLOAT_TYPE` -- a floating point number.
+ * `BOOL_TYPE` -- a boolean.
+ * `ARRAY_TYPE` -- an generic array. May contain any values.
+ * `STRING_ARRAY_TYPE` -- an array of strings.
+
+#### Flags
+
+ * `REQUIRED` -- this field is required. Mutually exclusive with `OPTIONAL`.
+ * `OPTIONAL` -- this field is optional. Mutually exclusive with `REQUIRED`.
+ * `CACHE_DEFAULT_VALUE` -- use in combination with [dynamic default values](#defining-default-values). When this flag is set, the value returned by the dynamic value function is cached so that the function won't be called over and over again.
+ * `READ_ONLY` -- this field can only be set once. Only the first `ConfigKit::Store::update()` call actually updates the value; subsequent calls won't. Learn more about `update()` in [Using the store -- Putting data in the store](#putting-data-in-the-store).
 
 ### Defining default values
 
@@ -598,7 +623,7 @@ Whenever Downloader is configured, it configures subcomponents too. But whenever
 There is one special problem that deserves attention: a high-level component may not necessarily want to expose their subcomponents' configuration options using the same names. For example, both `SecurityChecker` and `DnsQuerier` expose a `timeout` option, but they are *different* timeouts, and are even distinct from the Downloader's own download timeout. To solve this special problem of **conflicting overlapping configuration names**, we utilize a **translation system**. We define how the Downloader's configuration keys are to be mapped a specific subcomponent's configuration keys. We obviously can't define the entire mapping, because that would return us to the original problem of having to manually write so much repeated code. There are several ways to deal with this, such as:
 
  - Assuming that most options don't have to be renamed, and only define exceptions to this rule. This is the approach that is demonstrated in this example. The `ConfigKit::TableTranslator` class implements this translation strategy.
- - Prefixing the subcomponents' options. This approach is left as an exercise to the reader.
+ - Prefixing the subcomponents' options. The `ConfigKit::PrefixTranslator` class implements this translation strategy.
 
 #### Code example
 

data/src/cxx_supportlib/ConfigKit/Schema.h

@@ -37,6 +37,7 @@
 #include <Exceptions.h>
 #include <Logging.h>
 #include <ConfigKit/Common.h>
+#include <ConfigKit/DummyTranslator.h>
 #include <ConfigKit/Utils.h>
 #include <DataStructures/StringKeyTable.h>
 #include <Utils/StrIntUtils.h>
@@ -94,21 +95,6 @@ public:
 	typedef boost::function<void (const Store &store, vector<Error> &errors)> Validator;
 
 private:
-	class DummyTranslator {
-	public:
-		StaticString translateOne(const StaticString &key) const {
-			return key;
-		}
-
-		StaticString reverseTranslateOne(const StaticString &key) const {
-			return key;
-		}
-
-		vector<Error> reverseTranslate(const vector<Error> &errors) const {
-			return errors;
-		}
-	};
-
 	StringKeyTable<Entry> entries;
 	boost::container::vector<Validator> validators;
 	bool finalized;
@@ -255,6 +241,7 @@ public:
 
 		switch (entry->type) {
 		case STRING_TYPE:
+		case PASSWORD_TYPE:
 			if (value.isConvertibleTo(Json::stringValue)) {
 				return true;
 			} else {
@@ -294,6 +281,27 @@ public:
 				error = Error("'{{" + key + "}}' must be a boolean");
 				return false;
 			}
+		case ARRAY_TYPE:
+			if (value.isConvertibleTo(Json::arrayValue)) {
+				return true;
+			} else {
+				error = Error("'{{" + key + "}}' must be an array");
+				return false;
+			}
+		case STRING_ARRAY_TYPE:
+			if (value.isConvertibleTo(Json::arrayValue)) {
+				Json::Value::const_iterator it, end = value.end();
+				for (it = value.begin(); it != end; it++) {
+					if (it->type() != Json::stringValue) {
+						error = Error("'{{" + key + "}}' may only contain strings");
+						return false;
+					}
+				}
+				return true;
+			} else {
+				error = Error("'{{" + key + "}}' must be an array");
+				return false;
+			}
 		default:
 			P_BUG("Unknown type " + Passenger::toString((int) entry->type));
 			return false;