lighttpd2/src/plugin_core.c

#include <lighttpd/base.h>
#include <lighttpd/plugin_core.h>
#include <lighttpd/profiler.h>

#include <sys/stat.h>
#include <fcntl.h>

static action* core_list(server *srv, plugin* p, value *val) {
	action *a;
	guint i;
	UNUSED(p);

	if (!val) {
		ERROR(srv, "%s", "need parameter");
		return NULL;
	}

	if (val->type == VALUE_ACTION) {
		a = val->data.val_action.action;
		action_acquire(a);
		return a;
	}

	if (val->type != VALUE_LIST) {
		ERROR(srv, "expected list, got %s", value_type_string(val->type));
		return NULL;
	}

	a = action_new_list();
	for (i = 0; i < val->data.list->len; i++) {
		value *oa = g_array_index(val->data.list, value*, i);
		if (oa->type != VALUE_ACTION) {
			ERROR(srv, "expected action at entry %u of list, got %s", i, value_type_string(oa->type));
			action_release(srv, a);
			return NULL;
		}
		assert(srv == oa->data.val_action.srv);
		action_acquire(oa->data.val_action.action);
		g_array_append_val(a->data.list, oa->data.val_action.action);
	}
	return a;
}

static action* core_when(server *srv, plugin* p, value *val) {
	value *val_cond, *val_act, *val_act_else;
	action *a, *act = NULL, *act_else = NULL;
	UNUSED(p);

	if (!val) {
		ERROR(srv, "%s", "need parameter");
		return NULL;
	}
	if (val->type != VALUE_LIST) {
		ERROR(srv, "expected list, got %s", value_type_string(val->type));
		return NULL;
	}
	if (val->data.list->len == 2) {
		val_act_else = NULL;
		act_else = NULL;
	} else if (val->data.list->len == 3) {
		val_act_else = g_array_index(val->data.list, value*, 2);
	} else {
		ERROR(srv, "expected list with length 2 or 3, has length %u", val->data.list->len);
		return NULL;
	}
	val_cond = g_array_index(val->data.list, value*, 0);
	val_act = g_array_index(val->data.list, value*, 1);

	if (val_cond->type != VALUE_CONDITION) {
		ERROR(srv, "expected condition as first parameter, got %s", value_type_string(val_cond->type));
		return NULL;
	}
	if (val_act->type == VALUE_NONE) {
		act = NULL;
	} else if (val_act->type == VALUE_ACTION) {
		act = val_act->data.val_action.action;
	} else {
		ERROR(srv, "expected action as second parameter, got %s", value_type_string(val_act->type));
		return NULL;
	}
	if (val_act_else) {
		if (val_act_else->type == VALUE_NONE) {
			act_else = NULL;
		} else if (val_act_else->type == VALUE_ACTION) {
			act_else = val_act_else->data.val_action.action;
		} else {
			ERROR(srv, "expected action as third parameter, got %s", value_type_string(val_act_else->type));
			return NULL;
		}
	}
	condition_acquire(val_cond->data.val_cond.cond);
	if (act) action_acquire(act);
	if (act_else) action_acquire(act_else);
	a = action_new_condition(val_cond->data.val_cond.cond, act, act_else);
	return a;
}

static action* core_set(server *srv, plugin* p, value *val) {
	value *val_val, *val_name;
	action *a;
	UNUSED(p);

	if (!val) {
		ERROR(srv, "%s", "need parameter");
		return NULL;
	}
	if (val->type != VALUE_LIST) {
		ERROR(srv, "expected list, got %s", value_type_string(val->type));
		return NULL;
	}
	if (val->data.list->len != 2) {
		ERROR(srv, "expected list with length 2, has length %u", val->data.list->len);
		return NULL;
	}
	val_name = g_array_index(val->data.list, value*, 0);
	val_val = g_array_index(val->data.list, value*, 1);
	if (val_name->type != VALUE_STRING) {
		ERROR(srv, "expected string as first parameter, got %s", value_type_string(val_name->type));
		return NULL;
	}
	a = option_action(srv, val_name->data.string->str, val_val);
	return a;
}

static gboolean core_setup_set(server *srv, plugin* p, value *val) {
	value *val_val, *val_name;
	UNUSED(p);

	if (!val) {
		ERROR(srv, "%s", "need parameter");
		return FALSE;
	}
	if (val->type != VALUE_LIST) {
		ERROR(srv, "expected list, got %s", value_type_string(val->type));
		return FALSE;
	}
	if (val->data.list->len != 2) {
		ERROR(srv, "expected list with length 2, has length %u", val->data.list->len);
		return FALSE;
	}
	val_name = g_array_index(val->data.list, value*, 0);
	val_val = g_array_index(val->data.list, value*, 1);
	if (val_name->type != VALUE_STRING) {
		ERROR(srv, "expected string as first parameter, got %s", value_type_string(val_name->type));
		return FALSE;
	}
	return plugin_set_default_option(srv, val_name->data.string->str, val_val);
}

static handler_t core_handle_docroot(vrequest *vr, gpointer param, gpointer *context) {
	UNUSED(context);

	g_string_truncate(vr->physical.doc_root, 0);
	g_string_append_len(vr->physical.doc_root, GSTR_LEN((GString*) param));
	/* reset stat info because path has changed */
	vr->physical.have_stat = FALSE;
	vr->physical.have_errno = FALSE;

	VR_DEBUG(vr, "docroot: %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));

	VR_DEBUG(vr, "physical path: %s", vr->physical.path->str);

	return HANDLER_GO_ON;
}

static void core_docroot_free(server *srv, gpointer param) {
	UNUSED(srv);
	g_string_free(param, TRUE);
}

static action* core_docroot(server *srv, plugin* p, value *val) {
	UNUSED(p);
	if (!val || val->type != VALUE_STRING) {
		ERROR(srv, "%s", "docroot action expects a string parameter");
		return NULL;
	}

	return action_new_function(core_handle_docroot, NULL, core_docroot_free, value_extract(val).string);
}


static handler_t core_handle_index(vrequest *vr, gpointer param, gpointer *context) {
	handler_t res;
	guint i;
	struct stat st;
	gint err;
	GString *file, *tmp_docroot, *tmp_path;
	GArray *files = param;

	UNUSED(context);

	if (!vr->physical.doc_root->len) {
		VR_ERROR(vr, "%s", "no docroot specified yet but index action called");
		return HANDLER_ERROR;
	}


	res = stat_cache_get(vr, vr->physical.path, &st, &err, NULL);
	if (res == HANDLER_WAIT_FOR_EVENT)
		return HANDLER_WAIT_FOR_EVENT;

	if (res == HANDLER_ERROR) {
		/* we ignore errors here so a later action can deal with it (e.g. 'static') */
		return HANDLER_GO_ON;
	}

	if (!S_ISDIR(st.st_mode))
		return HANDLER_GO_ON;

	/* we use two temporary strings here, one to append to docroot and one to append to physical path */
	tmp_docroot = vr->wrk->tmp_str;
	g_string_truncate(tmp_docroot, 0);
	g_string_append_len(vr->wrk->tmp_str, GSTR_LEN(vr->physical.doc_root));
	tmp_path = g_string_new_len(GSTR_LEN(vr->physical.path));

	/* loop through the list to find a possible index file */
	for (i = 0; i < files->len; i++) {
		file = g_array_index(files, value*, i)->data.string;

		if (file->str[0] == '/') {
			/* entries beginning with a slash shall be looked up directly at the docroot */
			g_string_truncate(tmp_docroot, vr->physical.doc_root->len);
			g_string_append_len(tmp_docroot, GSTR_LEN(file));
			res = stat_cache_get(vr, tmp_docroot, &st, &err, NULL);
		} else {
			g_string_truncate(tmp_path, vr->physical.path->len);
			g_string_append_len(tmp_path, GSTR_LEN(file));
			res = stat_cache_get(vr, tmp_path, &st, &err, NULL);
		}

		if (res == HANDLER_WAIT_FOR_EVENT) {
			g_string_free(tmp_path, TRUE);
			return HANDLER_WAIT_FOR_EVENT;
		}

		if (res == HANDLER_GO_ON) {
			/* file exists. change physical path */
			if (file->str[0] == '/')
				g_string_truncate(vr->physical.path, vr->physical.doc_root->len);

			g_string_append_len(vr->physical.path, GSTR_LEN(file));

			if (CORE_OPTION(CORE_OPTION_DEBUG_REQUEST_HANDLING).boolean) {
				VR_DEBUG(vr, "using index file: '%s'", file->str);
			}

			g_string_free(tmp_path, TRUE);

			return HANDLER_GO_ON;
		}
	}

	g_string_free(tmp_path, TRUE);

	return HANDLER_GO_ON;
}

static void core_index_free(server *srv, gpointer param) {
	guint i;
	GArray *files = param;

	UNUSED(srv);

	for (i = 0; i < files->len; i++) 
		value_free(g_array_index(files, value*, i));

	g_array_free(files, TRUE);
}

static action* core_index(server *srv, plugin* p, value *val) {
	GArray *files;
	guint i;

	UNUSED(p);

	if (!val || val->type != VALUE_LIST) {
		ERROR(srv, "%s", "index action expects a list of strings as parameter");
		return NULL;
	}

	files = val->data.list;

	for (i = 0; i < files->len; i++) {
		if (g_array_index(files, value*, i)->type != VALUE_STRING) {
			ERROR(srv, "%s", "index action expects a list of strings as parameter");
			return NULL;
		}
	}

	return action_new_function(core_handle_index, NULL, core_index_free, value_extract(val).list);
}


static handler_t core_handle_static(vrequest *vr, gpointer param, gpointer *context) {
	int fd;
	struct stat st;
	int err;
	handler_t res;

	UNUSED(param);
	UNUSED(context);

	switch (vr->request.http_method) {
	case HTTP_METHOD_GET:
	case HTTP_METHOD_HEAD:
		break;
	default:
		return HANDLER_GO_ON;
	}

	if (vrequest_is_handled(vr)) return HANDLER_GO_ON;

	if (vr->physical.path->len == 0) return HANDLER_GO_ON;

	res = stat_cache_get(vr, vr->physical.path, &st, &err, &fd);
	if (res == HANDLER_WAIT_FOR_EVENT)
		return res;

	if (CORE_OPTION(CORE_OPTION_DEBUG_REQUEST_HANDLING).boolean) {
		VR_DEBUG(vr, "try serving static file: '%s'", vr->physical.path->str);
	}

	if (res == HANDLER_ERROR) {
		/* open or fstat failed */

		if (fd != -1)
			close(fd);

		if (!vrequest_handle_direct(vr)) {
			return HANDLER_ERROR;
		}

		switch (err) {
		case ENOENT:
		case ENOTDIR:
			vr->response.http_status = 404;
			return HANDLER_GO_ON;
		case EACCES:
			vr->response.http_status = 403;
			return HANDLER_GO_ON;
		default:
			VR_ERROR(vr, "stat() or open() for '%s' failed: %s", vr->physical.path->str, g_strerror(err));
			return HANDLER_ERROR;
		}
	} else if (S_ISDIR(st.st_mode)) {
		if (fd != -1)
			close(fd);
		return HANDLER_GO_ON;
	} else if (!S_ISREG(st.st_mode)) {
		if (CORE_OPTION(CORE_OPTION_DEBUG_REQUEST_HANDLING).boolean) {
			VR_DEBUG(vr, "not a regular file: '%s'", vr->physical.path->str);
		}
		
		if (fd != -1)
			close(fd);

		if (!vrequest_handle_direct(vr)) {
			return HANDLER_ERROR;
		}
		vr->response.http_status = 403;
	} else {
		GString *mime_str;
		gboolean cachable;
#ifdef FD_CLOEXEC
		fcntl(fd, F_SETFD, FD_CLOEXEC);
#endif

		if (!vrequest_handle_direct(vr)) {
			close(fd);
			return HANDLER_ERROR;
		}

		etag_set_header(vr, &st, &cachable);
		if (cachable) {
			vr->response.http_status = 304;
			close(fd);
			return HANDLER_GO_ON;
		}

		mime_str = mimetype_get(vr, vr->physical.path);
		vr->response.http_status = 200;
		if (mime_str)
			http_header_overwrite(vr->response.headers, CONST_STR_LEN("Content-Type"), GSTR_LEN(mime_str));
		else
			http_header_overwrite(vr->response.headers, CONST_STR_LEN("Content-Type"), CONST_STR_LEN("application/octet-stream"));
		chunkqueue_append_file_fd(vr->out, NULL, 0, st.st_size, fd);
	}

	return HANDLER_GO_ON;
}

static action* core_static(server *srv, plugin* p, value *val) {
	UNUSED(p);
	if (val) {
		ERROR(srv, "%s", "static action doesn't have parameters");
		return NULL;
	}

	return action_new_function(core_handle_static, NULL, NULL, NULL);
}


static handler_t core_handle_status(vrequest *vr, gpointer param, gpointer *context) {
	UNUSED(param);
	UNUSED(context);

	vr->response.http_status = GPOINTER_TO_INT(param);

	return HANDLER_GO_ON;
}

static action* core_status(server *srv, plugin* p, value *val) {
	gpointer ptr;

	UNUSED(p);

	if (val || val->type != VALUE_NUMBER) {
		ERROR(srv, "%s", "status action expects a number as parameter");
		return NULL;
	}

	ptr = GINT_TO_POINTER((gint) value_extract(val).number);

	return action_new_function(core_handle_status, NULL, NULL, ptr);
}


static void core_log_write_free(server *srv, gpointer param) {
	UNUSED(srv);
	g_string_free(param, TRUE);
}

static handler_t core_handle_log_write(vrequest *vr, gpointer param, gpointer *context) {
	GString *msg = param;

	UNUSED(context);

	VR_INFO(vr, "%s", msg->str);

	return HANDLER_GO_ON;
}

static action* core_log_write(server *srv, plugin* p, value *val) {
	UNUSED(p);
	if (!val || val->type != VALUE_STRING) {
		ERROR(srv, "%s", "log.write expects a string parameter");
		return NULL;
	}

	return action_new_function(core_handle_log_write, NULL, core_log_write_free, value_extract(val).string);
}


static handler_t core_handle_blank(vrequest *vr, gpointer param, gpointer *context) {
	UNUSED(param);
	UNUSED(context);

	if (!vrequest_handle_direct(vr)) return HANDLER_GO_ON;

	vr->response.http_status = 200;

	return HANDLER_GO_ON;
}

static action* core_blank(server *srv, plugin* p, value *val) {
	UNUSED(p);

	if (val) {
		ERROR(srv, "%s", "'blank' action doesn't have parameters");
		return NULL;
	}

	return action_new_function(core_handle_blank, NULL, NULL, NULL);
}

static handler_t core_handle_profile_mem(vrequest *vr, gpointer param, gpointer *context) {
	UNUSED(vr);
	UNUSED(param);
	UNUSED(context);

	/*g_mem_profile();*/
	profiler_dump();

	return HANDLER_GO_ON;
}

static action* core_profile_mem(server *srv, plugin* p, value *val) {
	UNUSED(p);

	if (val) {
		ERROR(srv, "%s", "'profile_mem' action doesn't have parameters");
		return NULL;
	}

	return action_new_function(core_handle_profile_mem, NULL, NULL, NULL);
}

static gboolean core_listen(server *srv, plugin* p, value *val) {
	GString *ipstr;
	int s;
	UNUSED(p);

	if (val->type != VALUE_STRING) {
		ERROR(srv, "%s", "listen expects a string as parameter");
		return FALSE;
	}

	ipstr = val->data.string;
	if (-1 == (s = angel_listen(srv, ipstr))) {
		ERROR(srv, "%s", "angel_listen failed");
		return FALSE;
	}

	server_listen(srv, s);

	return TRUE;
}


static gboolean core_event_handler(server *srv, plugin* p, value *val) {
	guint backend;
	gchar *str;
	UNUSED(p);

	if (val->type != VALUE_STRING) {
		ERROR(srv, "%s", "event_handler expects a string as parameter");
		return FALSE;
	}

	str = val->data.string->str;
	backend = 0; /* libev will chose the right one by default */

	if (g_str_equal(str, "select"))
		backend = EVBACKEND_SELECT;
	else if (g_str_equal(str, "poll"))
		backend = EVBACKEND_POLL;
	else if (g_str_equal(str, "epoll"))
		backend = EVBACKEND_EPOLL;
	else if (g_str_equal(str, "kqueue"))
		backend = EVBACKEND_KQUEUE;
	else if (g_str_equal(str, "devpoll"))
		backend = EVBACKEND_DEVPOLL;
	else if (g_str_equal(str, "port"))
		backend = EVBACKEND_PORT;
	else {
		ERROR(srv, "unkown event handler: '%s'", str);
		return FALSE;
	}

	if (backend) {
		if (!(ev_supported_backends() & backend)) {
			ERROR(srv, "unsupported event handler: '%s'", str);
			return FALSE;
		}

		if (!(ev_recommended_backends() & backend)) {
			DEBUG(srv, "warning: event handler '%s' not recommended for this platform!", str);
		}
	}

	srv->loop_flags |= backend;

	return TRUE;
}

static gboolean core_workers(server *srv, plugin* p, value *val) {
	gint workers;
	UNUSED(p);

	workers = val->data.number;
	if (val->type != VALUE_NUMBER || workers < 1) {
		ERROR(srv, "%s", "workers expects a positive integer as parameter");
		return FALSE;
	}

	if (srv->worker_count != 0) {
		ERROR(srv, "workers already called with '%i', overwriting", srv->worker_count);
	}
	srv->worker_count = workers;
	return TRUE;
}

static gboolean core_module_load(server *srv, plugin* p, value *val) {
	value *mods = value_new_list();
	UNUSED(p);

	if (!g_module_supported()) {
		ERROR(srv, "%s", "module loading not supported on this platform");
		value_free(mods);
		return FALSE;
	}

	if (val->type == VALUE_STRING) {
		/* load only one module */
		value *name = value_new_string(value_extract(val).string);
		g_array_append_val(mods->data.list, name);
	} else if (val->type == VALUE_LIST) {
		/* load a list of modules */
		for (guint i = 0; i < val->data.list->len; i++) {
			value *v = g_array_index(val->data.list, value*, i);
			if (v->type != VALUE_STRING) {
				ERROR(srv, "module_load takes either a string or a list of strings as parameter, list with %s entry given", value_type_string(v->type));
				value_free(mods);
				return FALSE;
			}
		}
		g_array_free(mods->data.list, TRUE);
		mods->data.list = value_extract(val).list;
	} else {
		ERROR(srv, "module_load takes either a string or a list of strings as parameter, %s given", value_type_string(val->type));
		return FALSE;
	}

	/* parameter types ok, load modules */
	for (guint i = 0; i < mods->data.list->len; i++) {
		GString *name = g_array_index(mods->data.list, value*, i)->data.string;
		if (!module_load(srv->modules, name->str)) {
			ERROR(srv, "could not load module '%s': %s", name->str, g_module_error());
			value_free(mods);
			return FALSE;
		}

		DEBUG(srv, "loaded module '%s'", name->str);
	}

	value_free(mods);

	return TRUE;
}

static gboolean core_io_timeout(server *srv, plugin* p, value *val) {
	UNUSED(p);

	if (!val || val->type != VALUE_NUMBER || val->data.number < 1) {
		ERROR(srv, "%s", "io_timeout expects a positive number as parameter");
		return FALSE;
	}

	srv->io_timeout = value_extract(val).number;

	return TRUE;
}

static gboolean core_stat_cache_ttl(server *srv, plugin* p, value *val) {
	UNUSED(p);

	if (!val || val->type != VALUE_NUMBER || val->data.number < 1) {
		ERROR(srv, "%s", "stat_cache.ttl expects a positive number as parameter");
		return FALSE;
	}

	srv->stat_cache_ttl = (gdouble)value_extract(val).number;

	return TRUE;
}

/*
 * OPTIONS
 */

static gboolean core_option_log_parse(server *srv, plugin *p, size_t ndx, value *val, option_value *oval) {
	GHashTableIter iter;
	gpointer k, v;
	log_level_t level;
	GString *path;
	GString *level_str;
	GArray *arr = g_array_sized_new(FALSE, TRUE, sizeof(log_t*), 6);
	UNUSED(p);
	UNUSED(ndx);

	oval->list = arr;
	g_array_set_size(arr, 6);

	/* default value */
	if (!val) {
		/* default: log LOG_LEVEL_WARNING, LOG_LEVEL_ERROR and LOG_LEVEL_BACKEND to stderr */
		log_t *log = srv->logs.stderr;
		log_ref(srv, log);
		g_array_index(arr, log_t*, LOG_LEVEL_WARNING) = log;
		log_ref(srv, log);
		g_array_index(arr, log_t*, LOG_LEVEL_ERROR) = log;
		log_ref(srv, log);
		g_array_index(arr, log_t*, LOG_LEVEL_BACKEND) = log;
		return TRUE;
	}

	g_hash_table_iter_init(&iter, val->data.hash);
	while (g_hash_table_iter_next(&iter, &k, &v)) {
		if (((value*)v)->type != VALUE_STRING) {
			ERROR(srv, "log expects a hashtable with string values, %s given", value_type_string(((value*)v)->type));
			g_array_free(arr, TRUE);
			return FALSE;
		}

		path = ((value*)v)->data.string;
		level_str = (GString*)k;

		if (g_str_equal(level_str->str, "*")) {
			for (guint i = 0; i < arr->len; i++) {
				log_t *log;

				if (NULL != g_array_index(arr, log_t*, i))
					continue;
				log = log_new(srv, log_type_from_path(path), path);
				g_array_index(arr, log_t*, i) = log;
			}
		}
		else {
			log_t *log = log_new(srv, log_type_from_path(path), path);
			level = log_level_from_string(level_str);
			g_array_index(arr, log_t*, level) = log;
		}
	}

	return TRUE;
}

static void core_option_log_free(server *srv, plugin *p, size_t ndx, option_value oval) {
	GArray *arr = oval.list;
	UNUSED(p);
	UNUSED(ndx);

	if (!arr) return;

	for (guint i = 0; i < arr->len; i++) {
		if (NULL != g_array_index(arr, log_t*, i))
			log_unref(srv, g_array_index(arr, log_t*, i));
	}
	g_array_free(arr, TRUE);
}

static gboolean core_option_log_timestamp_parse(server *srv, plugin *p, size_t ndx, value *val, option_value *oval) {
	UNUSED(p);
	UNUSED(ndx);

	if (!val) return TRUE;
	oval->ptr = log_timestamp_new(srv, value_extract(val).string);

	return TRUE;
}

static void core_option_log_timestamp_free(server *srv, plugin *p, size_t ndx, option_value oval) {
	UNUSED(p);
	UNUSED(ndx);

	if (!oval.ptr) return;