passenger 4.0.3 → 4.0.4

data/doc/Users guide Nginx.html

@@ -4181,7 +4181,7 @@ passenger_pre_start http://bar.com:3500/;      # &lt;--- added</pre>
     listen 80;
     server_name myblog.com;
     root /webapps/wordpress;
-    rails_base_uri /store;
+    passenger_base_uri /store;
 }</pre>
 </div>
 </div>
@@ -4192,7 +4192,7 @@ passenger_pre_start http://bar.com:3500/;      # &lt;--- added</pre>
     listen 80;
     server_name myblog.com;
     root /webapps/wordpress;
-    rails_base_uri /store;
+    passenger_base_uri /store;
 }
 
 passenger_pre_start http://myblog.com/store;    # &lt;----- added</pre>

data/doc/Users guide Nginx.txt

@@ -1381,7 +1381,7 @@ server {
     listen 80;
     server_name myblog.com;
     root /webapps/wordpress;
-    rails_base_uri /store;
+    passenger_base_uri /store;
 }
 ---------------------------
 
@@ -1392,7 +1392,7 @@ server {
     listen 80;
     server_name myblog.com;
     root /webapps/wordpress;
-    rails_base_uri /store;
+    passenger_base_uri /store;
 }
 
 passenger_pre_start http://myblog.com/store;    # <----- added

data/ext/apache2/Configuration.cpp

@@ -220,13 +220,9 @@ passenger_config_merge_dir(apr_pool_t *p, void *basev, void *addv) {
 	
 	config->enabled = (add->enabled == DirConfig::UNSET) ? base->enabled : add->enabled;
 	
-	config->railsBaseURIs = base->railsBaseURIs;
-	for (set<string>::const_iterator it(add->railsBaseURIs.begin()); it != add->railsBaseURIs.end(); it++) {
-		config->railsBaseURIs.insert(*it);
-	}
-	config->rackBaseURIs = base->rackBaseURIs;
-	for (set<string>::const_iterator it(add->rackBaseURIs.begin()); it != add->rackBaseURIs.end(); it++) {
-		config->rackBaseURIs.insert(*it);
+	config->baseURIs = base->baseURIs;
+	for (set<string>::const_iterator it(add->baseURIs.begin()); it != add->baseURIs.end(); it++) {
+		config->baseURIs.insert(*it);
 	}
 	
 	MERGE_STR_CONFIG(ruby);
@@ -338,6 +334,21 @@ cmd_passenger_spawn_method(cmd_parms *cmd, void *pcfg, const char *arg) {
 	return NULL;
 }
 
+static const char *
+cmd_passenger_base_uri(cmd_parms *cmd, void *pcfg, const char *arg) {
+	DirConfig *config = (DirConfig *) pcfg;
+	if (strlen(arg) == 0) {
+		return "PassengerBaseURI may not be set to the empty string";
+	} else if (arg[0] != '/') {
+		return "PassengerBaseURI must start with a slash (/)";
+	} else if (strlen(arg) > 1 && arg[strlen(arg) - 1] == '/') {
+		return "PassengerBaseURI must not end with a slash (/)";
+	} else {
+		config->baseURIs.insert(arg);
+		return NULL;
+	}
+}
+
 static const char *
 cmd_union_station_filter(cmd_parms *cmd, void *pcfg, const char *arg) {
 	DirConfig *config = (DirConfig *) pcfg;
@@ -358,26 +369,9 @@ cmd_union_station_filter(cmd_parms *cmd, void *pcfg, const char *arg) {
 
 
 /*************************************************
- * Rails-specific settings
+ * Rack-specific settings
  *************************************************/
 
-static const char *
-cmd_rails_base_uri(cmd_parms *cmd, void *pcfg, const char *arg) {
-	DirConfig *config = (DirConfig *) pcfg;
-	if (strlen(arg) == 0) {
-		return "RailsBaseURI may not be set to the empty string";
-	} else if (arg[0] != '/') {
-		return "RailsBaseURI must start with a slash (/)";
-	} else if (strlen(arg) > 1 && arg[strlen(arg) - 1] == '/') {
-		return "RailsBaseURI must not end with a slash (/)";
-	} else {
-		config->railsBaseURIs.insert(arg);
-		return NULL;
-	}
-}
-
-
-
 static const char *
 cmd_passenger_max_preloader_idle_time(cmd_parms *cmd, void *pcfg, const char *arg) {
 	DirConfig *config = (DirConfig *) pcfg;
@@ -396,33 +390,6 @@ cmd_passenger_max_preloader_idle_time(cmd_parms *cmd, void *pcfg, const char *ar
 }
 
 
-/*************************************************
- * Rack-specific settings
- *************************************************/
-
-static const char *
-cmd_rack_base_uri(cmd_parms *cmd, void *pcfg, const char *arg) {
-	DirConfig *config = (DirConfig *) pcfg;
-	if (strlen(arg) == 0) {
-		return "RackBaseURI may not be set to the empty string";
-	} else if (arg[0] != '/') {
-		return "RackBaseURI must start with a slash (/)";
-	} else if (strlen(arg) > 1 && arg[strlen(arg) - 1] == '/') {
-		return "RackBaseURI must not end with a slash (/)";
-	} else {
-		config->rackBaseURIs.insert(arg);
-		return NULL;
-	}
-}
-
-
-/*************************************************
- * WSGI-specific settings
- *************************************************/
-
-// none
-
-
 /*************************************************
  * Obsolete settings
  *************************************************/
@@ -624,6 +591,11 @@ const command_rec passenger_commands[] = {
 		NULL,
 		RSRC_CONF,
 		"The spawn method to use."),
+	AP_INIT_TAKE1("PassengerBaseURI",
+		(Take1Func) cmd_passenger_base_uri,
+		NULL,
+		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
+		"Declare the given base URI as belonging to an application."),
 	AP_INIT_TAKE1("PassengerMaxPreloaderIdleTime",
 		(Take1Func) cmd_passenger_max_preloader_idle_time,
 		NULL,
@@ -713,11 +685,6 @@ const command_rec passenger_commands[] = {
 		"The number of threads that Phusion Passenger should spawn per application."),
 
 	// Rails-specific settings.
-	AP_INIT_TAKE1("RailsBaseURI",
-		(Take1Func) cmd_rails_base_uri,
-		NULL,
-		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
-		"Reserve the given URI to a Rails application."),
 	AP_INIT_TAKE1("RailsEnv",
 		(Take1Func) cmd_environment,
 		NULL,
@@ -725,11 +692,6 @@ const command_rec passenger_commands[] = {
 		"The environment under which a Rails app must run."),
 	
 	// Rack-specific settings.
-	AP_INIT_TAKE1("RackBaseURI",
-		(Take1Func) cmd_rack_base_uri,
-		NULL,
-		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
-		"Reserve the given URI to a Rack application."),
 	AP_INIT_TAKE1("RackEnv",
 		(Take1Func) cmd_environment,
 		NULL,
@@ -784,6 +746,16 @@ const command_rec passenger_commands[] = {
 		NULL,
 		RSRC_CONF,
 		"Deprecated option."),
+	AP_INIT_TAKE1("RailsBaseURI",
+		(Take1Func) cmd_passenger_base_uri,
+		NULL,
+		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
+		"Deprecated option."),
+	AP_INIT_TAKE1("RackBaseURI",
+		(Take1Func) cmd_passenger_base_uri,
+		NULL,
+		OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
+		"Deprecated option."),
 
 	// Obsolete options.
 	AP_INIT_TAKE1("RailsSpawnServer",

data/ext/apache2/Configuration.hpp

@@ -66,8 +66,7 @@ struct DirConfig {
 	
 	Threeway enabled;
 	
-	std::set<std::string> railsBaseURIs;
-	std::set<std::string> rackBaseURIs;
+	std::set<std::string> baseURIs;
 	
 	/** The Ruby interpreter to use. */
 	const char *ruby;
@@ -189,18 +188,6 @@ struct DirConfig {
 		return enabled != DISABLED;
 	}
 	
-	string getAppRoot(const StaticString &documentRoot) const {
-		if (appRoot == NULL) {
-			if (resolveSymlinksInDocRoot == DirConfig::ENABLED) {
-				return extractDirName(resolveSymlink(documentRoot));
-			} else {
-				return extractDirName(documentRoot);
-			}
-		} else {
-			return appRoot;
-		}
-	}
-	
 	StaticString getUser() const {
 		if (user != NULL) {
 			return user;

data/ext/apache2/DirectoryMapper.h

@@ -1,6 +1,6 @@
 /*
  *  Phusion Passenger - https://www.phusionpassenger.com/
- *  Copyright (c) 2010 Phusion
+ *  Copyright (c) 2010-2013 Phusion
  *
  *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
@@ -47,6 +47,17 @@ using namespace std;
 using namespace oxt;
 using namespace Passenger::ApplicationPool2;
 
+
+class DocumentRootDeterminationError: public oxt::tracable_exception {
+private:
+	string msg;
+public:
+	DocumentRootDeterminationError(const string &message): msg(message) {}
+	virtual ~DocumentRootDeterminationError() throw() {}
+	virtual const char *what() const throw() { return msg.c_str(); }
+};
+
+
 /**
  * Utility class for determining URI-to-application directory mappings.
  * Given a URI, it will determine whether that URI belongs to a Phusion
@@ -61,11 +72,94 @@ private:
 	DirConfig *config;
 	request_rec *r;
 	CachedFileStat *cstat;
-	unsigned int throttleRate;
-	bool baseURIKnown;
 	const char *baseURI;
-	PassengerAppType appType;
+	string publicDir;
+	string appRoot;
+	unsigned int throttleRate;
+	PassengerAppType appType: 7;
+	bool autoDetectionDone: 1;
 	
+	const char *findBaseURI() const {
+		set<string>::const_iterator it, end = config->baseURIs.end();
+		const char *uri = r->uri;
+		size_t uri_len = strlen(uri);
+
+		for (it = config->baseURIs.begin(); it != end; it++) {
+			const string &base = *it;
+
+			if (base == "/") {
+                /* Ignore 'PassengerBaseURI /' options. Users usually
+                 * specify this out of ignorance.
+                 */
+                continue;
+            }
+
+			if (  base == "/"
+			 || ( uri_len == base.size() && memcmp(uri, base.c_str(), uri_len) == 0 )
+			 || ( uri_len  > base.size() && memcmp(uri, base.c_str(), base.size()) == 0
+			                             && uri[base.size()] == '/' )
+			) {
+				return base.c_str();
+			}
+		}
+		return NULL;
+	}
+
+	/**
+	 * @throws FileSystemException An error occured while examening the filesystem.
+	 * @throws DocumentRootDeterminationError Unable to query the location of the document root.
+	 * @throws TimeRetrievalException
+	 * @throws boost::thread_interrupted
+	 */
+	void autoDetect() {
+		if (autoDetectionDone) {
+			return;
+		}
+
+		TRACE_POINT();
+
+		/* Determine the document root without trailing slashes. */
+		StaticString docRoot = ap_document_root(r);
+		if (docRoot.size() > 1 && docRoot[docRoot.size() - 1] == '/') {
+			docRoot = docRoot.substr(0, docRoot.size() - 1);
+		}
+		if (docRoot.empty()) {
+			throw DocumentRootDeterminationError("Cannot determine the document root");
+		}
+
+		/* Find the base URI for this web application, if any. */
+		const char *baseURI = findBaseURI();
+		if (baseURI != NULL) {
+			/* We infer that the 'public' directory of the web application
+			 * is document root + base URI.
+			 */
+			publicDir = docRoot + baseURI;
+		} else {
+			/* No base URI directives are applicable for this request. So assume that
+			 * the web application's public directory is the document root.
+			 */
+			publicDir = docRoot;
+		}
+
+		UPDATE_TRACE_POINT();
+		AppTypeDetector detector(cstat, throttleRate);
+		PassengerAppType appType;
+		string appRoot;
+		if (config->appRoot == NULL) {
+			appType = detector.checkDocumentRoot(publicDir,
+				baseURI != NULL || config->resolveSymlinksInDocRoot == DirConfig::ENABLED,
+				&appRoot);
+		} else {
+			appRoot = config->appRoot;
+			appType = detector.checkAppRoot(appRoot);
+		}
+
+		this->appRoot = appRoot;
+		this->baseURI = baseURI;
+		this->appType = appType;
+		autoDetectionDone = true;
+	}
+
 public:
 	/**
 	 * Create a new DirectoryMapper object.
@@ -82,131 +176,66 @@ public:
 		this->cstat = cstat;
 		this->throttleRate = throttleRate;
 		appType = PAT_NONE;
-		baseURIKnown = false;
 		baseURI = NULL;
+		autoDetectionDone = false;
 	}
 	
 	/**
-	 * Determine whether the given HTTP request falls under one of the specified
-	 * RailsBaseURIs or RackBaseURIs. If yes, then the first matching base URI will
-	 * be returned.
-	 *
-	 * If the document root seems to be a valid application 'public' folder, then this
-	 * method will return "/".
-	 *
+	 * Determines whether the given HTTP request falls under one of the specified
+	 * PassengerBaseURIs. If yes, then the first matching base URI will be returned.
 	 * Otherwise, NULL will be returned.
 	 *
-	 * @throws FileSystemException This method might also examine the filesystem in
-	 *            order to detect the application's type. During that process, a
-	 *            FileSystemException might be thrown.
+	 * @throws FileSystemException An error occured while examening the filesystem.
+	 * @throws DocumentRoot
+	 * @throws TimeRetrievalException
+	 * @throws boost::thread_interrupted
 	 * @warning The return value may only be used as long as <tt>config</tt>
 	 *          hasn't been destroyed.
 	 */
 	const char *getBaseURI() {
 		TRACE_POINT();
-		if (baseURIKnown) {
-			return baseURI;
-		}
-		
-		set<string>::const_iterator it;
-		const char *uri = r->uri;
-		size_t uri_len = strlen(uri);
-		
-		if (uri_len == 0 || uri[0] != '/') {
-			baseURIKnown = true;
-			return NULL;
-		}
-		
-		UPDATE_TRACE_POINT();
-		for (it = config->railsBaseURIs.begin(); it != config->railsBaseURIs.end(); it++) {
-			const string &base(*it);
-			if (  base == "/"
-			 || ( uri_len == base.size() && memcmp(uri, base.c_str(), uri_len) == 0 )
-			 || ( uri_len  > base.size() && memcmp(uri, base.c_str(), base.size()) == 0
-			                             && uri[base.size()] == '/' )
-			) {
-				baseURIKnown = true;
-				baseURI = base.c_str();
-				appType = PAT_CLASSIC_RAILS;
-				return baseURI;
-			}
-		}
-		
-		UPDATE_TRACE_POINT();
-		for (it = config->rackBaseURIs.begin(); it != config->rackBaseURIs.end(); it++) {
-			const string &base(*it);
-			if (  base == "/"
-			 || ( uri_len == base.size() && memcmp(uri, base.c_str(), uri_len) == 0 )
-			 || ( uri_len  > base.size() && memcmp(uri, base.c_str(), base.size()) == 0
-			                             && uri[base.size()] == '/' )
-			) {
-				baseURIKnown = true;
-				baseURI = base.c_str();
-				appType = PAT_RACK;
-				return baseURI;
-			}
-		}
-		
-		UPDATE_TRACE_POINT();
-		baseURIKnown = true;
-		AppTypeDetector detector(cstat, throttleRate);
-		appType = detector.checkAppRoot(config->getAppRoot(ap_document_root(r)));
-		if (appType != PAT_NONE) {
-			baseURI = "/";
-		} else {
-			baseURI = NULL;
-		}
+		autoDetect();
 		return baseURI;
 	}
 	
 	/**
-	 * Returns the filename of the 'public' directory of the Rails/Rack application
+	 * Returns the filename of the 'public' directory of the application
 	 * that's associated with the HTTP request.
 	 *
-	 * Returns an empty string if the document root of the HTTP request
-	 * cannot be determined, or if it isn't a valid folder.
-	 *
 	 * @throws FileSystemException An error occured while examening the filesystem.
+	 * @throws DocumentRootDeterminationError Unable to query the location of the document root.
+	 * @throws TimeRetrievalException
+	 * @throws boost::thread_interrupted
 	 */
 	string getPublicDirectory() {
-		if (!baseURIKnown) {
-			getBaseURI();
-		}
-		if (baseURI == NULL) {
-			return "";
-		}
-		
-		const char *docRoot = ap_document_root(r);
-		size_t len = strlen(docRoot);
-		if (len > 0) {
-			string path;
-			if (docRoot[len - 1] == '/') {
-				path.assign(docRoot, len - 1);
-			} else {
-				path.assign(docRoot, len);
-			}
-			if (strcmp(baseURI, "/") != 0) {
-				/* Application is deployed in a sub-URI.
-				 * This is probably a symlink, so let's resolve it.
-				 */
-				path.append(baseURI);
-				path = resolveSymlink(path);
-			}
-			return path;
-		} else {
-			return "";
-		}
+		autoDetect();
+		return publicDir;
+	}
+
+	/**
+	 * Returns the application root, or the empty string if this request does not
+	 * belong to an application.
+	 *
+	 * @throws FileSystemException An error occured while examening the filesystem.
+	 * @throws DocumentRootDeterminationError Unable to query the location of the document root.
+	 * @throws TimeRetrievalException
+	 * @throws boost::thread_interrupted
+	 */
+	string getAppRoot() {
+		autoDetect();
+		return appRoot;
 	}
 	
 	/**
 	 * Returns the application type that's associated with the HTTP request.
 	 *
 	 * @throws FileSystemException An error occured while examening the filesystem.
+	 * @throws DocumentRootDeterminationError Unable to query the location of the document root.
+	 * @throws TimeRetrievalException
+	 * @throws boost::thread_interrupted
 	 */
 	PassengerAppType getApplicationType() {
-		if (!baseURIKnown) {
-			getBaseURI();
-		}
+		autoDetect();
 		return appType;
 	}
 	
@@ -215,11 +244,12 @@ public:
 	 * with the HTTP request.
 	 *
 	 * @throws FileSystemException An error occured while examening the filesystem.
+	 * @throws DocumentRootDeterminationError Unable to query the location of the document root.
+	 * @throws TimeRetrievalException
+	 * @throws boost::thread_interrupted
 	 */
 	const char *getApplicationTypeName() {
-		if (!baseURIKnown) {
-			getBaseURI();
-		}
+		autoDetect();
 		return getAppTypeName(appType);
 	}
 };