passenger 5.3.7 → 6.0.0

data/resources/templates/standalone/server.erb

@@ -41,6 +41,7 @@ passenger_enabled on;
 <%= nginx_option(app, :spawn_method) %>
 <%= nginx_option(app, :app_type) %>
 <%= nginx_option(app, :startup_file) %>
+<%= nginx_option(app, :app_start_command) %>
 <%= nginx_option(app, :start_timeout) %>
 <%= nginx_option(app, :min_instances) %>
 <%= nginx_option(app, :max_request_queue_size) %>

data/src/agent/AgentMain.cpp

@@ -36,6 +36,7 @@ int systemMetricsMain(int argc, char *argv[]);
 int tempDirToucherMain(int argc, char *argv[]);
 int spawnEnvSetupperMain(int argc, char *argv[]);
 int execHelperMain(int argc, char *argv[]);
+int fileReadHelperMain(int argc, char *argv[]);
 
 static bool
 isHelp(const char *arg) {
@@ -58,6 +59,7 @@ usage(int argc, char *argv[]) {
 	printf("Utility subcommands:\n");
 	printf("  system-metrics\n");
 	printf("  exec-helper\n");
+	printf("  file-read-helper\n");
 }
 
 static bool
@@ -90,6 +92,8 @@ dispatchSubcommand(int argc, char *argv[]) {
 		exit(spawnEnvSetupperMain(argc, argv));
 	} else if (strcmp(argv[1], "exec-helper") == 0) {
 		exit(execHelperMain(argc, argv));
+	} else if (strcmp(argv[1], "file-read-helper") == 0) {
+		exit(fileReadHelperMain(argc, argv));
 	} else if (strcmp(argv[1], "test-binary") == 0) {
 		printf("PASS\n");
 		exit(0);

data/src/agent/Core/ApplicationPool/Group/StateInspection.cpp

@@ -233,7 +233,7 @@ Group::inspectConfigInAdminPanelFormat(Json::Value &result) const {
 
 	result["type"] = NON_EMPTY_SVAL(options.appType);
 	result["startup_file"] = NON_EMPTY_SVAL(options.startupFile);
-	result["start_command"] = NON_EMPTY_SVAL(replaceAll(options.startCommand,
+	result["start_command"] = NON_EMPTY_SVAL(replaceAll(options.appStartCommand,
 		P_STATIC_STRING("\t"), P_STATIC_STRING(" ")));
 	result["ruby"] = SVAL(options.ruby, DEFAULT_RUBY);
 	result["python"] = SVAL(options.python, DEFAULT_PYTHON);

data/src/agent/Core/ApplicationPool/Options.h

@@ -85,7 +85,7 @@ private:
 		result.push_back(&options.appGroupName);
 		result.push_back(&options.appLogFile);
 		result.push_back(&options.appType);
-		result.push_back(&options.startCommand);
+		result.push_back(&options.appStartCommand);
 		result.push_back(&options.startupFile);
 		result.push_back(&options.processTitle);
 
@@ -181,15 +181,15 @@ public:
 	/** The application's type, used for determining the command to invoke to
 	 * spawn an application process as well as determining the startup file's
 	 * filename. It can be one of the app type names in AppType.cpp, or the
-	 * empty string (default). In case of the latter, 'startCommand' and
+	 * empty string (default). In case of the latter, 'appStartCommand' and
 	 * 'startupFile' (which MUST be set) will dictate the startup command
 	 * and the startup file's filename. */
 	StaticString appType;
 
-	/** The command for spawning the application process. This is a list of
-	 * arguments, separated by '\t', e.g. "ruby\tfoo.rb". Only used
-	 * during spawning and only if appType.empty(). */
-	StaticString startCommand;
+	/** The shell command string for spawning the application process.
+	 * Only used during spawning and only if appType.empty().
+	 */
+	StaticString appStartCommand;
 
 	/** Filename of the application's startup file. Only actually used for
 	 * determining user switching info. Only used during spawning. */
@@ -629,7 +629,7 @@ public:
 		} else if (entry.language == P_STATIC_STRING("meteor")) {
 			interpreter = escapeShell(ruby);
 		} else {
-			return startCommand;
+			return appStartCommand;
 		}
 
 		return interpreter + " " + escapeShell(resourceLocator.getHelperScriptsDir()

data/src/agent/Core/ApplicationPool/Process.h

@@ -601,6 +601,9 @@ public:
 		if (inputPipe != -1) {
 			inputPipe.close();
 		}
+		if (type == SpawningKit::Result::GENERIC) {
+			syscalls::kill(getPid(), SIGTERM);
+		}
 	}
 
 	bool shutdownTimeoutExpired() const {

data/src/agent/Core/Config.h

@@ -160,6 +160,7 @@ using namespace std;
  *   server_software                                                 string             -          default("Phusion_Passenger/5.3.7")
  *   show_version_in_header                                          boolean            -          default(true)
  *   single_app_mode_app_root                                        string             -          default,read_only
+ *   single_app_mode_app_start_command                               string             -          read_only
  *   single_app_mode_app_type                                        string             -          read_only
  *   single_app_mode_startup_file                                    string             -          read_only
  *   standalone_engine                                               string             -          default
@@ -253,6 +254,10 @@ private:
 			errors.push_back(Error("If '{{multi_app_mode}}' is set,"
 				" then '{{single_app_mode_startup_file}}' may not be set"));
 		}
+		if (!config["single_app_mode_app_start_command"].isNull()) {
+			errors.push_back(Error("If '{{multi_app_mode}}' is set,"
+				" then '{{single_app_mode_app_start_command}}' may not be set"));
+		}
 	}
 
 	static void validateSingleAppMode(const ConfigKit::Store &config,
@@ -264,8 +269,9 @@ private:
 			return;
 		}
 
-		// single_app_mode_app_type and single_app_mode_startup_file are
-		// autodetected in initializeSingleAppMode()
+		// single_app_mode_app_type, single_app_mode_startup_file and
+		// single_app_mode_app_start_command are autodetected in
+		// initializeSingleAppMode() so no need to validate them.
 
 		ControllerSingleAppModeSchema::validateAppType("single_app_mode_app_type",
 			wrapperRegistry, config, errors);
@@ -425,6 +431,7 @@ public:
 			ControllerSingleAppModeSchema::getDefaultAppRoot);
 		add("single_app_mode_app_type", STRING_TYPE, OPTIONAL | READ_ONLY);
 		add("single_app_mode_startup_file", STRING_TYPE, OPTIONAL | READ_ONLY);
+		add("single_app_mode_app_start_command", STRING_TYPE, OPTIONAL | READ_ONLY);
 
 		// Add subschema: controllerServerKit
 		controllerServerKit.translator.setPrefixAndFinalize("controller_");

data/src/agent/Core/Controller/Config.h

@@ -223,9 +223,10 @@ public:
  * (do not edit: following text is automatically generated
  * by 'rake configkit_schemas_inline_comments')
  *
- *   app_root       string   -          default,read_only
- *   app_type       string   required   read_only
- *   startup_file   string   required   read_only
+ *   app_root            string   -   default,read_only
+ *   app_start_command   string   -   read_only
+ *   app_type            string   -   read_only
+ *   startup_file        string   -   read_only
  *
  * END
  */
@@ -235,9 +236,11 @@ struct ControllerSingleAppModeSchema: public ConfigKit::Schema {
 
 		addWithDynamicDefault("app_root", STRING_TYPE, OPTIONAL | READ_ONLY | CACHE_DEFAULT_VALUE,
 			getDefaultAppRoot);
-		add("app_type", STRING_TYPE, REQUIRED | READ_ONLY);
-		add("startup_file", STRING_TYPE, REQUIRED | READ_ONLY);
+		add("app_type", STRING_TYPE, OPTIONAL | READ_ONLY);
+		add("startup_file", STRING_TYPE, OPTIONAL | READ_ONLY);
+		add("app_start_command", STRING_TYPE, OPTIONAL | READ_ONLY);
 
+		addValidator(validateAppTypeOrAppStartCommandSet);
 		addValidator(boost::bind(validateAppType, "app_type", wrapperRegistry,
 			boost::placeholders::_1, boost::placeholders::_2));
 		addNormalizer(normalizeAppRoot);
@@ -257,6 +260,21 @@ struct ControllerSingleAppModeSchema: public ConfigKit::Schema {
 		return result;
 	}
 
+	static void validateAppTypeOrAppStartCommandSet(const ConfigKit::Store &config,
+		vector<ConfigKit::Error> &errors)
+	{
+		typedef ConfigKit::Error Error;
+
+		if (config["app_type"].isNull() && config["app_start_command"].isNull()) {
+			errors.push_back(Error(
+				"Either '{{app_type}}' or '{{app_start_command}}' must be set"));
+		}
+		if (!config["app_type"].isNull() && config["startup_file"].isNull()) {
+			errors.push_back(Error(
+				"If '{{app_type}}' is set, then '{{startup_file}}' must also be set"));
+		}
+	}
+
 	static void validateAppType(const string &appTypeKey,
 		const WrapperRegistry::Registry *wrapperRegistry,
 		const ConfigKit::Store &config, vector<ConfigKit::Error> &errors)
@@ -290,7 +308,10 @@ struct ControllerSingleAppModeSchema: public ConfigKit::Schema {
 
 	static Json::Value normalizeStartupFile(const Json::Value &effectiveValues) {
 		Json::Value updates;
-		updates["startup_file"] = absolutizePath(effectiveValues["startup_file"].asString());
+		if (effectiveValues.isMember("startup_file")) {
+			updates["startup_file"] = absolutizePath(
+				effectiveValues["startup_file"].asString());
+		}
 		return updates;
 	}
 };

data/src/agent/Core/Controller/InitRequest.cpp

@@ -337,13 +337,18 @@ Controller::createNewPoolOptions(Client *client, Request *req,
 
 	const LString *appType = secureHeaders.lookup("!~PASSENGER_APP_TYPE");
 	if (appType == NULL || appType->size == 0) {
-		AppTypeDetector::Detector detector(*wrapperRegistry);
-		AppTypeDetector::Detector::Result result = detector.checkAppRoot(options.appRoot);
-		if (result.isNull()) {
-			disconnectWithError(&client, "client did not send a recognized !~PASSENGER_APP_TYPE header");
-			return;
+		const LString *appStartCommand = secureHeaders.lookup("!~PASSENGER_APP_START_COMMAND");
+		if (appStartCommand == NULL || appStartCommand->size == 0) {
+			AppTypeDetector::Detector detector(*wrapperRegistry);
+			AppTypeDetector::Detector::Result result = detector.checkAppRoot(options.appRoot);
+			if (result.isNull()) {
+				disconnectWithError(&client, "client did not send a recognized !~PASSENGER_APP_TYPE header");
+				return;
+			}
+			options.appType = result.wrapperRegistryEntry->language;
+		} else {
+			fillPoolOption(req, options.appStartCommand, "!~PASSENGER_APP_START_COMMAND");
 		}
-		options.appType = result.wrapperRegistryEntry->language;
 	} else {
 		fillPoolOption(req, options.appType, "!~PASSENGER_APP_TYPE");
 	}
@@ -360,7 +365,7 @@ Controller::createNewPoolOptions(Client *client, Request *req,
 	fillPoolOption(req, options.group, "!~PASSENGER_GROUP");
 	fillPoolOption(req, options.minProcesses, "!~PASSENGER_MIN_PROCESSES");
 	fillPoolOption(req, options.spawnMethod, "!~PASSENGER_SPAWN_METHOD");
-	fillPoolOption(req, options.startCommand, "!~PASSENGER_START_COMMAND");
+	fillPoolOption(req, options.appStartCommand, "!~PASSENGER_APP_START_COMMAND");
 	fillPoolOptionSecToMsec(req, options.startTimeout, "!~PASSENGER_START_TIMEOUT");
 	fillPoolOption(req, options.maxPreloaderIdleTime, "!~PASSENGER_MAX_PRELOADER_IDLE_TIME");
 	fillPoolOption(req, options.maxRequestQueueSize, "!~PASSENGER_MAX_REQUEST_QUEUE_SIZE");

data/src/agent/Core/Controller/InitializationAndShutdown.cpp

@@ -112,11 +112,13 @@ Controller::initialize() {
 		string environment = config["default_environment"].asString();
 		string appType = singleAppModeConfig->get("app_type").asString();
 		string startupFile = singleAppModeConfig->get("startup_file").asString();
+		string appStartCommand = singleAppModeConfig->get("app_start_command").asString();
 
 		options->appRoot = appRoot;
 		options->environment = environment;
 		options->appType = appType;
 		options->startupFile = startupFile;
+		options->appStartCommand = appStartCommand;
 		*options = options->copyAndPersist();
 		poolOptionsCache.insert(options->getAppGroupName(), options);
 	}

data/src/agent/Core/CoreMain.cpp

@@ -258,53 +258,83 @@ initializeSingleAppMode() {
 	}
 
 	WorkingObjects *wo = workingObjects;
-	string appType, startupFile;
+	string appType, startupFile, appStartCommand;
 	string appRoot = coreConfig->get("single_app_mode_app_root").asString();
 
-	if (coreConfig->get("single_app_mode_app_type").isNull()) {
+	if (!coreConfig->get("single_app_mode_app_type").isNull()
+	 && !coreConfig->get("single_app_mode_app_start_command").isNull())
+	{
+		fprintf(stderr, "ERROR: it is not allowed for both --app-type and"
+			" --app-start-command to be set.\n");
+		exit(1);
+	}
+
+	if (!coreConfig->get("single_app_mode_app_start_command").isNull()) {
+		// The config specified that this is a generic app or a Kuria app.
+		appStartCommand = coreConfig->get("single_app_mode_app_start_command").asString();
+	} else if (coreConfig->get("single_app_mode_app_type").isNull()) {
+		// Autodetect whether this is generic app, Kuria app or auto-supported app.
 		P_DEBUG("Autodetecting application type...");
-		AppTypeDetector::Detector detector(*coreWrapperRegistry, NULL, 0);
-		AppTypeDetector::Detector::Result result = detector.checkAppRoot(appRoot);
-		if (result.isNull()) {
-			fprintf(stderr, "ERROR: unable to autodetect what kind of application "
-				"lives in %s. Please specify information about the app using "
-				"--app-type and --startup-file, or specify a correct location to "
-				"the application you want to serve.\n"
-				"Type '" SHORT_PROGRAM_NAME " core --help' for more information.\n",
-				appRoot.c_str());
-			exit(1);
-		}
+		AppTypeDetector::Detector detector(*coreWrapperRegistry);
+		AppTypeDetector::Detector::Result detectorResult = detector.checkAppRoot(appRoot);
 
-		appType = result.wrapperRegistryEntry->language;
+		if (!detectorResult.appStartCommand.empty()) {
+			// This is a generic or Kuria app.
+			appStartCommand = detectorResult.appStartCommand;
+		} else {
+			// This is an auto-supported app.
+			if (coreConfig->get("single_app_mode_app_type").isNull()) {
+				if (detectorResult.isNull()) {
+					fprintf(stderr, "ERROR: unable to autodetect what kind of application "
+						"lives in %s. Please specify information about the app using "
+						"--app-type, --startup-file and --app-start-command, or specify a "
+						"correct location to the application you want to serve.\n"
+						"Type '" SHORT_PROGRAM_NAME " core --help' for more information.\n",
+						appRoot.c_str());
+					exit(1);
+				}
+				appType = detectorResult.wrapperRegistryEntry->language;
+			} else {
+				appType = coreConfig->get("single_app_mode_app_type").asString();
+			}
+		}
 	} else {
+		// This is an auto-supported app.
 		appType = coreConfig->get("single_app_mode_app_type").asString();
 	}
 
-	if (coreConfig->get("single_app_mode_startup_file").isNull()) {
-		const WrapperRegistry::Entry &entry = coreWrapperRegistry->lookup(appType);
-		if (entry.defaultStartupFiles.empty()) {
-			startupFile = appRoot + "/";
+	if (!appType.empty()) {
+		if (coreConfig->get("single_app_mode_startup_file").isNull()) {
+			const WrapperRegistry::Entry &entry = coreWrapperRegistry->lookup(appType);
+			if (entry.defaultStartupFiles.empty()) {
+				startupFile = appRoot + "/";
+			} else {
+				startupFile = appRoot + "/" + entry.defaultStartupFiles[0];
+			}
 		} else {
-			startupFile = appRoot + "/" + entry.defaultStartupFiles[0];
+			startupFile = coreConfig->get("single_app_mode_startup_file").asString();
+		}
+		if (!fileExists(startupFile)) {
+			fprintf(stderr, "ERROR: unable to find expected startup file %s."
+				" Please specify its correct path with --startup-file.\n",
+				startupFile.c_str());
+			exit(1);
 		}
-	} else {
-		startupFile = coreConfig->get("single_app_mode_startup_file").asString();
-	}
-	if (!fileExists(startupFile)) {
-		fprintf(stderr, "ERROR: unable to find expected startup file %s."
-			" Please specify its correct path with --startup-file.\n",
-			startupFile.c_str());
-		exit(1);
 	}
 
 	wo->singleAppModeConfig["app_root"] = appRoot;
-	wo->singleAppModeConfig["app_type"] = appType;
-	wo->singleAppModeConfig["startup_file"] = startupFile;
 
 	P_NOTICE(SHORT_PROGRAM_NAME " core running in single-application mode.");
-	P_NOTICE("Serving app     : " << appRoot);
-	P_NOTICE("App type        : " << appType);
-	P_NOTICE("App startup file: " << startupFile);
+	P_NOTICE("Serving app      : " << appRoot);
+	if (!appType.empty()) {
+		P_NOTICE("App type         : " << appType);
+		P_NOTICE("App startup file : " << startupFile);
+		wo->singleAppModeConfig["app_type"] = appType;
+		wo->singleAppModeConfig["startup_file"] = startupFile;
+	} else {
+		P_NOTICE("App start command: " << appStartCommand);
+		wo->singleAppModeConfig["app_start_command"] = appStartCommand;
+	}
 }
 
 static void
@@ -852,7 +882,6 @@ initializeSecurityUpdateChecker() {
 
 static void
 initializeTelemetryCollector() {
-	return; // disable for now
 	TRACE_POINT();
 	WorkingObjects &wo = *workingObjects;
 

data/src/agent/Core/OptionParser.h

@@ -109,6 +109,9 @@ coreUsage() {
 	printf("                            (single-app mode only)\n");
 	printf("      --startup-file PATH   The path of the app's startup file, relative to\n");
 	printf("                            the app root directory (single-app mode only)\n");
+	printf("      --app-start-command COMMAND\n");
+	printf("                            The command string with which to start the app\n");
+	printf("                            (single-app mode only)\n");
 	printf("      --spawn-method NAME   Spawn method to use. Can either be 'smart' or\n");
 	printf("                            'direct'. Default: %s\n", DEFAULT_SPAWN_METHOD);
 	printf("      --load-shell-envvars  Load shell startup files before loading application\n");
@@ -317,6 +320,9 @@ parseCoreOption(int argc, const char *argv[], int &i, Json::Value &updates) {
 	} else if (p.isValueFlag(argc, i, argv[i], '\0', "--startup-file")) {
 		updates["single_app_mode_startup_file"] = argv[i + 1];
 		i += 2;
+	} else if (p.isValueFlag(argc, i, argv[i], '\0', "--app-start-command")) {
+		updates["single_app_mode_app_start_command"] = argv[i + 1];
+		i += 2;
 	} else if (p.isValueFlag(argc, i, argv[i], '\0', "--spawn-method")) {
 		updates["default_spawn_method"] = argv[i + 1];
 		i += 2;

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

@@ -31,6 +31,7 @@
 
 #include <modp_b64.h>
 
+#include <AppLocalConfigFileUtils.h>
 #include <LoggingKit/Logging.h>
 #include <SystemTools/SystemTime.h>
 #include <Core/SpawningKit/Context.h>
@@ -79,8 +80,7 @@ protected:
 	void setConfigFromAppPoolOptions(Config *config, Json::Value &extraArgs,
 		const AppPoolOptions &options)
 	{
-		string startCommand = options.getStartCommand(*context->resourceLocator,
-			*context->wrapperRegistry);
+		TRACE_POINT();
 		string envvarsData;
 		try {
 			envvarsData = modp::b64_decode(options.environmentVariables.data(),
@@ -91,15 +91,30 @@ protected:
 			envvarsData.clear();
 		}
 
+		AppLocalConfig appLocalConfig = parseAppLocalConfigFile(options.appRoot);
+		string startCommand;
+
+		if (appLocalConfig.appSupportsKuriaProtocol) {
+			config->genericApp = false;
+			config->startsUsingWrapper = false;
+			config->startCommand = options.appStartCommand;
+		} else if (options.appType.empty()) {
+			config->genericApp = true;
+			config->startCommand = options.appStartCommand;
+		} else {
+			startCommand = options.getStartCommand(*context->resourceLocator,
+				*context->wrapperRegistry);
+			config->genericApp = false;
+			config->startsUsingWrapper = true;
+			config->startCommand = startCommand;
+		}
+
 		config->appGroupName = options.getAppGroupName();
 		config->appRoot = options.appRoot;
 		config->logLevel = options.logLevel;
-		config->genericApp = false;
-		config->startsUsingWrapper = true;
 		config->wrapperSuppliedByThirdParty = false;
 		config->findFreePort = false;
 		config->loadShellEnvvars = options.loadShellEnvvars;
-		config->startCommand = startCommand;
 		config->startupFile = options.getStartupFile(*context->wrapperRegistry);
 		config->appType = options.appType;
 		config->appEnv = options.environment;

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

@@ -98,8 +98,8 @@ prepareUserSwitching(const AppPoolOptions &options,
 
 	UPDATE_TRACE_POINT();
 	string defaultGroup;
-	string startupFile = absolutizePath(options.getStartupFile(wrapperRegistry),
-		absolutizePath(options.appRoot));
+	// This is the file that determines what user we lower privilege to.
+	string referenceFile;
 	struct passwd &pwd = info.lveUserPwd;
 	boost::shared_array<char> &pwdBuf = info.lveUserPwdStrBuf;
 	struct passwd *userInfo;
@@ -109,6 +109,13 @@ prepareUserSwitching(const AppPoolOptions &options,
 	boost::shared_array<char> grpBuf;
 	int ret;
 
+	if (options.appType.empty()) {
+		referenceFile = absolutizePath(options.appRoot);
+	} else {
+		referenceFile = absolutizePath(options.getStartupFile(wrapperRegistry),
+			absolutizePath(options.appRoot));
+	}
+
 	// _SC_GETPW_R_SIZE_MAX/_SC_GETGR_R_SIZE_MAX are not maximums:
 	// http://tomlee.co/2012/10/problems-with-large-linux-unix-groups-and-getgrgid_r-getgrnam_r/
 	pwdBufSize = std::max<long>(1024 * 128, sysconf(_SC_GETPW_R_SIZE_MAX));
@@ -158,9 +165,9 @@ prepareUserSwitching(const AppPoolOptions &options,
 		}
 	} else {
 		struct stat buf;
-		if (syscalls::lstat(startupFile.c_str(), &buf) == -1) {
+		if (syscalls::lstat(referenceFile.c_str(), &buf) == -1) {
 			int e = errno;
-			throw SystemException("Cannot lstat(\"" + startupFile +
+			throw SystemException("Cannot lstat(\"" + referenceFile +
 				"\")", e);
 		}
 		ret = getpwuid_r(buf.st_uid, &pwd, pwdBuf.get(),
@@ -187,10 +194,10 @@ prepareUserSwitching(const AppPoolOptions &options,
 		if (options.group == "!STARTUP_FILE!") {
 			struct stat buf;
 
-			if (syscalls::lstat(startupFile.c_str(), &buf) == -1) {
+			if (syscalls::lstat(referenceFile.c_str(), &buf) == -1) {
 				int e = errno;
 				throw SystemException("Cannot lstat(\"" +
-					startupFile + "\")", e);
+					referenceFile + "\")", e);
 			}
 
 			ret = getgrgid_r(buf.st_gid, &grp, grpBuf.get(), grpBufSize,