along comes mod_vhost

src/modules/mod_vhost.c

@@ -0,0 +1,214 @@
+/*
+ * mod_vhost - virtual hosting
+ *
+ * Description:
+ *     mod_vhost offers various ways to implement virtual webhosts
+ *     it can map hostnames to document roots or even actions
+ *
+ * Setups:
+ *     none
+ * Options:
+ *     vhost.debug <true|false>  - enable debug output
+ *         type: boolean
+ * Actions:
+ *     vhost.simple ("server-root" => string, "docroot" => string, "default" => string)
+ *         - builds the document root by concatinating server-root + hostname + docroot
+ *         - if the newly build docroot does not exist, repeat with "default" hostname
+ *
+ * Example config:
+ *     vhost.simple ("server-root" => "/var/www/vhosts/", "docroot" => "/pub", "default" => "localhost");
+ *
+ * Todo:
+ *     - use stat cache (when implemented)
+ *     - add vhost.map action
+ *       dom1.tld {...} dom2.tld {...} vhost.map ["dom1.tld": dom1.tld, "*.dom1.tld": dom1.tld, "dom2.tld": dom2.tld, "default": dom1.tld];
+ *       - split hashtable into hashtable with plain hostnames and array with wildcard hostnames
+ *       - hashtable lookup is fast, wildcard matching not => first look in hashtable then in array
+ *       - optimize array by ordering it by matches => frequently matched vhosts at the beginning resulting in a better hitrate
+ *     - mod_evhost equivalent?
+ *
+ * Author:
+ *     Copyright (c) 2008 Thomas Porzelt
+ * License:
+ *     MIT, see COPYING file in the lighttpd 2 tree
+ */
+
+#include <lighttpd/base.h>
+
+LI_API gboolean mod_vhost_init(modules *mods, module *mod);
+LI_API gboolean mod_vhost_free(modules *mods, module *mod);
+
+struct vhost_simple_data {
+	plugin *plugin;
+	GString *default_vhost;
+	GString *docroot;
+	GString *server_root;
+};
+typedef struct vhost_simple_data vhost_simple_data;
+
+
+static handler_t vhost_simple(vrequest *vr, gpointer param, gpointer *context) {
+	struct stat st;
+	gboolean debug;
+	vhost_simple_data *sd = param;
+
+	UNUSED(context);
+
+	debug = _OPTION(vr, sd->plugin, 0).boolean;
+
+	/* build document root: sd->server_root + req.host + sd->docroot */
+	g_string_truncate(vr->physical.doc_root, 0);
+	g_string_append_len(vr->physical.doc_root, GSTR_LEN(sd->server_root));
+	g_string_append_len(vr->physical.doc_root, GSTR_LEN(vr->request.uri.host));
+	g_string_append_len(vr->physical.doc_root, GSTR_LEN(sd->docroot));
+
+	/* check if directory exists. if not, fall back to default host */
+	vr->physical.have_stat = FALSE; vr->physical.have_errno = FALSE;
+	if (-1 == stat(vr->physical.doc_root->str, &st)) {
+		if (debug)
+			VR_DEBUG(vr, "vhost.simple: docroot for vhost \"%s\" does not exist, falling back to default", vr->request.uri.host->str);
+		g_string_truncate(vr->physical.doc_root, sd->server_root->len);
+		g_string_append_len(vr->physical.doc_root, GSTR_LEN(sd->default_vhost));
+		g_string_append_len(vr->physical.doc_root, GSTR_LEN(sd->docroot));
+	}
+
+	if (debug)
+		VR_DEBUG(vr, "vhost.simple: physical docroot now \"%s\"", vr->physical.doc_root->str);
+
+	/* build physical path: docroot + uri.path */
+	g_string_truncate(vr->physical.path, 0);
+	g_string_append_len(vr->physical.path, GSTR_LEN(vr->physical.doc_root));
+	g_string_append_len(vr->physical.path, GSTR_LEN(vr->request.uri.path));
+
+	return HANDLER_GO_ON;
+}
+
+static void vhost_simple_free(server *srv, gpointer param) {
+	vhost_simple_data *sd = param;
+
+	UNUSED(srv);
+
+	if (sd->default_vhost)
+		g_string_free(sd->default_vhost, TRUE);
+	if (sd->docroot)
+		g_string_free(sd->docroot, TRUE);
+	if (sd->server_root)
+		g_string_free(sd->server_root, TRUE);
+
+	g_slice_free(vhost_simple_data, sd);
+}
+
+static action* vhost_simple_create(server *srv, plugin* p, value *val) {
+	guint i;
+	GArray *arr;
+	value *k, *v;
+	vhost_simple_data *sd;
+	GString **setting;
+
+	UNUSED(srv); UNUSED(p);
+
+	if (!val || val->type != VALUE_LIST) {
+		ERROR(srv, "%s", "vhost.simple expects a list if string tuples as parameter");
+		return NULL;
+	}
+
+	sd = g_slice_new0(vhost_simple_data);
+	sd->plugin = p;
+
+	arr = val->data.list;
+	for (i = 0; i < arr->len; i++) {
+		val = g_array_index(arr, value*, i);
+		if (val->type != VALUE_LIST || val->data.list->len != 2) {
+			vhost_simple_free(srv, sd);
+			ERROR(srv, "%s", "vhost.simple expects a list if string tuples as parameter");
+			return NULL;
+		}
+
+		k = g_array_index(val->data.list, value*, 0);
+		v = g_array_index(val->data.list, value*, 1);
+		if (k->type != VALUE_STRING || v->type != VALUE_STRING) {
+			vhost_simple_free(srv, sd);
+			ERROR(srv, "%s", "vhost.simple expects a list if string tuples as parameter");
+			return NULL;
+		}
+
+		if (g_str_equal(k->data.string->str, "server-root")) {
+			setting = &sd->server_root;
+		} else if (g_str_equal(k->data.string->str, "docroot")) {
+			setting = &sd->docroot;
+		} else if (g_str_equal(k->data.string->str, "default")) {
+			setting = &sd->default_vhost;
+		} else {
+			vhost_simple_free(srv, sd);
+			ERROR(srv, "unkown setting \"%s\" for vhost.simple", k->data.string->str);
+			return NULL;
+		}
+
+		if (*setting) {
+			vhost_simple_free(srv, sd);
+			ERROR(srv, "%s", "parameter set twice for vhost.simple");
+			return NULL;
+		}
+
+		*setting = value_extract(v).string;
+	}
+
+	if (!sd->server_root || !sd->docroot || !sd->default_vhost) {
+		vhost_simple_free(srv, sd);
+		ERROR(srv, "%s", "missing parameter for vhost.simple. need \"server-root\", \"docroot\" and \"default\"");
+		return NULL;
+	}
+
+	/* make sure server_root has a trailing slash (or whatever this OS uses as dir seperator */
+	if (sd->server_root->len == 0 || sd->server_root->str[sd->server_root->len-1] != G_DIR_SEPARATOR)
+		g_string_append_c(sd->server_root, G_DIR_SEPARATOR);
+	/* make sure docroot begins with a slash (or whatever this OS uses as dir seperator */
+	if (sd->docroot->len == 0 || sd->docroot->str[0] != G_DIR_SEPARATOR)
+		g_string_prepend_c(sd->docroot, G_DIR_SEPARATOR);
+
+	return action_new_function(vhost_simple, NULL, vhost_simple_free, sd);
+}
+
+
+static const plugin_option options[] = {
+	{ "vhost.debug", VALUE_BOOLEAN, NULL, NULL, NULL },
+
+	{ NULL, 0, NULL, NULL, NULL }
+};
+
+static const plugin_action actions[] = {
+	{ "vhost.simple", vhost_simple_create },
+
+	{ NULL, NULL }
+};
+
+static const plugin_setup setups[] = {
+	{ NULL, NULL }
+};
+
+
+static void plugin_vhost_init(server *srv, plugin *p) {
+	UNUSED(srv);
+
+	p->options = options;
+	p->actions = actions;
+	p->setups = setups;
+}
+
+
+gboolean mod_vhost_init(modules *mods, module *mod) {
+	UNUSED(mod);
+
+	MODULE_VERSION_CHECK(mods);
+
+	mod->config = plugin_register(mods->main, "mod_vhost", plugin_vhost_init);
+
+	return mod->config != NULL;
+}
+
+gboolean mod_vhost_free(modules *mods, module *mod) {
+	if (mod->config)
+		plugin_free(mods->main, mod->config);
+
+	return TRUE;
+}

src/wscript

@@ -102,7 +102,7 @@ def configure(conf):
 def build(bld):
 	env = bld.env
 	opts = Options.options
-	
+
 	lighty = bld.new_task_gen('cc', 'program')
 	lighty.source = main_src + common_src
 	lighty.target = 'lighttpd' + opts.append
@@ -115,3 +115,4 @@ def build(bld):
 	lighty_mod(bld, 'mod_fastcgi', 'modules/mod_fastcgi.c')
 	lighty_mod(bld, 'mod_fortune', 'modules/mod_fortune.c')
 	lighty_mod(bld, 'mod_status', 'modules/mod_status.c')
+	lighty_mod(bld, 'mod_vhost', 'modules/mod_vhost.c')

wscript

@@ -52,6 +52,9 @@ def configure(conf):
 	conf.check(lib='ev', uselib_store='ev', mandatory=True)
 	conf.check(header_name='ev.h', uselib='ev', mandatory=True)
 
+	if opts.all:
+		opts.lua = True
+
 	if opts.extra_warnings:
 		conf.env['CCFLAGS'] += [
 			'-g', '-g2', '-Wall', '-Wmissing-declarations',