[packages/passenger.git] / alias+public.patch


http://code.google.com/p/phusion-passenger/issues/detail?id=30&colspec=ID%20Type%20Status%20Priority%20Milestone%20Stars%20Summary
http://code.google.com/p/phusion-passenger/issues/detail?id=136&colspec=ID%20Type%20Status%20Priority%20Milestone%20Stars%20Summary

Problem: The problem with RailsBaseURI is that it expects Rails directory
to be in virtualhost's documentroot. If it does'nt then you have to create
symlink to use rails application outside of document root.

Fix: Instead of creating symlinks there could be second optional argument
for RailsBaseURI which specifies full path to Rails application's public
directory.

For example, instead of creating symlink /var/www/somehost/railsapp1 ->
/home/user/railsapp1/public and:
<virtualhost *>
DocumentRoot /var/www/somehost
RailsBaseURI /railsapp1
</virtualhost>

we skip the symlink and specify the full path in apache conf:
<virtualhost *>
DocumentRoot /var/www/somehost
RailsBaseURI /railsapp1 /home/user/railsapp1/public
</virtualhost>

The patch (for 2.0.3) that does the thing is attached (patches also
RackBaseURI).

The combined patch:

1) Aliases and rewrite rules now apply when translating RailsBaseURI into
physical path. Resolved paths are cached.
2) Current behaviour remains: DocumentRoot+RailsBaseURI works also
3) If RailsBaseURI or RackBaseURI has second argument then this second argument
is used as physical path to rails public directory. This eliminates the need
for extra lookup using Apache subrequest and the overhead caused by it.

diff -wur ext/apache2/Configuration.cpp ext/apache2/Configuration.cpp
--- ext/apache2/Configuration.cpp	2008-08-09 15:19:15.000000000 +0300
+++ ext/apache2/Configuration.cpp	2008-09-23 22:06:15.000000000 +0300
@@ -75,11 +75,11 @@
 	DirConfig *add = (DirConfig *) addv;
 	
 	config->railsBaseURIs = base->railsBaseURIs;
-	for (set<string>::const_iterator it(add->railsBaseURIs.begin()); it != add->railsBaseURIs.end(); it++) {
+	for (set<BaseURIConfig*>::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++) {
+	for (set<BaseURIConfig*>::const_iterator it(add->rackBaseURIs.begin()); it != add->rackBaseURIs.end(); it++) {
 		config->rackBaseURIs.insert(*it);
 	}
 	
@@ -275,18 +275,27 @@
  *************************************************/
 
 static const char *
-cmd_rails_base_uri(cmd_parms *cmd, void *pcfg, const char *arg) {
+cmd_rails_base_uri(cmd_parms *cmd, void *pcfg, const char *arg, const char *arg2) {
 	DirConfig *config = (DirConfig *) pcfg;
+	BaseURIConfig *bConfig = new BaseURIConfig;
 	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;
 	}
+
+	apr_pool_cleanup_register(cmd->pool, bConfig, destroy_config_struct<BaseURIConfig>, apr_pool_cleanup_null);
+
+	bConfig->baseURI = arg;
+
+	if (arg2) {
+	    bConfig->publicDirectory = arg2;
+	}
+
+	config->railsBaseURIs.insert(bConfig);
+	return NULL;
 }
 
 static const char *
@@ -321,18 +331,26 @@
  *************************************************/
 
 static const char *
-cmd_rack_base_uri(cmd_parms *cmd, void *pcfg, const char *arg) {
+cmd_rack_base_uri(cmd_parms *cmd, void *pcfg, const char *arg, const char *arg2) {
 	DirConfig *config = (DirConfig *) pcfg;
+	BaseURIConfig *bConfig = new BaseURIConfig;
 	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;
 	}
+
+	apr_pool_cleanup_register(cmd->pool, bConfig, destroy_config_struct<BaseURIConfig>, apr_pool_cleanup_null);
+
+	bConfig->baseURI = arg;
+
+	if (arg2)  {
+		bConfig->publicDirectory = arg2;
+	}
+	config->rackBaseURIs.insert(bConfig);
+ 	return NULL;
 }
 
 static const char *
@@ -414,7 +433,7 @@
 		"The user that Rails/Rack applications must run as when user switching fails or is disabled."),
 
 	// Rails-specific settings.
-	AP_INIT_TAKE1("RailsBaseURI",
+	AP_INIT_TAKE12("RailsBaseURI",
 		(Take1Func) cmd_rails_base_uri,
 		NULL,
 		RSRC_CONF,
@@ -441,7 +460,7 @@
 		"The spawn method to use."),
 	
 	// Rack-specific settings.
-	AP_INIT_TAKE1("RackBaseURI",
+	AP_INIT_TAKE12("RackBaseURI",
 		(Take1Func) cmd_rack_base_uri,
 		NULL,
 		RSRC_CONF,
diff -wur ext/apache2/Configuration.hpp ext/apache2/Configuration.hpp
--- ext/apache2/Configuration.hpp	2008-08-09 15:19:33.000000000 +0300
+++ ext/apache2/Configuration.hpp	2008-09-23 22:06:15.000000000 +0300
@@ -41,21 +41,25 @@
 
 using namespace std;
 
+struct BaseURIConfig {
+	std::string baseURI;
+	std::string publicDirectory;
+};
 	
 /**
  * Per-directory configuration information.
  *
  * Use the getter methods to query information, because those will return
  * the default value if the value is not specified.
  */
 struct DirConfig {
 	enum Threeway { ENABLED, DISABLED, UNSET };
 	enum SpawnMethod { SM_UNSET, SM_SMART, SM_SMART_LV2, SM_CONSERVATIVE };
 	
 	Threeway enabled;
 	
-	std::set<std::string> railsBaseURIs;
-	std::set<std::string> rackBaseURIs;
+	std::set<BaseURIConfig*> railsBaseURIs;
+	std::set<BaseURIConfig*> rackBaseURIs;
 	
 	/** Whether to autodetect Rails applications. */
 	Threeway autoDetectRails;
diff -wur ext/apache2/DirectoryMapper.h ext/apache2/DirectoryMapper.h
--- ext/apache2/DirectoryMapper.h	2008-08-09 15:19:15.000000000 +0300
+++ ext/apache2/DirectoryMapper.h	2008-09-23 22:13:36.000000000 +0300
@@ -39,6 +39,7 @@
 // compilation will fail on OpenBSD.
 #include <httpd.h>
 #include <http_core.h>
+#include <http_request.h>
 
 namespace Passenger {
 
@@ -87,6 +87,7 @@
 	request_rec *r;
 	bool baseURIKnown;
 	const char *baseURI;
+	BaseURIConfig *bConfig;
 	ApplicationType appType;
 	
 	inline bool shouldAutoDetectRails() {
@@ -114,6 +115,7 @@
 		appType = NONE;
 		baseURIKnown = false;
 		baseURI = NULL;
+		bConfig = NULL;
 	}
 	
 	/**
@@ -136,7 +138,7 @@
 			return baseURI;
 		}
 		
-		set<string>::const_iterator it;
+		set<BaseURIConfig *>::const_iterator it;
 		const char *uri = r->uri;
 		size_t uri_len = strlen(uri);
 		
@@ -146,7 +148,8 @@
 		}
 		
 		for (it = config->railsBaseURIs.begin(); it != config->railsBaseURIs.end(); it++) {
-			const string &base(*it);
+			BaseURIConfig * bc = (*it);
+			const string base = bc->baseURI;
 			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
@@ -155,13 +158,15 @@
 				baseURIKnown = true;
 				baseURI = base.c_str();
 				appType = RAILS;
+				this->bConfig = bc;
 				return baseURI;
 			}
 		}
 		
 		UPDATE_TRACE_POINT();
 		for (it = config->rackBaseURIs.begin(); it != config->rackBaseURIs.end(); it++) {
-			const string &base(*it);
+			BaseURIConfig * bc = (*it);
+			const string base = bc->baseURI;
 			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
@@ -169,6 +174,7 @@
 				baseURIKnown = true;
 				baseURI = base.c_str();
 				appType = RACK;
+				this->bConfig = bc;
 				return baseURI;
 			}
 		}
@@ -213,26 +219,14 @@
 			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 "";
+		if (this->bConfig->publicDirectory.empty ()) {
+			request_rec *sub_req;
+			sub_req = ap_sub_req_lookup_uri(baseURI, r, NULL);
+
+			this->bConfig->publicDirectory = resolveSymlink(sub_req->filename);
 		}
+
+		return this->bConfig->publicDirectory;
 	}
 	
 	/**
Commit	Line	Data
5a9bc809 JR	1
	2	http://code.google.com/p/phusion-passenger/issues/detail?id=30&colspec=ID%20Type%20Status%20Priority%20Milestone%20Stars%20Summary
	3	http://code.google.com/p/phusion-passenger/issues/detail?id=136&colspec=ID%20Type%20Status%20Priority%20Milestone%20Stars%20Summary
	4
	5	Problem: The problem with RailsBaseURI is that it expects Rails directory
	6	to be in virtualhost's documentroot. If it does'nt then you have to create
	7	symlink to use rails application outside of document root.
	8
	9	Fix: Instead of creating symlinks there could be second optional argument
	10	for RailsBaseURI which specifies full path to Rails application's public
	11	directory.
	12
	13	For example, instead of creating symlink /var/www/somehost/railsapp1 ->
	14	/home/user/railsapp1/public and:
	15	<virtualhost *>
	16	DocumentRoot /var/www/somehost
	17	RailsBaseURI /railsapp1
	18	</virtualhost>
	19
	20	we skip the symlink and specify the full path in apache conf:
	21	<virtualhost *>
	22	DocumentRoot /var/www/somehost
	23	RailsBaseURI /railsapp1 /home/user/railsapp1/public
	24	</virtualhost>
	25
	26	The patch (for 2.0.3) that does the thing is attached (patches also
	27	RackBaseURI).
	28
	29	The combined patch:
	30
	31	1) Aliases and rewrite rules now apply when translating RailsBaseURI into
	32	physical path. Resolved paths are cached.
	33	2) Current behaviour remains: DocumentRoot+RailsBaseURI works also
	34	3) If RailsBaseURI or RackBaseURI has second argument then this second argument
	35	is used as physical path to rails public directory. This eliminates the need
	36	for extra lookup using Apache subrequest and the overhead caused by it.
	37
	38	diff -wur ext/apache2/Configuration.cpp ext/apache2/Configuration.cpp
	39	--- ext/apache2/Configuration.cpp 2008-08-09 15:19:15.000000000 +0300
	40	+++ ext/apache2/Configuration.cpp 2008-09-23 22:06:15.000000000 +0300
	41	@@ -75,11 +75,11 @@
	42	DirConfig add = (DirConfig ) addv;
	43
	44	config->railsBaseURIs = base->railsBaseURIs;
	45	- for (set<string>::const_iterator it(add->railsBaseURIs.begin()); it != add->railsBaseURIs.end(); it++) {
	46	+ for (set<BaseURIConfig*>::const_iterator it(add->railsBaseURIs.begin()); it != add->railsBaseURIs.end(); it++) {
	47	config->railsBaseURIs.insert(*it);
	48	}
	49	config->rackBaseURIs = base->rackBaseURIs;
	50	- for (set<string>::const_iterator it(add->rackBaseURIs.begin()); it != add->rackBaseURIs.end(); it++) {
	51	+ for (set<BaseURIConfig*>::const_iterator it(add->rackBaseURIs.begin()); it != add->rackBaseURIs.end(); it++) {
	52	config->rackBaseURIs.insert(*it);
	53	}
	54
	55	@@ -275,18 +275,27 @@
	56	*************************************************/
	57
	58	static const char *
	59	-cmd_rails_base_uri(cmd_parms cmd, void pcfg, const char *arg) {
	60	+cmd_rails_base_uri(cmd_parms cmd, void pcfg, const char arg, const char arg2) {
	61	DirConfig config = (DirConfig ) pcfg;
	62	+ BaseURIConfig *bConfig = new BaseURIConfig;
	63	if (strlen(arg) == 0) {
	64	return "RailsBaseURI may not be set to the empty string";
65	} else if (arg[0] != '/') {
66	return "RailsBaseURI must start with a slash (/)";
67	} else if (strlen(arg) > 1 && arg[strlen(arg) - 1] == '/') {
68	return "RailsBaseURI must not end with a slash (/)";
69	- } else {
70	- config->railsBaseURIs.insert(arg);
71	- return NULL;
72	}
73	+
74	+ apr_pool_cleanup_register(cmd->pool, bConfig, destroy_config_struct<BaseURIConfig>, apr_pool_cleanup_null);
75	+
76	+ bConfig->baseURI = arg;
77	+
78	+ if (arg2) {
79	+ bConfig->publicDirectory = arg2;
80	+ }
81	+
82	+ config->railsBaseURIs.insert(bConfig);
83	+ return NULL;
84	}
85
86	static const char *
87	@@ -321,18 +331,26 @@
88	*************************************************/
89
90	static const char *
91	-cmd_rack_base_uri(cmd_parms cmd, void pcfg, const char *arg) {
92	+cmd_rack_base_uri(cmd_parms cmd, void pcfg, const char arg, const char arg2) {
93	DirConfig config = (DirConfig ) pcfg;
94	+ BaseURIConfig *bConfig = new BaseURIConfig;
95	if (strlen(arg) == 0) {
96	return "RackBaseURI may not be set to the empty string";
97	} else if (arg[0] != '/') {
98	return "RackBaseURI must start with a slash (/)";
99	} else if (strlen(arg) > 1 && arg[strlen(arg) - 1] == '/') {
100	return "RackBaseURI must not end with a slash (/)";
101	- } else {
102	- config->rackBaseURIs.insert(arg);
103	- return NULL;
104	}
105	+
106	+ apr_pool_cleanup_register(cmd->pool, bConfig, destroy_config_struct<BaseURIConfig>, apr_pool_cleanup_null);
107	+
108	+ bConfig->baseURI = arg;
109	+
110	+ if (arg2) {
111	+ bConfig->publicDirectory = arg2;
112	+ }
113	+ config->rackBaseURIs.insert(bConfig);
114	+ return NULL;
115	}
116
117	static const char *
118	@@ -414,7 +433,7 @@
119	"The user that Rails/Rack applications must run as when user switching fails or is disabled."),
120
121	// Rails-specific settings.
122	- AP_INIT_TAKE1("RailsBaseURI",
123	+ AP_INIT_TAKE12("RailsBaseURI",
124	(Take1Func) cmd_rails_base_uri,
125	NULL,
126	RSRC_CONF,
127	@@ -441,7 +460,7 @@
128	"The spawn method to use."),
129
130	// Rack-specific settings.
131	- AP_INIT_TAKE1("RackBaseURI",
132	+ AP_INIT_TAKE12("RackBaseURI",
133	(Take1Func) cmd_rack_base_uri,
134	NULL,
135	RSRC_CONF,
3fbe5956 JR	136	diff -wur ext/apache2/Configuration.hpp ext/apache2/Configuration.hpp
	137	--- ext/apache2/Configuration.hpp 2008-08-09 15:19:33.000000000 +0300
	138	+++ ext/apache2/Configuration.hpp 2008-09-23 22:06:15.000000000 +0300
	139	@@ -41,21 +41,25 @@
	140
	141	using namespace std;
	142
	143	+struct BaseURIConfig {
	144	+ std::string baseURI;
	145	+ std::string publicDirectory;
	146	+};
5a9bc809	147
3fbe5956 JR	148	/**
	149	* Per-directory configuration information.
	150	*
	151	* Use the getter methods to query information, because those will return
	152	* the default value if the value is not specified.
	153	*/
	154	struct DirConfig {
	155	enum Threeway { ENABLED, DISABLED, UNSET };
	156	enum SpawnMethod { SM_UNSET, SM_SMART, SM_SMART_LV2, SM_CONSERVATIVE };
	157
	158	Threeway enabled;
	159
	160	- std::set<std::string> railsBaseURIs;
	161	- std::set<std::string> rackBaseURIs;
	162	+ std::set<BaseURIConfig*> railsBaseURIs;
	163	+ std::set<BaseURIConfig*> rackBaseURIs;
	164
	165	/** Whether to autodetect Rails applications. */
	166	Threeway autoDetectRails;
5a9bc809 JR	167	diff -wur ext/apache2/DirectoryMapper.h ext/apache2/DirectoryMapper.h
	168	--- ext/apache2/DirectoryMapper.h 2008-08-09 15:19:15.000000000 +0300
	169	+++ ext/apache2/DirectoryMapper.h 2008-09-23 22:13:36.000000000 +0300
9c19ebf3 JR	170	@@ -39,6 +39,7 @@
	171	// compilation will fail on OpenBSD.
	172	#include <httpd.h>
	173	#include <http_core.h>
	174	+#include <http_request.h>
	175
	176	namespace Passenger {
	177
5a9bc809 JR	178	@@ -87,6 +87,7 @@
	179	request_rec *r;
	180	bool baseURIKnown;
	181	const char *baseURI;
	182	+ BaseURIConfig *bConfig;
	183	ApplicationType appType;
	184
	185	inline bool shouldAutoDetectRails() {
	186	@@ -114,6 +115,7 @@
	187	appType = NONE;
	188	baseURIKnown = false;
	189	baseURI = NULL;
	190	+ bConfig = NULL;
	191	}
	192
	193	/**
	194	@@ -136,7 +138,7 @@
	195	return baseURI;
	196	}
	197
	198	- set<string>::const_iterator it;
	199	+ set<BaseURIConfig *>::const_iterator it;
	200	const char *uri = r->uri;
	201	size_t uri_len = strlen(uri);
	202
	203	@@ -146,7 +148,8 @@
	204	}
	205
	206	for (it = config->railsBaseURIs.begin(); it != config->railsBaseURIs.end(); it++) {
	207	- const string &base(*it);
	208	+ BaseURIConfig * bc = (*it);
	209	+ const string base = bc->baseURI;
	210	if ( base == "/"
	211	\|\| ( uri_len == base.size() && memcmp(uri, base.c_str(), uri_len) == 0 )
	212	\|\| ( uri_len > base.size() && memcmp(uri, base.c_str(), base.size()) == 0
	213	@@ -155,13 +158,15 @@
	214	baseURIKnown = true;
	215	baseURI = base.c_str();
	216	appType = RAILS;
	217	+ this->bConfig = bc;
	218	return baseURI;
	219	}
	220	}
	221
	222	UPDATE_TRACE_POINT();
	223	for (it = config->rackBaseURIs.begin(); it != config->rackBaseURIs.end(); it++) {
	224	- const string &base(*it);
	225	+ BaseURIConfig * bc = (*it);
	226	+ const string base = bc->baseURI;
	227	if ( base == "/"
	228	\|\| ( uri_len == base.size() && memcmp(uri, base.c_str(), uri_len) == 0 )
	229	\|\| ( uri_len > base.size() && memcmp(uri, base.c_str(), base.size()) == 0
	230	@@ -169,6 +174,7 @@
	231	baseURIKnown = true;
	232	baseURI = base.c_str();
	233	appType = RACK;
	234	+ this->bConfig = bc;
	235	return baseURI;
	236	}
	237	}
	238	@@ -213,26 +219,14 @@
	239	return "";
	240	}
	241
242	- const char *docRoot = ap_document_root(r);
243	- size_t len = strlen(docRoot);
244	- if (len > 0) {
245	- string path;
246	- if (docRoot[len - 1] == '/') {
247	- path.assign(docRoot, len - 1);
248	- } else {
249	- path.assign(docRoot, len);
250	- }
251	- if (strcmp(baseURI, "/") != 0) {
252	- /* Application is deployed in a sub-URI.
253	- * This is probably a symlink, so let's resolve it.
254	- */
255	- path.append(baseURI);
256	- path = resolveSymlink(path);
257	- }
258	- return path;
259	- } else {
260	- return "";
261	+ if (this->bConfig->publicDirectory.empty ()) {
262	+ request_rec *sub_req;
263	+ sub_req = ap_sub_req_lookup_uri(baseURI, r, NULL);
264	+
265	+ this->bConfig->publicDirectory = resolveSymlink(sub_req->filename);
266	}
267	+
268	+ return this->bConfig->publicDirectory;
269	}
270
271	/**