passenger 5.0.6 → 5.0.7

data/doc/users_guide_snippets/tips.txt

@@ -157,42 +157,30 @@ Phusion Passenger automatically leverages operating system virtual memory copy-o
 - MRI Ruby >= 2.0. Versions prior to 2.0 did not have a copy-on-write friendly garbage collector.
 - http://www.rubyenterpriseedition.com/[Ruby Enterprise Edition], which was Phusion's branch of MRI Ruby 1.8 with a copy-on-write friendly garbage collector and other enhancement. It has reached End-Of-Life as of 2012, but remains available for legacy systems.
 
+[[tuning_sse_websockets]]
+=== Tuning for Server Sent Events and WebSockets ===
 
-[[capistrano]]
-=== Capistrano recipe ===
+Phusion Passenger supports Server Sent Events (SSE) and WebSockets out of the box with no configuration, but there are some things you need to know.
 
-Phusion Passenger can be combined with link:http://capify.org/[Capistrano].
-The following Capistrano recipe demonstrates Phusion Passenger support.
-It assumes that you're using Git as version control system.
+First, WebSockets are link:https://github.com/phusion/passenger/issues/1202[not yet supported when using the Apache integration mode].
 
---------------------------------------------------
-set :application, "myapp"
-set :domain,      "example.com"
-set :repository,  "ssh://#{domain}/path-to-your-git-repo/#{application}.git"
-set :use_sudo,    false
-set :deploy_to,   "/path-to-your-web-app-directory/#{application}"
-set :scm,         "git"
-
-role :app, domain
-role :web, domain
-role :db,  domain, :primary => true
-
-namespace :deploy do
-  task :start, :roles => :app do
-    run "touch #{current_release}/tmp/restart.txt"
-  end
-  
-  task :stop, :roles => :app do
-    # Do nothing.
-  end
-  
-  desc "Restart Application"
-  task :restart, :roles => :app do
-    run "touch #{current_release}/tmp/restart.txt"
-  end
+Second, for Ruby apps only, you need to insert a configuration snippet inside your `config.ru`:
+
+[code,ruby]
+----------------------------------------------------------
+if defined?(PhusionPassenger)
+  PhusionPassenger.advertised_concurrency_level = 0
 end
---------------------------------------------------
+----------------------------------------------------------
+
+[NOTE]
+==========================================================
+This snippet tells Passenger that your Ruby app will handle SSE and WebSockets. In response, Passenger will adjust the connection concurrency settings for your app. Without this configuration snippet, SSE and WebSockets still work, but with degraded performance.
+
+This configuration snippet is currently necessary because of the way Passenger is implemented. We are link:https://github.com/phusion/passenger/issues/1195[working on improving this mechanism]. One day, the above configuration snippet will no longer be necessary. For now, you should include the above configuration snippet for optimal SSE and WebSocket performance.
+==========================================================
 
+Finally, you can find Passenger SSE and WebSocket demo apps on link:https://www.phusionpassenger.com/documentation_and_support[the Passenger documentation overview page], under section "Demos".
 
 [[bundler_support]]
 === Bundler support ===

data/doc/users_guide_snippets/under_the_hood/relationship_with_ruby.txt

@@ -13,6 +13,10 @@ endif::[]
 ifdef::nginx[]
 <<PassengerPreStart,passenger_pre_start>>)
 endif::[]
+ifdef::standalone[]
+<<PassengerPreStart,passenger_pre_start>>)
+endif::[]
+
 are written in Ruby as well.
  * Ruby web application support is implemented in Ruby.
  * If you use <<flying_passenger,Flying Passenger>>, then the Flying Passenger daemon is written in Ruby. The daemon is a small (less than 500 lines of code) and offloads most tasks to the C++ core.
@@ -33,6 +37,9 @@ endif::[]
 ifdef::nginx[]
 <<PassengerRuby,passenger_ruby>>
 endif::[]
+ifdef::standalone[]
+<<PassengerRuby,passenger_ruby>>
+endif::[]
 directive to learn how run different web applications under different Ruby interpreters.
 
 .Caveat: RVM and RVM gemsets

data/ext/apache2/ConfigurationCommands.cpp

@@ -61,6 +61,13 @@
 		"The Node.js command to use."),
 
 	
+	AP_INIT_TAKE1("PassengerMeteorAppSettings",
+		(Take1Func) cmd_passenger_meteor_app_settings,
+		NULL,
+		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
+		"Settings file for (non-bundled) Meteor apps."),
+
+	
 	AP_INIT_TAKE1("PassengerAppEnv",
 		(Take1Func) cmd_passenger_app_env,
 		NULL,

data/ext/apache2/ConfigurationFields.hpp

@@ -76,6 +76,8 @@
 	const char *appType;
 	/** The group that Ruby applications must run as. */
 	const char *group;
+	/** Settings file for (non-bundled) Meteor apps. */
+	const char *meteorAppSettings;
 	/** The Node.js command to use. */
 	const char *nodejs;
 	/** The Python interpreter to use. */

data/ext/apache2/ConfigurationSetters.cpp

@@ -63,6 +63,14 @@
 		}
 	
 	
+		static const char *
+		cmd_passenger_meteor_app_settings(cmd_parms *cmd, void *pcfg, const char *arg) {
+			DirConfig *config = (DirConfig *) pcfg;
+			config->meteorAppSettings = arg;
+			return NULL;
+		}
+	
+	
 		static const char *
 		cmd_passenger_app_env(cmd_parms *cmd, void *pcfg, const char *arg) {
 			DirConfig *config = (DirConfig *) pcfg;

data/ext/apache2/CreateDirConfig.cpp

@@ -41,6 +41,7 @@
 			config->ruby = NULL;
 				config->python = NULL;
 				config->nodejs = NULL;
+				config->meteorAppSettings = NULL;
 				config->appEnv = NULL;
 				config->minInstances = UNSET_INT_VALUE;
 				config->maxInstancesPerApp = UNSET_INT_VALUE;

data/ext/apache2/MergeDirConfig.cpp

@@ -61,6 +61,13 @@
 	
 
 	
+		config->meteorAppSettings =
+			(add->meteorAppSettings == NULL) ?
+			base->meteorAppSettings :
+			add->meteorAppSettings;
+	
+
+	
 		config->appEnv =
 			(add->appEnv == NULL) ?
 			base->appEnv :

data/ext/apache2/SetHeaders.cpp

@@ -55,6 +55,11 @@
 	
 
 	
+		addHeader(result, StaticString("!~PASSENGER_METEOR_APP_SETTINGS",
+			sizeof("!~PASSENGER_METEOR_APP_SETTINGS") - 1), config->meteorAppSettings);
+	
+
+	
 		addHeader(result, StaticString("!~PASSENGER_APP_ENV",
 			sizeof("!~PASSENGER_APP_ENV") - 1), config->appEnv);
 	

data/ext/common/ApplicationPool2/Options.h

@@ -105,6 +105,8 @@ private:
 		result.push_back(&options.ruby);
 		result.push_back(&options.python);
 		result.push_back(&options.nodejs);
+		result.push_back(&options.meteorAppSettings);
+
 		result.push_back(&options.environmentVariables);
 		result.push_back(&options.loggingAgentAddress);
 		result.push_back(&options.loggingAgentUsername);
@@ -260,6 +262,12 @@ public:
 	 */
 	StaticString nodejs;
 
+	/**
+	 * When running meteor in non-bundled mode, settings for the application need to be specified
+	 * via --settings (instead of through the METEOR_SETTINGS environment variable),
+	 */
+	StaticString meteorAppSettings;
+
 	/**
 	 * Any rights that the spawned application process may have. The SpawnManager
 	 * will create a new account for each spawned app, and that account will be
@@ -588,6 +596,7 @@ public:
 			appendKeyValue (vec, "ruby",               ruby);
 			appendKeyValue (vec, "python",             python);
 			appendKeyValue (vec, "nodejs",             nodejs);
+			appendKeyValue (vec, "meteor_app_settings", meteorAppSettings);
 			appendKeyValue (vec, "logging_agent_address",  loggingAgentAddress);
 			appendKeyValue (vec, "logging_agent_username", loggingAgentUsername);
 			appendKeyValue (vec, "logging_agent_password", loggingAgentPassword);

data/ext/common/Constants.h

@@ -114,7 +114,7 @@
 
 	#define NGINX_DOC_URL "https://www.phusionpassenger.com/documentation/Users%20guide%20Nginx.html"
 
-	#define PASSENGER_VERSION "5.0.6"
+	#define PASSENGER_VERSION "5.0.7"
 
 	#define POOL_HELPER_THREAD_STACK_SIZE 262144
 
@@ -140,6 +140,8 @@
 
 	#define SERVER_TOKEN_NAME "Phusion_Passenger"
 
+	#define SHORT_PROGRAM_NAME "Passenger"
+
 	#define STANDALONE_DOC_URL "https://www.phusionpassenger.com/documentation/Users%20guide%20Standalone.html"
 
 	#define STANDALONE_NGINX_CONFIGURE_OPTIONS "--with-cc-opt='-Wno-error' --without-http_fastcgi_module --without-http_scgi_module --without-http_uwsgi_module --with-http_gzip_static_module --with-http_stub_status_module --with-http_ssl_module"

data/ext/common/Logging.cpp

@@ -130,10 +130,10 @@ _prepareLogEntry(FastStringStream<> &sstream, const char *file, unsigned int lin
 	gettimeofday(&tv, NULL);
 	localtime_r(&tv.tv_sec, &the_tm);
 	datetime_size = snprintf(datetime_buf, sizeof(datetime_buf),
-		"%d-%02d-%02d %02d:%02d:%02d.%04u",
+		"%d-%02d-%02d %02d:%02d:%02d.%04llu",
 		the_tm.tm_year + 1900, the_tm.tm_mon + 1, the_tm.tm_mday,
 		the_tm.tm_hour, the_tm.tm_min, the_tm.tm_sec,
-		tv.tv_usec / 100);
+		(unsigned long long) tv.tv_usec / 100);
 	sstream <<
 		"[ " << StaticString(datetime_buf, datetime_size) <<
 		" " << std::dec << getpid() << "/" <<

data/ext/common/ServerKit/HttpHeaderParser.h

@@ -1,6 +1,6 @@
 /*
  *  Phusion Passenger - https://www.phusionpassenger.com/
- *  Copyright (c) 2014 Phusion
+ *  Copyright (c) 2014-2015 Phusion
  *
  *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
@@ -44,6 +44,10 @@ namespace Passenger {
 namespace ServerKit {
 
 
+extern const HashedStaticString HTTP_CONTENT_LENGTH;
+extern const HashedStaticString HTTP_X_SENDFILE;
+extern const HashedStaticString HTTP_X_ACCEL_REDIRECT;
+
 struct HttpParseRequest {};
 struct HttpParseResponse {};
 
@@ -366,6 +370,14 @@ private:
 				message->httpState = Message::ONEHUNDRED_CONTINUE;
 			}
 			message->bodyType = Message::RBT_NO_BODY;
+		} else if (message->headers.lookup(HTTP_X_SENDFILE) != NULL
+		 || message->headers.lookup(HTTP_X_ACCEL_REDIRECT) != NULL)
+		{
+			// Ignore Content-Length when X-Sendfile or X-Accel-Redirect is set.
+			// See https://github.com/phusion/passenger/issues/1376
+			message->httpState = Message::COMPLETE;
+			message->bodyType = Message::RBT_NO_BODY;
+			message->headers.erase(HTTP_CONTENT_LENGTH);
 		} else if (state->parser.flags & F_CHUNKED) {
 			if (contentLength == std::numeric_limits<boost::uint64_t>::max()) {
 				message->httpState = Message::PARSING_CHUNKED_BODY;

data/ext/common/ServerKit/Implementation.cpp

@@ -1,6 +1,6 @@
 /*
  *  Phusion Passenger - https://www.phusionpassenger.com/
- *  Copyright (c) 2014 Phusion
+ *  Copyright (c) 2014-2015 Phusion
  *
  *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
@@ -31,6 +31,9 @@ namespace ServerKit {
 // Define 'extern' so that the compiler doesn't output warnings.
 extern const HashedStaticString HTTP_COOKIE;
 extern const HashedStaticString HTTP_SET_COOKIE;
+extern const HashedStaticString HTTP_CONTENT_LENGTH;
+extern const HashedStaticString HTTP_X_SENDFILE;
+extern const HashedStaticString HTTP_X_ACCEL_REDIRECT;
 extern const char DEFAULT_INTERNAL_SERVER_ERROR_RESPONSE[];
 extern const unsigned int DEFAULT_INTERNAL_SERVER_ERROR_RESPONSE_SIZE;
 
@@ -45,6 +48,9 @@ const unsigned int DEFAULT_INTERNAL_SERVER_ERROR_RESPONSE_SIZE =
 	sizeof(DEFAULT_INTERNAL_SERVER_ERROR_RESPONSE) - 1;
 const HashedStaticString HTTP_COOKIE("cookie");
 const HashedStaticString HTTP_SET_COOKIE("set-cookie");
+const HashedStaticString HTTP_CONTENT_LENGTH("content-length");
+const HashedStaticString HTTP_X_SENDFILE("x-sendfile");
+const HashedStaticString HTTP_X_ACCEL_REDIRECT("x-accel-redirect");
 
 
 } // namespace ServerKit

data/ext/common/agents/Base.cpp

@@ -96,7 +96,7 @@ static bool _feedbackFdAvailable = false;
 static const char digits[] = {
 	'0', '1', '2', '3', '4', '5', '6', '7', '8', '9'
 };
-static const char hex_chars[] = "01234567890abcdef";
+static const char hex_chars[] = "0123456789abcdef";
 
 static bool shouldDumpWithCrashWatch = true;
 static bool beepOnAbort = false;

data/ext/common/agents/HelperAgent/OptionParser.h

@@ -41,6 +41,7 @@ using namespace std;
 
 inline void
 serverUsage() {
+	// ....|---------------Keep output within standard terminal width (80 chars)------------|
 	printf("Usage: " AGENT_EXE " server <OPTIONS...> [APP DIRECTORY]\n");
 	printf("Runs the " PROGRAM_NAME " standalone HTTP server agent.\n");
 	printf("\n");
@@ -110,6 +111,11 @@ serverUsage() {
 	printf("                            Force friendly error pages to be always off\n");
 	printf("\n");
 	printf("      --ruby PATH           Default Ruby interpreter to use.\n");
+	printf("      --nodejs PATH         Default NodeJs interpreter to use.\n");
+	printf("      --python PATH         Default Python interpreter to use.\n");
+	printf("      --meteor-app-settings PATH\n");
+	printf("                            File with settings for a Meteor (non-bundled) app.\n");
+	printf("                            (passed to Meteor using --settings)\n");
 	printf("      --debugger            Enable Ruby debugger support (Enterprise only)\n");
 	printf("\n");
 	printf("      --rolling-restarts    Enable rolling restarts (Enterprise only)\n");
@@ -294,6 +300,15 @@ parseServerOption(int argc, const char *argv[], int &i, VariantMap &options) {
 	} else if (p.isValueFlag(argc, i, argv[i], '\0', "--ruby")) {
 		options.set("default_ruby", argv[i + 1]);
 		i += 2;
+	} else if (p.isValueFlag(argc, i, argv[i], '\0', "--nodejs")) {
+		options.set("default_nodejs", argv[i + 1]);
+		i += 2;
+	} else if (p.isValueFlag(argc, i, argv[i], '\0', "--python")) {
+		options.set("default_python", argv[i + 1]);
+		i += 2;
+	} else if (p.isValueFlag(argc, i, argv[i], '\0', "--meteor-app-settings")) {
+		options.set("meteor_app_settings", argv[i + 1]);
+		i += 2;
 	} else if (p.isFlag(argv[i], '\0', "--debugger")) {
 		options.setBool("debugger", true);
 		i++;

data/ext/common/agents/HelperAgent/RequestHandler.h

@@ -131,6 +131,7 @@ private:
 	StaticString defaultVaryTurbocacheByCookie;
 
 	HashedStaticString PASSENGER_APP_GROUP_NAME;
+	HashedStaticString PASSENGER_ENV_VARS;
 	HashedStaticString PASSENGER_MAX_REQUESTS;
 	HashedStaticString PASSENGER_STICKY_SESSIONS;
 	HashedStaticString PASSENGER_STICKY_SESSIONS_COOKIE_NAME;
@@ -195,6 +196,7 @@ public:
 		  poolOptionsCache(4),
 
 		  PASSENGER_APP_GROUP_NAME("!~PASSENGER_APP_GROUP_NAME"),
+		  PASSENGER_ENV_VARS("!~PASSENGER_ENV_VARS"),
 		  PASSENGER_MAX_REQUESTS("!~PASSENGER_MAX_REQUESTS"),
 		  PASSENGER_STICKY_SESSIONS("!~PASSENGER_STICKY_SESSIONS"),
 		  PASSENGER_STICKY_SESSIONS_COOKIE_NAME("!~PASSENGER_STICKY_SESSIONS_COOKIE_NAME"),
@@ -431,7 +433,7 @@ public:
 			}
 		}
 
-		if (req->session != NULL || resp->httpState != AppResponse::PARSING_HEADERS) {
+		if (req->appResponseInitialized) {
 			doc["app_response_http_state"] = resp->getHttpStateString();
 			doc["app_response_http_major"] = resp->httpMajor;
 			doc["app_response_http_minor"] = resp->httpMinor;

data/ext/common/agents/HelperAgent/RequestHandler/BufferBody.cpp

@@ -60,13 +60,13 @@ whenBufferingBody_onRequestBody(Client *client, Request *req,
 			// The data that we've stored in the body buffer is dechunked, so when forwarding
 			// the buffered body to the app we must advertise it as being a fixed-length,
 			// non-chunked body.
+			const unsigned int UINT64_STRSIZE = sizeof("18446744073709551615");
 			SKC_TRACE(client, 2, "Adjusting forwarding headers as fixed-length, non-chunked");
 			ServerKit::Header *header = (ServerKit::Header *)
 				psg_palloc(req->pool, sizeof(ServerKit::Header));
-			char *contentLength = (char *) psg_pnalloc(req->pool,
-				sizeof("18446744073709551615"));
+			char *contentLength = (char *) psg_pnalloc(req->pool, UINT64_STRSIZE);
 			unsigned int size = integerToOtherBase<boost::uint64_t, 10>(
-				req->bodyBytesBuffered, contentLength, sizeof(contentLength));
+				req->bodyBytesBuffered, contentLength, UINT64_STRSIZE);
 
 			psg_lstr_init(&header->key);
 			psg_lstr_append(&header->key, req->pool, "content-length",

data/ext/common/agents/HelperAgent/RequestHandler/InitRequest.cpp

@@ -200,6 +200,7 @@ initializePoolOptions(Client *client, Request *req, RequestAnalysis &analysis) {
 	}
 
 	if (!req->ended()) {
+		fillPoolOption(req, req->options.environmentVariables, PASSENGER_ENV_VARS);
 		fillPoolOption(req, req->options.maxRequests, PASSENGER_MAX_REQUESTS);
 	}
 }
@@ -207,6 +208,16 @@ initializePoolOptions(Client *client, Request *req, RequestAnalysis &analysis) {
 void
 fillPoolOptionsFromAgentsOptions(Options &options) {
 	options.ruby = defaultRuby;
+	if (agentsOptions->has("default_nodejs")) {
+		options.nodejs = agentsOptions->get("default_nodejs");
+	}
+	if (agentsOptions->has("default_python")) {
+		options.python = agentsOptions->get("default_python");
+	}
+	if (agentsOptions->has("meteor_app_settings")) {
+		options.meteorAppSettings = agentsOptions->get("meteor_app_settings");
+	}
+
 	options.logLevel = getLogLevel();
 	options.loggingAgentAddress = loggingAgentAddress;
 	options.loggingAgentUsername = P_STATIC_STRING("logging");
@@ -350,6 +361,7 @@ createNewPoolOptions(Client *client, Request *req, const HashedStaticString &app
 	fillPoolOption(req, options.ruby, "!~PASSENGER_RUBY");
 	fillPoolOption(req, options.python, "!~PASSENGER_PYTHON");
 	fillPoolOption(req, options.nodejs, "!~PASSENGER_NODEJS");
+	fillPoolOption(req, options.meteorAppSettings, "!~PASSENGER_METEOR_APP_SETTINGS");
 	fillPoolOption(req, options.user, "!~PASSENGER_USER");
 	fillPoolOption(req, options.group, "!~PASSENGER_GROUP");
 	fillPoolOption(req, options.minProcesses, "!~PASSENGER_MIN_PROCESSES");
@@ -362,7 +374,6 @@ createNewPoolOptions(Client *client, Request *req, const HashedStaticString &app
 	fillPoolOption(req, options.restartDir, "!~PASSENGER_RESTART_DIR");
 	fillPoolOption(req, options.startupFile, "!~PASSENGER_STARTUP_FILE");
 	fillPoolOption(req, options.loadShellEnvvars, "!~PASSENGER_LOAD_SHELL_ENVVARS");
-	fillPoolOption(req, options.environmentVariables, "!~PASSENGER_ENV_VARS");
 	fillPoolOption(req, options.raiseInternalError, "!~PASSENGER_RAISE_INTERNAL_ERROR");
 	/******************/
 

data/ext/common/agents/HelperAgent/RequestHandler/Utils.cpp

@@ -192,10 +192,10 @@ gatherBuffers(char * restrict dest, unsigned int size, const struct iovec *buffe
 // `path` MUST be NULL-terminated. Returns a contiguous LString.
 static LString *
 resolveSymlink(const StaticString &path, psg_pool_t *pool) {
-	char linkbuf[PATH_MAX];
+	char linkbuf[PATH_MAX + 1];
 	ssize_t size;
 
-	size = readlink(path.data(), linkbuf, sizeof(linkbuf) - 1);
+	size = readlink(path.data(), linkbuf, PATH_MAX);
 	if (size == -1) {
 		if (errno == EINVAL) {
 			return psg_lstr_create(pool, path);
@@ -215,7 +215,11 @@ resolveSymlink(const StaticString &path, psg_pool_t *pool) {
 			throw FileSystemException(message, ENOENT, path.data());
 		} else if (linkbuf[0] == '/') {
 			// Symlink points to an absolute path.
-			return psg_lstr_create(pool, linkbuf, strlen(linkbuf));
+			size_t len = strlen(linkbuf);
+			char *data = (char *) psg_pnalloc(pool, len + 1);
+			memcpy(data, linkbuf, len);
+			data[len] = '\0';
+			return psg_lstr_create(pool, data, len);
 		} else {
 			// Symlink points to a relative path.
 			// We do not use absolutizePath() because it's too slow.

data/ext/common/agents/HelperAgent/ResponseCache.h

@@ -130,6 +130,8 @@ private:
 	HashedStaticString AUTHORIZATION;
 	HashedStaticString VARY;
 	HashedStaticString WWW_AUTHENTICATE;
+	HashedStaticString X_SENDFILE;
+	HashedStaticString X_ACCEL_REDIRECT;
 	HashedStaticString EXPIRES;
 	HashedStaticString LAST_MODIFIED;
 	HashedStaticString LOCATION;
@@ -412,6 +414,8 @@ public:
 		  AUTHORIZATION("authorization"),
 		  VARY("vary"),
 		  WWW_AUTHENTICATE("www-authenticate"),
+		  X_SENDFILE("x-sendfile"),
+		  X_ACCEL_REDIRECT("x-accel-redirect"),
 		  EXPIRES("expires"),
 		  LAST_MODIFIED("last-modified"),
 		  LOCATION("location"),
@@ -591,7 +595,9 @@ public:
 
 		if (req->headers.lookup(AUTHORIZATION) != NULL
 		 || respHeaders.lookup(VARY) != NULL
-		 || respHeaders.lookup(WWW_AUTHENTICATE) != NULL)
+		 || respHeaders.lookup(WWW_AUTHENTICATE) != NULL
+		 || respHeaders.lookup(X_SENDFILE) != NULL
+		 || respHeaders.lookup(X_ACCEL_REDIRECT) != NULL)
 		{
 			return false;
 		}