passenger 5.2.3 → 5.3.0

data/src/cxx_supportlib/LoggingKit/Logging.h

@@ -28,6 +28,7 @@
 
 #include <oxt/macros.hpp>
 #include <LoggingKit/Forward.h>
+#include <StaticString.h>
 #include <Utils/FastStringStream.h>
 #include <DataStructures/HashedStaticString.h>
 
@@ -198,7 +199,8 @@ namespace LoggingKit {
  * @param message The message that was received.
  * @param appLogFile an app specific file to log to.
  */
-void logAppOutput(const HashedStaticString &groupName, pid_t pid, const char *channelName, const char *message, unsigned int size, const StaticString &appLogFile);
+void logAppOutput(const HashedStaticString &groupName, pid_t pid, const StaticString &channelName,
+	const char *message, unsigned int size, const StaticString &appLogFile);
 
 } // namespace LoggingKit
 } // namespace Passenger

data/src/cxx_supportlib/Utils.cpp

@@ -115,6 +115,48 @@ escapeForXml(const StaticString &input) {
 	return result;
 }
 
+string
+escapeShell(const StaticString &value) {
+	if (value.empty()) {
+		return "''";
+	}
+
+	const char *pos = value.data();
+	const char *end = value.data() + value.size();
+	string result;
+
+	result.reserve(value.size() * 1.5);
+
+	while (pos < end) {
+		char ch = *pos;
+		if (ch == '\n') {
+			// It is not possible to escape a newline with a backslash.
+			// This is because a backslash + newline combination
+			// is treated to mean a line continuation
+			result.append("'\n'", 3);
+		} else {
+			bool allowed =
+				(ch >= 'A' && ch <= 'Z')
+				|| (ch >= 'a' && ch <= 'z')
+				|| (ch >= '0' && ch <= '9')
+				|| ch == '_'
+				|| ch == '-'
+				|| ch == '.'
+				|| ch == ','
+				|| ch == ':'
+				|| ch == '/'
+				|| ch == '@';
+			if (!allowed) {
+				result.append(1, '\\');
+			}
+			result.append(1, ch);
+		}
+		pos++;
+	}
+
+	return result;
+}
+
 string
 getProcessUsername(bool fallback) {
 	struct passwd pwd, *result;

data/src/cxx_supportlib/Utils.h

@@ -85,6 +85,13 @@ ptr(T *pointer) {
  */
 string escapeForXml(const StaticString &input);
 
+/**
+ * Escape the given string into a single value for use in a shell (like Bash).
+ *
+ * @throws std::bad_alloc Something went wrong.
+ */
+string escapeShell(const StaticString &input);
+
 /**
  * Returns the username of the user that the current process is running as.
  * If the user has no associated username, then the behavior depends on the

data/src/cxx_supportlib/Utils/IOUtils.cpp

@@ -733,6 +733,64 @@ connectToServer(NConnect_State &state) {
 	}
 }
 
+bool
+pingTcpServer(const StaticString &host, unsigned int port, unsigned long long *timeout) {
+	TRACE_POINT();
+	NTCP_State state;
+
+	setupNonBlockingTcpSocket(state, host, port, __FILE__, __LINE__);
+
+	try {
+		if (connectToTcpServer(state)) {
+			return true;
+		}
+	} catch (const SystemException &e) {
+		if (e.code() == ECONNREFUSED) {
+			return false;
+		} else {
+			throw e;
+		}
+	}
+
+	// Cannot connect to the port yet, but that may not mean the
+	// port is unavailable. So poll the socket.
+
+	bool connectable;
+	try {
+		connectable = waitUntilWritable(state.fd, timeout);
+	} catch (const SystemException &e) {
+		throw SystemException("Error polling TCP socket "
+			+ host + ":" + toString(port), e.code());
+	}
+	if (!connectable) {
+		// Timed out. Assume port is not available.
+		return false;
+	}
+
+	// Try to connect the socket one last time.
+
+	try {
+		return connectToTcpServer(state);
+	} catch (const SystemException &e) {
+		if (e.code() == ECONNREFUSED) {
+			return false;
+		} else if (e.code() == EISCONN || e.code() == EINVAL) {
+			#ifdef __FreeBSD__
+				// Work around bug in FreeBSD (discovered on
+				// January 20 2013 in daemon_controller)
+				return false;
+			#else
+				throw e;
+			#endif
+
+			// Never reached, shut up compiler warning.
+			return false;
+		} else {
+			throw e;
+		}
+	}
+}
+
 SocketPair
 createUnixSocketPair(const char *file, unsigned int line) {
 	int fds[2];

data/src/cxx_supportlib/Utils/IOUtils.h

@@ -384,6 +384,19 @@ void setupNonBlockingSocket(NConnect_State & restrict_ref state,
  */
 bool connectToServer(NConnect_State &state);
 
+/**
+ * Checks whether the given TCP server is connectable. Because this check
+ * can take (in theory) an arbitrary amount of time, you must also supply
+ * a timeout. When the operation is done, the amount of time taken will be
+ * deducted from the `*timeout` value. A timeout of 100000 microseconds is
+ * recommended for most use cases.
+ *
+ * @throws IOException Something went wrong.
+ * @throws SystemException Something went wrong.
+ * @throws boost::thread_interrupted A system call has been interrupted.
+ */
+bool pingTcpServer(const StaticString &host, unsigned int port, unsigned long long *timeout);
+
 /**
  * Creates a Unix domain socket pair.
  *

data/src/cxx_supportlib/Utils/JsonUtils.h

@@ -70,46 +70,82 @@ getJsonField(Json::Value &json, const char *key) {
 	}
 }
 
+
 inline int
 getJsonIntField(const Json::Value &json, const char *key) {
-	Json::StaticString theKey(key);
-	if (json.isMember(theKey)) {
-		return json[theKey].asInt();
+	if (json.isMember(key)) {
+		return json[key].asInt();
 	} else {
 		throw VariantMap::MissingKeyException(key);
 	}
 }
 
 inline int
-getJsonIntField(const Json::Value &json, const char *key, int defaultValue) {
-	Json::StaticString theKey(key);
-	if (json.isMember(theKey)) {
-		return json[theKey].asInt();
+getJsonIntField(const Json::Value &json, const Json::StaticString &key) {
+	if (json.isMember(key)) {
+		return json[key].asInt();
+	} else {
+		throw VariantMap::MissingKeyException(key.c_str());
+	}
+}
+
+inline int
+getJsonIntField(const Json::Value &json, const Json::StaticString &key, int defaultValue) {
+	if (json.isMember(key)) {
+		return json[key].asInt();
 	} else {
 		return defaultValue;
 	}
 }
 
+inline void
+getJsonIntField(const Json::Value &json, const Json::StaticString &key, int *result) {
+	if (json.isMember(key)) {
+		*result = json[key].asInt();
+	}
+}
+
+inline void
+getJsonIntField(const Json::Value &json, const string &key, int *result) {
+	if (json.isMember(key)) {
+		*result = json[key].asInt();
+	}
+}
+
+
 inline unsigned int
-getJsonUintField(const Json::Value &json, const char *key) {
-	Json::StaticString theKey(key);
-	if (json.isMember(theKey)) {
-		return json[theKey].asUInt();
+getJsonUintField(const Json::Value &json, const Json::StaticString &key) {
+	if (json.isMember(key)) {
+		return json[key].asUInt();
 	} else {
-		throw VariantMap::MissingKeyException(key);
+		throw VariantMap::MissingKeyException(key.c_str());
 	}
 }
 
 inline unsigned int
-getJsonUintField(const Json::Value &json, const char *key, unsigned int defaultValue) {
-	Json::StaticString theKey(key);
-	if (json.isMember(theKey)) {
-		return json[theKey].asUInt();
+getJsonUintField(const Json::Value &json, const Json::StaticString &key, unsigned int defaultValue) {
+	if (json.isMember(key)) {
+		return json[key].asUInt();
 	} else {
 		return defaultValue;
 	}
 }
 
+inline void
+getJsonUintField(const Json::Value &json, const Json::StaticString &key, unsigned int *result) {
+	if (json.isMember(key)) {
+		*result = json[key].asUInt();
+	}
+}
+
+inline void
+getJsonUintField(const Json::Value &json, const string &key, unsigned int *result) {
+	if (json.isMember(key)) {
+		*result = json[key].asUInt();
+	}
+}
+
+
 inline boost::uint64_t
 getJsonUint64Field(const Json::Value &json, const char *key) {
 	Json::StaticString theKey(key);
@@ -130,23 +166,41 @@ getJsonUint64Field(const Json::Value &json, const char *key, unsigned int defaul
 	}
 }
 
+
+inline bool
+getJsonBoolField(const Json::Value &json, const char *key) {
+	if (json.isMember(key)) {
+		return json[key].asBool();
+	} else {
+		throw VariantMap::MissingKeyException(key);
+	}
+}
+
+
 inline StaticString
 getJsonStaticStringField(const Json::Value &json, const char *key) {
-	Json::StaticString theKey(key);
-	if (json.isMember(theKey)) {
-		return json[theKey].asCString();
+	if (json.isMember(key)) {
+		return json[key].asCString();
 	} else {
 		throw VariantMap::MissingKeyException(key);
 	}
 }
 
 inline StaticString
-getJsonStaticStringField(const Json::Value &json, const char *key,
+getJsonStaticStringField(const Json::Value &json, const Json::StaticString &key) {
+	if (json.isMember(key)) {
+		return json[key].asCString();
+	} else {
+		throw VariantMap::MissingKeyException(key.c_str());
+	}
+}
+
+inline StaticString
+getJsonStaticStringField(const Json::Value &json, const Json::StaticString &key,
 	const StaticString &defaultValue)
 {
-	Json::StaticString theKey(key);
-	if (json.isMember(theKey)) {
-		return json[theKey].asCString();
+	if (json.isMember(key)) {
+		return json[key].asCString();
 	} else {
 		return defaultValue;
 	}
@@ -236,6 +290,59 @@ timeToJson(unsigned long long timestamp, unsigned long long now = 0) {
 	return doc;
 }
 
+/**
+ * Encodes the given monotonic timestamp into a JSON object that
+ * describes it.
+ *
+ *     MonotonicTimeUsec t = SystemTime::getMonotonicUsec();
+ *     monoTimeToJson(t - 10000000, t);
+ *     // {
+ *     //   "timestamp": 1424887842,
+ *     //   "local": "Wed Feb 25 19:10:34 CET 2015",
+ *     //   "relative_timestamp": -10,
+ *     //   "relative": "10s ago"
+ *     // }
+ */
+inline Json::Value
+monoTimeToJson(MonotonicTimeUsec t, MonotonicTimeUsec monoNow, unsigned long long now = 0) {
+	if (t == 0) {
+		return Json::Value(Json::nullValue);
+	}
+
+	if (now == 0) {
+		now = SystemTime::getUsec();
+	}
+
+	unsigned long long wallClockTimeUsec;
+	if (monoNow > t) {
+		wallClockTimeUsec = now - (monoNow - t);
+	} else {
+		wallClockTimeUsec = now + (monoNow - t);
+	}
+
+	time_t wallClockTime = (time_t) (wallClockTimeUsec / 1000000ull);
+	char timeStr[32];
+	size_t len;
+	ctime_r(&wallClockTime, timeStr);
+	len = strlen(timeStr);
+	if (len > 0) {
+		// Get rid of trailing newline
+		timeStr[len - 1] = '\0';
+	}
+
+	Json::Value doc;
+	doc["timestamp"] = wallClockTimeUsec / 1000000.0;
+	doc["local"] = timeStr;
+	if (t > monoNow) {
+		doc["relative_timestamp"] = (t - monoNow) / 1000000.0;
+		doc["relative"] = distanceOfTimeInWords(t / 1000000ull, monoNow / 1000000ull) + " from now";
+	} else {
+		doc["relative_timestamp"] = (monoNow - t) / -1000000.0;
+		doc["relative"] = distanceOfTimeInWords(t / 1000000ull, monoNow / 1000000ull) + " ago";
+	}
+	return doc;
+}
+
 inline Json::Value
 durationToJson(unsigned long long duration) {
 	Json::Value doc;

data/src/cxx_supportlib/Utils/ScopeGuard.h

@@ -133,15 +133,20 @@ public:
 	}
 
 	~FdGuard() {
-		if (fd != -1) {
-			safelyClose(fd, ignoreErrors);
-			P_LOG_FILE_DESCRIPTOR_CLOSE(fd);
-		}
+		runNow();
 	}
 
 	void clear() {
 		fd = -1;
 	}
+
+	void runNow() {
+		if (fd != -1) {
+			safelyClose(fd, ignoreErrors);
+			P_LOG_FILE_DESCRIPTOR_CLOSE(fd);
+			fd = -1;
+		}
+	}
 };
 
 

data/src/cxx_supportlib/Utils/StrIntUtils.cpp

@@ -206,6 +206,13 @@ toString(const vector<StaticString> &vec) {
 	return result;
 }
 
+string
+doubleToString(double value) {
+	char buf[64];
+	int ret = snprintf(buf, sizeof(buf), "%f", value);
+	return string(buf, std::min<size_t>(ret, sizeof(buf) - 1));
+}
+
 string
 pointerToIntString(void *pointer) {
 	return toString((boost::uintptr_t) pointer);

data/src/cxx_supportlib/Utils/StrIntUtils.h

@@ -231,6 +231,7 @@ toString(T something) {
 string toString(const vector<string> &vec);
 string toString(const vector<StaticString> &vec);
 
+string doubleToString(double value);
 string pointerToIntString(void *pointer);
 
 /**

data/src/cxx_supportlib/Utils/SystemTime.h

@@ -100,7 +100,7 @@ typedef unsigned long long MonotonicTimeUsec;
 class SystemTime {
 public:
 	enum Granularity {
-		GRAN_1SEC   = 1000000000,   // 1 millisecond granularity
+		GRAN_1SEC   = 1000000000,   // 1 second granularity
 		GRAN_10MSEC = 10000000,     // 10 milliseconds granularity
 		GRAN_1MSEC  = 1000000,      // 1 millisecond granularity
 		GRAN_1USEC  = 1000          // 1 microsecond granularty

data/src/cxx_supportlib/Utils/Timer.h

@@ -37,7 +37,7 @@ using namespace oxt;
 
 /**
  * A Timer which one can use to check how much time has elapsed since the
- * timer started. This timer support miliseconds-resolution, but the exact
+ * timer started. This timer supports miliseconds-resolution, but the exact
  * resolution depends on the OS and the hardware.
  *
  * This class is thread-safe.

data/src/cxx_supportlib/WebSocketCommandReverseServer.h

@@ -582,10 +582,12 @@ private:
 		P_NOTICE(getLogPrefix() << "Closing connection: " << reason);
 		reconnectAfterReply = false;
 		timer->cancel();
-		conn->close(code, reason, ec);
-		conn.reset();
-		if (ec) {
-			P_WARN(getLogPrefix() << "Error closing connection: " << ec.message());
+		if (conn != NULL) {
+			conn->close(code, reason, ec);
+			conn.reset();
+			if (ec) {
+				P_WARN(getLogPrefix() << "Error closing connection: " << ec.message());
+			}
 		}
 
 		{