passenger 4.0.3 → 4.0.4

data/ext/apache2/Hooks.cpp

@@ -149,6 +149,24 @@ private:
 			return OK;
 		}
 	};
+
+	class ReportDocumentRootDeterminationError: public ErrorReport {
+	private:
+		DocumentRootDeterminationError e;
+	
+	public:
+		ReportDocumentRootDeterminationError(const DocumentRootDeterminationError &ex): e(ex) { }
+		
+		int report(request_rec *r) {
+			r->status = 500;
+			ap_set_content_type(r, "text/html; charset=UTF-8");
+			ap_rputs("<h1>Passenger error #1</h1>\n", r);
+			ap_rputs("Cannot determine the document root for the current request.", r);
+			P_ERROR("Cannot determine the document root for the current request.\n" <<
+				"  Backtrace:\n" << e.backtrace());
+			return OK;
+		}
+	};
 	
 	struct RequestNote {
 		DirectoryMapper mapper;
@@ -313,13 +331,6 @@ private:
 		return m_hasModXsendfile == YES;
 	}
 	
-	int reportDocumentRootDeterminationError(request_rec *r) {
-		ap_set_content_type(r, "text/html; charset=UTF-8");
-		ap_rputs("<h1>Passenger error #1</h1>\n", r);
-		ap_rputs("Cannot determine the document root for the current request.", r);
-		return OK;
-	}
-	
 	int reportBusyException(request_rec *r) {
 		ap_custom_response(r, HTTP_SERVICE_UNAVAILABLE,
 			"This website is too busy right now.  Please try again later.");
@@ -352,11 +363,17 @@ private:
 		
 		DirectoryMapper mapper(r, config, &cstat, config->getStatThrottleRate());
 		try {
-			if (mapper.getBaseURI() == NULL) {
+			if (mapper.getApplicationType() == PAT_NONE) {
 				// (B) is not true.
 				disableRequestNote(r);
 				return false;
 			}
+		} catch (const DocumentRootDeterminationError &e) {
+			auto_ptr<RequestNote> note(new RequestNote(mapper, config));
+			note->errorReport = new ReportDocumentRootDeterminationError(e);
+			apr_pool_userdata_set(note.release(), "Phusion Passenger",
+				RequestNote::cleanup, r->pool);
+			return true;
 		} catch (const FileSystemException &e) {
 			/* DirectoryMapper tried to examine the filesystem in order
 			 * to autodetect the application type (e.g. by checking whether
@@ -482,14 +499,11 @@ private:
 		TRACE_POINT();
 		DirConfig *config = note->config;
 		DirectoryMapper &mapper = note->mapper;
-		string publicDirectory, appRoot;
 		
 		try {
-			publicDirectory = mapper.getPublicDirectory();
-			if (publicDirectory.empty()) {
-				return reportDocumentRootDeterminationError(r);
-			}
-			appRoot = config->getAppRoot(publicDirectory.c_str());
+			mapper.getPublicDirectory();
+		} catch (const DocumentRootDeterminationError &e) {
+			return ReportDocumentRootDeterminationError(e).report(r);
 		} catch (const FileSystemException &e) {
 			/* The application root cannot be determined. This could
 			 * happen if, for example, the user specified 'RailsBaseURI /foo'
@@ -570,7 +584,7 @@ private:
 			requestData.reserve(3);
 			headerData.reserve(1024 * 2);
 			requestData.push_back(StaticString());
-			size = constructHeaders(r, config, requestData, mapper, appRoot, headerData);
+			size = constructHeaders(r, config, requestData, mapper, headerData);
 			requestData.push_back(",");
 			
 			ret = snprintf(sizeString, sizeof(sizeString) - 1, "%u:", size);
@@ -857,7 +871,7 @@ private:
 	}
 	
 	unsigned int constructHeaders(request_rec *r, DirConfig *config,
-		vector<StaticString> &requestData, DirectoryMapper &mapper, const string &appRoot,
+		vector<StaticString> &requestData, DirectoryMapper &mapper,
 		string &output)
 	{
 		const char *baseURI = mapper.getBaseURI();
@@ -920,7 +934,7 @@ private:
 			addHeader(output, "REQUEST_URI", request_uri);
 		}
 		
-		if (strcmp(baseURI, "/") == 0) {
+		if (baseURI == NULL) {
 			addHeader(output, "SCRIPT_NAME", "");
 			addHeader(output, "PATH_INFO", escapedUri);
 		} else {
@@ -953,8 +967,8 @@ private:
 		
 		// Phusion Passenger options.
 		addHeader(output, "PASSENGER_STATUS_LINE", "false");
-		addHeader(output, "PASSENGER_APP_ROOT", appRoot);
-		addHeader(output, "PASSENGER_APP_GROUP_NAME", config->getAppGroupName(appRoot));
+		addHeader(output, "PASSENGER_APP_ROOT", mapper.getAppRoot());
+		addHeader(output, "PASSENGER_APP_GROUP_NAME", config->getAppGroupName(mapper.getAppRoot()));
 		addHeader(output, "PASSENGER_RUBY", config->ruby ? config->ruby : serverConfig.defaultRuby);
 		addHeader(output, "PASSENGER_PYTHON", config->python);
 		addHeader(output, "PASSENGER_ENV", config->getEnvironment());

data/ext/common/AgentsStarter.cpp

@@ -33,13 +33,13 @@ using namespace boost;
 using namespace oxt;
 
 
-PSG_VariantMap *
-psg_variant_map_new() {
-	return (PSG_VariantMap *) new Passenger::VariantMap();
+PP_VariantMap *
+pp_variant_map_new() {
+	return (PP_VariantMap *) new Passenger::VariantMap();
 }
 
 void
-psg_variant_map_set(PSG_VariantMap *m,
+pp_variant_map_set(PP_VariantMap *m,
 	const char *name,
 	const char *value,
 	unsigned int value_len)
@@ -49,7 +49,7 @@ psg_variant_map_set(PSG_VariantMap *m,
 }
 
 void
-psg_variant_map_set2(PSG_VariantMap *m,
+pp_variant_map_set2(PP_VariantMap *m,
 	const char *name,
 	unsigned int name_len,
 	const char *value,
@@ -60,7 +60,7 @@ psg_variant_map_set2(PSG_VariantMap *m,
 }
 
 void
-psg_variant_map_set_int(PSG_VariantMap *m,
+pp_variant_map_set_int(PP_VariantMap *m,
 	const char *name,
 	int value)
 {
@@ -69,7 +69,7 @@ psg_variant_map_set_int(PSG_VariantMap *m,
 }
 
 void
-psg_variant_map_set_bool(PSG_VariantMap *m,
+pp_variant_map_set_bool(PP_VariantMap *m,
 	const char *name,
 	int value)
 {
@@ -78,7 +78,7 @@ psg_variant_map_set_bool(PSG_VariantMap *m,
 }
 
 void
-psg_variant_map_set_strset(PSG_VariantMap *m,
+pp_variant_map_set_strset(PP_VariantMap *m,
 	const char *name,
 	const char **strs,
 	unsigned int count)
@@ -93,21 +93,21 @@ psg_variant_map_set_strset(PSG_VariantMap *m,
 }
 
 void
-psg_variant_map_free(PSG_VariantMap *m) {
+pp_variant_map_free(PP_VariantMap *m) {
 	delete (Passenger::VariantMap *) m;
 }
 
 
-PSG_AgentsStarter *
-psg_agents_starter_new(PSG_AgentsStarterType type, char **error_message) {
-	return (PSG_AgentsStarter *) new Passenger::AgentsStarter(type);
+PP_AgentsStarter *
+pp_agents_starter_new(PP_AgentsStarterType type, char **error_message) {
+	return (PP_AgentsStarter *) new Passenger::AgentsStarter(type);
 }
 
 int
-psg_agents_starter_start(PSG_AgentsStarter *as,
+pp_agents_starter_start(PP_AgentsStarter *as,
 	const char *passengerRoot,
-	PSG_VariantMap *extraParams,
-	const PSG_AfterForkCallback afterFork,
+	PP_VariantMap *extraParams,
+	const PP_AfterForkCallback afterFork,
 	void *callbackArgument,
 	char **errorMessage)
 {
@@ -135,7 +135,7 @@ psg_agents_starter_start(PSG_AgentsStarter *as,
 }
 
 const char *
-psg_agents_starter_get_request_socket_filename(PSG_AgentsStarter *as, unsigned int *size) {
+pp_agents_starter_get_request_socket_filename(PP_AgentsStarter *as, unsigned int *size) {
 	Passenger::AgentsStarter *agentsStarter = (Passenger::AgentsStarter *) as;
 	if (size != NULL) {
 		*size = agentsStarter->getRequestSocketFilename().size();
@@ -144,7 +144,7 @@ psg_agents_starter_get_request_socket_filename(PSG_AgentsStarter *as, unsigned i
 }
 
 const char *
-psg_agents_starter_get_request_socket_password(PSG_AgentsStarter *as, unsigned int *size) {
+pp_agents_starter_get_request_socket_password(PP_AgentsStarter *as, unsigned int *size) {
 	Passenger::AgentsStarter *agentsStarter = (Passenger::AgentsStarter *) as;
 	if (size != NULL) {
 		*size = agentsStarter->getRequestSocketPassword().size();
@@ -153,31 +153,31 @@ psg_agents_starter_get_request_socket_password(PSG_AgentsStarter *as, unsigned i
 }
 
 const char *
-psg_agents_starter_get_server_instance_dir(PSG_AgentsStarter *as) {
+pp_agents_starter_get_server_instance_dir(PP_AgentsStarter *as) {
 	Passenger::AgentsStarter *agentsStarter = (Passenger::AgentsStarter *) as;
 	return agentsStarter->getServerInstanceDir()->getPath().c_str();
 }
 
 const char *
-psg_agents_starter_get_generation_dir(PSG_AgentsStarter *as) {
+pp_agents_starter_get_generation_dir(PP_AgentsStarter *as) {
 	Passenger::AgentsStarter *agentsStarter = (Passenger::AgentsStarter *) as;
 	return agentsStarter->getGeneration()->getPath().c_str();
 }
 
 pid_t
-psg_agents_starter_get_pid(PSG_AgentsStarter *as) {
+pp_agents_starter_get_pid(PP_AgentsStarter *as) {
 	Passenger::AgentsStarter *agentsStarter = (Passenger::AgentsStarter *) as;
 	return agentsStarter->getPid();
 }
 
 void
-psg_agents_starter_detach(PSG_AgentsStarter *as) {
+pp_agents_starter_detach(PP_AgentsStarter *as) {
 	Passenger::AgentsStarter *agentsStarter = (Passenger::AgentsStarter *) as;
 	agentsStarter->detach();
 }
 
 void
-psg_agents_starter_free(PSG_AgentsStarter *as) {
+pp_agents_starter_free(PP_AgentsStarter *as) {
 	Passenger::AgentsStarter *agentsStarter = (Passenger::AgentsStarter *) as;
 	delete agentsStarter;
 }

data/ext/common/AgentsStarter.h

@@ -36,49 +36,49 @@
 typedef enum {
 	AS_APACHE,
 	AS_NGINX
-} PSG_AgentsStarterType;
+} PP_AgentsStarterType;
 
-typedef void PSG_AgentsStarter;
-typedef void PSG_VariantMap;
-typedef void (*PSG_AfterForkCallback)(void *);
+typedef void PP_AgentsStarter;
+typedef void PP_VariantMap;
+typedef void (*PP_AfterForkCallback)(void *);
 
-PSG_VariantMap *psg_variant_map_new();
-void psg_variant_map_set(PSG_VariantMap *m,
+PP_VariantMap *pp_variant_map_new();
+void pp_variant_map_set(PP_VariantMap *m,
 	const char *name,
 	const char *value,
 	unsigned int value_len);
-void psg_variant_map_set2(PSG_VariantMap *m,
+void pp_variant_map_set2(PP_VariantMap *m,
 	const char *name,
 	unsigned int name_len,
 	const char *value,
 	unsigned int value_len);
-void psg_variant_map_set_int(PSG_VariantMap *m,
+void pp_variant_map_set_int(PP_VariantMap *m,
 	const char *name,
 	int value);
-void psg_variant_map_set_bool(PSG_VariantMap *m,
+void pp_variant_map_set_bool(PP_VariantMap *m,
 	const char *name,
 	int value);
-void psg_variant_map_set_strset(PSG_VariantMap *m,
+void pp_variant_map_set_strset(PP_VariantMap *m,
 	const char *name,
 	const char **strs,
 	unsigned int count);
-void psg_variant_map_free(PSG_VariantMap *m);
+void pp_variant_map_free(PP_VariantMap *m);
 
-PSG_AgentsStarter *psg_agents_starter_new(PSG_AgentsStarterType type,
+PP_AgentsStarter *pp_agents_starter_new(PP_AgentsStarterType type,
 	char **error_message);
-int psg_agents_starter_start(PSG_AgentsStarter *as,
+int pp_agents_starter_start(PP_AgentsStarter *as,
 	const char *passengerRoot,
-	PSG_VariantMap *params,
-	const PSG_AfterForkCallback afterFork,
+	PP_VariantMap *params,
+	const PP_AfterForkCallback afterFork,
 	void *callbackArgument,
 	char **errorMessage);
-const char *psg_agents_starter_get_request_socket_filename(PSG_AgentsStarter *as, unsigned int *size);
-const char *psg_agents_starter_get_request_socket_password(PSG_AgentsStarter *as, unsigned int *size);
-const char *psg_agents_starter_get_server_instance_dir(PSG_AgentsStarter *as);
-const char *psg_agents_starter_get_generation_dir(PSG_AgentsStarter *as);
-pid_t       psg_agents_starter_get_pid(PSG_AgentsStarter *as);
-void        psg_agents_starter_detach(PSG_AgentsStarter *as);
-void        psg_agents_starter_free(PSG_AgentsStarter *as);
+const char *pp_agents_starter_get_request_socket_filename(PP_AgentsStarter *as, unsigned int *size);
+const char *pp_agents_starter_get_request_socket_password(PP_AgentsStarter *as, unsigned int *size);
+const char *pp_agents_starter_get_server_instance_dir(PP_AgentsStarter *as);
+const char *pp_agents_starter_get_generation_dir(PP_AgentsStarter *as);
+pid_t       pp_agents_starter_get_pid(PP_AgentsStarter *as);
+void        pp_agents_starter_detach(PP_AgentsStarter *as);
+void        pp_agents_starter_free(PP_AgentsStarter *as);
 
 #ifdef __cplusplus
 	} /* extern "C" */
@@ -121,7 +121,7 @@ using namespace oxt;
  */
 class AgentsStarter {
 private:
-	PSG_AgentsStarterType type;
+	PP_AgentsStarterType type;
 
 	/** The watchdog's PID. Equals 0 if the watchdog hasn't been started yet
 	 * or if detach() is called. */
@@ -288,7 +288,7 @@ public:
 	 *
 	 * @param type Whether one wants to start the Apache or the Nginx helper agent.
 	 */
-	AgentsStarter(PSG_AgentsStarterType type) {
+	AgentsStarter(PP_AgentsStarterType type) {
 		this->type = type;
 		pid = 0;
 	}
@@ -329,7 +329,7 @@ public:
 	/**
 	 * Returns the type as was passed to the constructor.
 	 */
-	PSG_AgentsStarterType getType() const {
+	PP_AgentsStarterType getType() const {
 		return type;
 	}
 	

data/ext/common/ApplicationPool2/AppTypes.cpp

@@ -42,18 +42,18 @@ const AppTypeDefinition appTypeDefinitions[] = {
 using namespace Passenger;
 using namespace Passenger::ApplicationPool2;
 
-PassengerAppTypeDetector *
-passenger_app_type_detector_new() {
+PP_AppTypeDetector *
+pp_app_type_detector_new() {
 	return new AppTypeDetector();
 }
 
 void
-passenger_app_type_detector_free(PassengerAppTypeDetector *detector) {
+pp_app_type_detector_free(PP_AppTypeDetector *detector) {
 	delete (AppTypeDetector *) detector;
 }
 
 PassengerAppType
-passenger_app_type_detector_check_document_root(PassengerAppTypeDetector *_detector,
+pp_app_type_detector_check_document_root(PP_AppTypeDetector *_detector,
 	const char *documentRoot, unsigned int len, int resolveFirstSymlink)
 {
 	AppTypeDetector *detector = (AppTypeDetector *) _detector;
@@ -61,7 +61,7 @@ passenger_app_type_detector_check_document_root(PassengerAppTypeDetector *_detec
 }
 
 PassengerAppType
-passenger_app_type_detector_check_app_root(PassengerAppTypeDetector *_detector,
+pp_app_type_detector_check_app_root(PP_AppTypeDetector *_detector,
 	const char *appRoot, unsigned int len)
 {
 	AppTypeDetector *detector = (AppTypeDetector *) _detector;
@@ -69,6 +69,6 @@ passenger_app_type_detector_check_app_root(PassengerAppTypeDetector *_detector,
 }
 
 const char *
-passenger_get_app_type_name(PassengerAppType type) {
+pp_get_app_type_name(PassengerAppType type) {
 	return getAppTypeName(type);
 }

data/ext/common/ApplicationPool2/AppTypes.h

@@ -25,6 +25,15 @@
 #ifndef _PASSENGER_APPLICATION_POOL2_APP_TYPES_H_
 #define _PASSENGER_APPLICATION_POOL2_APP_TYPES_H_
 
+/**
+ * Application type registry
+ *
+ * All supported application types (e.g. Rack, classic Rails, WSGI, etc)
+ * are registered here. The AppTypeDetector is responsible for checking
+ * what kind of application lives under the given directory.
+ */
+
+
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
@@ -36,16 +45,16 @@ typedef enum {
 	PAT_NONE
 } PassengerAppType;
 
-typedef void PassengerAppTypeDetector;
+typedef void PP_AppTypeDetector;
 
-PassengerAppTypeDetector *passenger_app_type_detector_new();
-void passenger_app_type_detector_free(PassengerAppTypeDetector *detector);
-PassengerAppType passenger_app_type_detector_check_document_root(PassengerAppTypeDetector *detector,
+PP_AppTypeDetector *pp_app_type_detector_new();
+void pp_app_type_detector_free(PP_AppTypeDetector *detector);
+PassengerAppType pp_app_type_detector_check_document_root(PP_AppTypeDetector *detector,
 	const char *documentRoot, unsigned int len, int resolveFirstSymlink);
-PassengerAppType passenger_app_type_detector_check_app_root(PassengerAppTypeDetector *detector,
+PassengerAppType pp_app_type_detector_check_app_root(PP_AppTypeDetector *detector,
 	const char *appRoot, unsigned int len);
 
-const char *passenger_get_app_type_name(PassengerAppType type);
+const char *pp_get_app_type_name(PassengerAppType type);
 
 #ifdef __cplusplus
 }
@@ -56,6 +65,7 @@ const char *passenger_get_app_type_name(PassengerAppType type);
 #include <oxt/macros.hpp>
 #include <oxt/backtrace.hpp>
 #include <cstdlib>
+#include <string>
 #include <Logging.h>
 #include <StaticString.h>
 #include <Utils.h>
@@ -65,6 +75,8 @@ const char *passenger_get_app_type_name(PassengerAppType type);
 namespace Passenger {
 namespace ApplicationPool2 {
 
+using namespace std;
+
 
 struct AppTypeDefinition {
 	const PassengerAppType type;
@@ -114,18 +126,58 @@ public:
 		}
 	}
 
-	PassengerAppType checkDocumentRoot(const StaticString &documentRoot, bool resolveFirstSymlink = false) {
+	/**
+	 * Given a web server document root (that is, some subdirectory under the
+	 * application root, e.g. "/webapps/foobar/public"), returns the type of
+	 * application that lives there. Returns PAT_NONE if it wasn't able to detect
+	 * a supported application type.
+	 *
+	 * If `resolveFirstSymlink` is given, and `documentRoot` is a symlink, then
+	 * this function will check the parent directory
+	 * of the directory that the symlink points to (i.e. `resolve(documentRoot) + "/.."`),
+	 * instead of checking the directory that the symlink is located in (i.e.
+	 * `dirname(documentRoot)`).
+	 *
+	 * If `appRoot` is non-NULL, then the inferred application root will be stored here.
+	 *
+	 * @throws FileSystemException Unable to check because of a filesystem error.
+	 * @throws TimeRetrievalException
+	 * @throws boost::thread_interrupted
+	 */
+	PassengerAppType checkDocumentRoot(const StaticString &documentRoot,
+		bool resolveFirstSymlink = false,
+		string *appRoot = NULL)
+	{
 		if (!resolveFirstSymlink) {
-			return checkAppRoot(extractDirNameStatic(documentRoot));
+			if (appRoot != NULL) {
+				*appRoot = extractDirNameStatic(documentRoot);
+				return checkAppRoot(*appRoot);
+			} else {
+				return checkAppRoot(extractDirNameStatic(documentRoot));
+			}
 		} else {
 			char ntDocRoot[documentRoot.size() + 1];
 			memcpy(ntDocRoot, documentRoot.data(), documentRoot.size());
 			ntDocRoot[documentRoot.size()] = '\0';
 			string resolvedDocumentRoot = resolveSymlink(ntDocRoot);
-			return checkAppRoot(extractDirNameStatic(resolvedDocumentRoot));
+			if (appRoot != NULL) {
+				*appRoot = extractDirNameStatic(resolvedDocumentRoot);
+				return checkAppRoot(*appRoot);
+			} else {
+				return checkAppRoot(extractDirNameStatic(resolvedDocumentRoot));
+			}
 		}
 	}
 
+	/**
+	 * Returns the type of application that lives under the application
+	 * directory `appRoot`. Returns PAT_NONE if it wasn't able to detect
+	 * a supported application type.
+	 *
+	 * @throws FileSystemException Unable to check because of a filesystem error.
+	 * @throws TimeRetrievalException
+	 * @throws boost::thread_interrupted
+	 */
 	PassengerAppType checkAppRoot(const StaticString &appRoot) {
 		char buf[appRoot.size() + 32];
 		const char *end = buf + appRoot.size() + 32;