Added a new module, res_phoneprov, which allows auto-provisioning of phones

based on configuration templates that use Asterisk dialplan function and
variable substitution.  It should be possible to create phone profiles and
templates that work for the majority of phones provisioned over http. It
is currently only intended to provision a single user account per phone.
An example profile and set of templates for Polycom phones is provided.
NOTE: Polycom firmware is not included, but should be placed in
AST_DATA_DIR/phoneprov/configs to match up with the included templates.



git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@97634 65c4cc65-6c06-0410-ace0-fbb531ad65f3

1 files changed, 1012 insertions, 0 deletions

diff --git a/res/res_phoneprov.c b/res/res_phoneprov.c
new file mode 100644
index 000000000..f03c4919c
--- /dev/null
+++ b/res/res_phoneprov.c
@@ -0,0 +1,1012 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 1999 - 2008, Digium, Inc.
+ *
+ * Mark Spencer <markster@digium.com>
+ * Matthew Brooks <mbrooks@digium.com>
+ * Terry Wilson <twilson@digium.com>
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \Phone provisioning application for the asterisk internal http server
+ *
+ * \author Matthew Brooks <mbrooks@digium.com>
+ * \author Terry Wilson <twilson@digium.com>
+ */
+
+#include "asterisk.h"
+
+#include <sys/ioctl.h>
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision: 96773 $")
+
+#include "asterisk/file.h"
+#include "asterisk/paths.h"
+#include "asterisk/pbx.h"
+#include "asterisk/cli.h"
+#include "asterisk/module.h"
+#include "asterisk/http.h"
+#include "asterisk/utils.h"
+#include "asterisk/app.h"
+#include "asterisk/strings.h"
+#include "asterisk/stringfields.h"
+#include "asterisk/options.h"
+#include "asterisk/config.h"
+#include "asterisk/acl.h"
+#include "asterisk/astobj2.h"
+#include "asterisk/version.h"
+
+#ifdef LOW_MEMORY
+#define MAX_PROFILE_BUCKETS 1
+#define MAX_ROUTE_BUCKETS 1
+#else
+#define MAX_PROFILE_BUCKETS 17
+#define MAX_ROUTE_BUCKETS 563
+#endif /* LOW_MEMORY */
+
+#define VAR_BUF_SIZE 4096
+
+/*! \brief for use in lookup_iface */
+struct my_ifreq {
+	char ifrn_name[IFNAMSIZ];	/* Interface name, e.g. "eth0", "ppp0", etc.  */
+	struct sockaddr_in ifru_addr;
+};
+
+/*! \brief for use in lookup_iface */
+static struct in_addr __ourip = { .s_addr = 0x00000000, };
+
+/* \note This enum and the pp_variable_list must be in the same order or
+ * bad things happen! */
+enum pp_variables {
+	PP_MACADDRESS,
+	PP_USERNAME,
+	PP_FULLNAME,
+	PP_SECRET,
+	PP_LABEL,
+	PP_CALLERID,
+	PP_TIMEZONE,
+	PP_VAR_LIST_LENGTH,	/* This entry must always be the last in the list */
+};
+
+/*! \brief Lookup table to translate between users.conf property names and
+ * variables for use in phoneprov templates */
+static const struct pp_variable_lookup {
+	enum pp_variables id;
+	const char * const user_var;
+	const char * const template_var;
+} pp_variable_list[] = {
+	{ PP_MACADDRESS, "macaddress", "MAC" },
+	{ PP_USERNAME, "username", "USERNAME" },
+	{ PP_FULLNAME, "fullname", "DISPLAY_NAME" },
+	{ PP_SECRET, "secret", "SECRET" },
+	{ PP_LABEL, "label", "LABEL" },
+	{ PP_CALLERID, "cid_number", "CALLERID" },
+	{ PP_TIMEZONE, "timezone", "TIMEZONE" },
+};
+
+/*! \brief structure to hold file data */
+struct phoneprov_file {
+	AST_DECLARE_STRING_FIELDS(
+		AST_STRING_FIELD(format);	/*!< After variable substitution, becomes route->uri */
+		AST_STRING_FIELD(template); /*!< Template/physical file location */
+		AST_STRING_FIELD(mime_type);/*!< Mime-type of the file */
+	);
+	AST_LIST_ENTRY(phoneprov_file) entry;
+};
+
+/*! \brief structure to hold phone profiles read from phoneprov.conf */
+struct phone_profile {
+	AST_DECLARE_STRING_FIELDS(
+		AST_STRING_FIELD(name);	/*!< Name of phone profile */
+		AST_STRING_FIELD(default_mime_type);	/*!< Default mime type if it isn't provided */
+		AST_STRING_FIELD(staticdir);	/*!< Subdirectory that static files are stored in */
+	);
+	struct varshead *headp;	/*!< List of variables set with 'setvar' in phoneprov.conf */
+	AST_LIST_HEAD_NOLOCK(, phoneprov_file) static_files;	/*!< List of static files */
+	AST_LIST_HEAD_NOLOCK(, phoneprov_file) dynamic_files;	/*!< List of dynamic files */
+};
+
+/*! \brief structure to hold users read from users.conf */
+struct user {
+	AST_DECLARE_STRING_FIELDS(
+		AST_STRING_FIELD(name);	/*!< Name of user */
+		AST_STRING_FIELD(macaddress);	/*!< Mac address of user's phone */
+	);
+	struct phone_profile *profile;	/*!< Profile the phone belongs to */
+	struct varshead *headp;	/*!< List of variables to substitute into templates */
+	AST_LIST_ENTRY(user) entry;
+};
+
+/*! \brief structure to hold http routes (valid URIs, and the files they link to) */
+struct http_route {
+	AST_DECLARE_STRING_FIELDS(
+		AST_STRING_FIELD(uri);	/*!< The URI requested */
+	);
+	struct phoneprov_file *file;	/*!< The file that links to the URI */
+	struct user *user;	/*!< The user that has variables to substitute into the file
+						 * NULL in the case of a static route */
+};
+
+static struct ao2_container *profiles;
+static struct ao2_container *http_routes;
+AST_RWLIST_HEAD_STATIC(users, user);
+
+/*! \brief Extensions whose mime types we think we know */
+static struct {
+	char *ext;
+	char *mtype;
+} mimetypes[] = {
+	{ "png", "image/png" },
+	{ "xml", "text/xml" },
+	{ "jpg", "image/jpeg" },
+	{ "js", "application/x-javascript" },
+	{ "wav", "audio/x-wav" },
+	{ "mp3", "audio/mpeg" },
+};
+
+char global_server[80] = "";	/*!< Server to substitute into templates */
+char global_serverport[6] = "5060";	/*!< Server port to substitute into templates */
+char global_default_profile[80] = "";	/*!< Default profile to use if one isn't specified */	
+
+/*! \brief List of global variables currently available: VOICEMAIL_EXTEN, EXTENSION_LENGTH */
+struct varshead global_variables;
+
+/*! \brief Return mime type based on extension */
+static char *ftype2mtype(const char *ftype)
+{
+	int x;
+
+	if (ast_strlen_zero(ftype))
+		return NULL;
+
+	for (x = 0;x < ARRAY_LEN(mimetypes);x++) {
+		if (!strcasecmp(ftype, mimetypes[x].ext))
+			return mimetypes[x].mtype;
+	}
+	
+	return NULL;
+}
+
+/* iface is the interface (e.g. eth0); address is the return value */
+static int lookup_iface(const char *iface, struct in_addr *address)
+{
+	int mysock, res = 0;
+	struct my_ifreq ifreq;
+
+	memset(&ifreq, 0, sizeof(ifreq));
+	ast_copy_string(ifreq.ifrn_name, iface, sizeof(ifreq.ifrn_name));
+
+	mysock = socket(PF_INET, SOCK_DGRAM, IPPROTO_IP);
+	if (mysock < 0) {
+		ast_log(LOG_ERROR, "Failed to create socket: %s\n", strerror(errno));
+		return -1;
+	}
+
+	res = ioctl(mysock, SIOCGIFADDR, &ifreq);
+
+	close(mysock);
+
+	if (res < 0) {
+		ast_log(LOG_WARNING, "Unable to get IP of %s: %s\n", iface, strerror(errno));
+		memcpy(address, &__ourip, sizeof(__ourip));
+		return -1;
+	} else {
+		memcpy(address, &ifreq.ifru_addr.sin_addr, sizeof(ifreq.ifru_addr.sin_addr));
+		return 0;
+	}
+}
+
+static struct phone_profile *unref_profile(struct phone_profile *prof)
+{
+	ao2_ref(prof, -1);
+
+	return NULL;
+}
+
+/*! \brief Return a phone profile looked up by name */
+static struct phone_profile *find_profile(const char *name)
+{
+	struct phone_profile tmp = {
+		.name = name,
+	};
+
+	return ao2_find(profiles, &tmp, OBJ_POINTER);
+}
+
+static int profile_hash_fn(const void *obj, const int flags)
+{
+	const struct phone_profile *profile = obj;
+	
+	return ast_str_hash(profile->name);
+}
+
+static int profile_cmp_fn(void *obj, void *arg, int flags)
+{
+	const struct phone_profile *profile1 = obj, *profile2 = arg;
+
+	return !strcasecmp(profile1->name, profile2->name) ? CMP_MATCH : 0;
+}
+
+static void delete_file(struct phoneprov_file *file)
+{
+	ast_string_field_free_memory(file);
+	free(file);
+}
+
+static void profile_destructor(void *obj)
+{
+	struct phone_profile *profile = obj;
+	struct phoneprov_file *file;
+	struct ast_var_t *var;
+
+	while ((file = AST_LIST_REMOVE_HEAD(&profile->static_files, entry)))
+		delete_file(file);
+
+	while ((file = AST_LIST_REMOVE_HEAD(&profile->dynamic_files, entry)))
+		delete_file(file);
+
+	while ((var = AST_LIST_REMOVE_HEAD(profile->headp, entries)))
+		ast_var_delete(var);
+
+	free(profile->headp);
+	ast_string_field_free_memory(profile);
+}
+
+static struct http_route *unref_route(struct http_route *route)
+{
+	ao2_ref(route, -1);
+
+	return NULL;
+}
+
+static int routes_hash_fn(const void *obj, const int flags)
+{
+	const struct http_route *route = obj;
+	
+	return ast_str_hash(route->uri);
+}
+
+static int routes_cmp_fn(void *obj, void *arg, int flags)
+{
+	const struct http_route *route1 = obj, *route2 = arg;
+
+	return !strcmp(route1->uri, route2->uri) ? CMP_MATCH : 0;
+}
+
+static void route_destructor(void *obj)
+{
+	struct http_route *route = obj;
+
+	ast_string_field_free_memory(route);
+}
+
+/*! \brief Read a TEXT file into a string and return the length */
+static int load_file(const char *filename, char **ret)
+{
+	int len = 0;
+	FILE *f;
+	
+	if (!(f = fopen(filename, "r"))) {
+		*ret = NULL;
+		return -1;
+	}
+
+	fseek(f, 0, SEEK_END);
+	len = ftell(f);
+	fseek(f, 0, SEEK_SET);
+	if (!(*ret = ast_malloc(len + 1)))
+		return -2;
+
+	if (len != fread(*ret, sizeof(char), len, f)) {
+		free(*ret);
+		*ret = NULL;
+		return -3;
+	}
+
+	fclose(f);
+
+	(*ret)[len] = '\0';
+
+	return len;
+}
+
+/*! \brief Callback that is executed everytime an http request is received by this module */
+static struct ast_str *phoneprov_callback(struct server_instance *ser, const char *uri, struct ast_variable *vars, int *status, char **title, int *contentlength)
+{
+	struct http_route *route;
+	struct http_route search_route = {
+		.uri = uri,
+	};
+	struct ast_str *result = ast_str_create(512);
+	char path[PATH_MAX];
+	char *file = NULL;
+	int len;
+	int fd;
+	char buf[256];
+	struct timeval tv = ast_tvnow();
+	struct ast_tm tm;
+
+	if (!(route = ao2_find(http_routes, &search_route, OBJ_POINTER)))
+		goto out404;
+
+	snprintf(path, sizeof(path), "%s/phoneprov/%s", ast_config_AST_DATA_DIR, route->file->template);
+
+	if (!route->user) { /* Static file */
+
+		fd = open(path, O_RDONLY);
+		if (fd < 0)
+			goto out500;
+
+		len = lseek(fd, 0, SEEK_END);
+		lseek(fd, 0, SEEK_SET);
+		if (len < 0) {
+			ast_log(LOG_WARNING, "Could not load file: %s (%d)\n", path, len);
+			close(fd);
+			goto out500;
+		}
+
+		ast_strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S %Z", ast_localtime(&tv, &tm, "GMT"));
+	    fprintf(ser->f, "HTTP/1.1 200 OK\r\n"
+			"Server: Asterisk/%s\r\n"
+			"Date: %s\r\n"
+			"Connection: close\r\n"
+			"Cache-Control: no-cache, no-store\r\n"
+			"Content-Length: %d\r\n"
+			"Content-Type: %s\r\n\r\n",
+			ast_get_version(), buf, len, route->file->mime_type);
+		
+		while ((len = read(fd, buf, sizeof(buf))) > 0)
+			fwrite(buf, 1, len, ser->f);
+
+		close(fd);
+		route = unref_route(route);
+		return NULL;
+	} else { /* Dynamic file */
+		int bufsize;
+		char *tmp;
+
+		len = load_file(path, &file);
+		if (len < 0) {
+			ast_log(LOG_WARNING, "Could not load file: %s (%d)\n", path, len);
+			if (file)
+				ast_free(file);
+			goto out500;
+		}
+
+		if (!file)
+			goto out500;
+
+		/* XXX This is a hack -- maybe sum length of all variables in route->user->headp and add that? */
+ 		bufsize = len + VAR_BUF_SIZE;
+		
+		/* malloc() instead of alloca() here, just in case the file is bigger than
+		 * we have enough stack space for. */
+		if (!(tmp = ast_calloc(1, bufsize))) {
+			if (file)
+				ast_free(file);
+			goto out500;
+		}
+
+		pbx_substitute_variables_varshead(route->user->headp, file, tmp, bufsize);
+	
+		if (file)
+			ast_free(file);
+
+		ast_str_append(&result, 0,
+			"Content-Type: %s\r\n"
+			"Content-length: %d\r\n"
+			"\r\n"
+			"%s", route->file->mime_type, (int) strlen(tmp), tmp);
+
+		if (tmp)
+			ast_free(tmp);
+
+		route = unref_route(route);
+
+		return result;
+	}
+
+out404:
+	*status = 404;
+	*title = strdup("Not Found");
+	*contentlength = 0;
+	return ast_http_error(404, "Not Found", NULL, "Nothing to see here.  Move along.");
+
+out500:
+	route = unref_route(route);
+	*status = 500;
+	*title = strdup("Internal Server Error");
+	*contentlength = 0;
+	return ast_http_error(500, "Internal Error", NULL, "An internal error has occured.");
+}
+
+/*! \brief Build a route structure and add it to the list of available http routes
+	\param pp_file File to link to the route
+	\param user User to link to the route (NULL means static route)
+	\param uri URI of the route
+*/
+static void build_route(struct phoneprov_file *pp_file, struct user *user, char *uri)
+{
+	struct http_route *route;
+	
+	if (!(route = ao2_alloc(sizeof(*route), route_destructor)))
+		return;
+
+	if (ast_string_field_init(route, 32)) {
+		ast_log(LOG_ERROR, "Couldn't create string fields for %s\n", pp_file->format);
+		route = unref_route(route);
+		return;
+	}
+
+	ast_string_field_set(route, uri, S_OR(uri, pp_file->format));
+	route->user = user;
+	route->file = pp_file;
+
+	ao2_link(http_routes, route);
+
+	route = unref_route(route);
+}
+
+/*! \brief Build a phone profile and add it to the list of phone profiles
+	\param name the name of the profile
+	\param v ast_variable from parsing phoneprov.conf
+*/
+static void build_profile(const char *name, struct ast_variable *v)
+{
+	struct phone_profile *profile;
+	struct ast_var_t *var;
+
+	if (!(profile = ao2_alloc(sizeof(*profile), profile_destructor)))
+		return;
+
+	if (ast_string_field_init(profile, 32)) {
+		profile = unref_profile(profile);
+		return;
+	}
+	
+	if (!(profile->headp = ast_calloc(1, sizeof(*profile->headp)))) {
+		profile = unref_profile(profile);
+		return;
+	}
+
+	AST_LIST_HEAD_INIT_NOLOCK(&profile->static_files);
+	AST_LIST_HEAD_INIT_NOLOCK(&profile->dynamic_files);
+
+	ast_string_field_set(profile, name, name);
+	for (; v; v = v->next) {
+		if (!strcasecmp(v->name, "mime_type")) {
+			ast_string_field_set(profile, default_mime_type, v->value);
+		} else if (!strcasecmp(v->name, "setvar")) {
+			struct ast_var_t *var;
+			char *value_copy = ast_strdupa(v->value);
+
+			AST_DECLARE_APP_ARGS(args,
+				AST_APP_ARG(varname);
+				AST_APP_ARG(varval);
+			);
+			
+			AST_NONSTANDARD_APP_ARGS(args, value_copy, '=');
+			do {
+				if (ast_strlen_zero(args.varname) || ast_strlen_zero(args.varval))
+					break;
+				args.varname = ast_strip(args.varname);
+				args.varval = ast_strip(args.varval);
+				if (ast_strlen_zero(args.varname) || ast_strlen_zero(args.varval))
+					break;
+				if ((var = ast_var_assign(args.varname, args.varval)))
+					AST_LIST_INSERT_TAIL(profile->headp, var, entries);
+			} while (0);
+		} else if (!strcasecmp(v->name, "staticdir")) {
+			ast_string_field_set(profile, staticdir, v->value);
+		} else {
+			struct phoneprov_file *pp_file;
+			char *file_extension;
+			char *value_copy = ast_strdupa(v->value); 
+
+			AST_DECLARE_APP_ARGS(args,
+				AST_APP_ARG(filename);
+				AST_APP_ARG(mimetype);
+			);
+
+			if (!(pp_file = ast_calloc(1, sizeof(*pp_file)))) {
+				profile = unref_profile(profile);
+				return;
+			}
+			if (ast_string_field_init(pp_file, 32)) {
+				ast_free(pp_file);
+				profile = unref_profile(profile);
+				return;
+			}
+
+			if ((file_extension = strrchr(pp_file->format, '.')))
+				file_extension++;
+
+			AST_STANDARD_APP_ARGS(args, value_copy);
+
+			/* Mime type order of preference
+			 * 1) Specific mime-type defined for file in profile
+			 * 2) Mime determined by extension
+			 * 3) Default mime type specified in profile
+			 * 4) text/plain
+			 */
+			ast_string_field_set(pp_file, mime_type, S_OR(args.mimetype, (S_OR(S_OR(ftype2mtype(file_extension), profile->default_mime_type), "text/plain"))));
+
+			if (!strcasecmp(v->name, "static_file")) {
+				ast_string_field_set(pp_file, format, args.filename);
+				ast_string_field_build(pp_file, template, "%s%s", profile->staticdir, args.filename);
+				AST_LIST_INSERT_TAIL(&profile->static_files, pp_file, entry);
+				/* Add a route for the static files, as their filenames won't change per-user */
+				build_route(pp_file, NULL, NULL);
+			} else {
+				ast_string_field_set(pp_file, format, v->name);
+				ast_string_field_set(pp_file, template, args.filename);
+				AST_LIST_INSERT_TAIL(&profile->dynamic_files, pp_file, entry);
+			}
+		}
+	}
+
+	/* Append the global variables to the variables list for this profile.
+	 * This is for convenience later, when we need to provide a single
+	 * variable list for use in substitution. */
+	AST_LIST_TRAVERSE(&global_variables, var, entries) {
+		struct ast_var_t *new_var;
+		if ((new_var = ast_var_assign(var->name, var->value)))
+			AST_LIST_INSERT_TAIL(profile->headp, new_var, entries);
+	}
+
+	ao2_link(profiles, profile);
+
+	profile = unref_profile(profile);
+}
+
+/*! \brief Free all memory associated with a user */
+static void delete_user(struct user *user)
+{
+	struct ast_var_t *var;
+
+	while ((var = AST_LIST_REMOVE_HEAD(user->headp, entries)))
+		ast_var_delete(var);
+
+	ast_free(user->headp);
+	ast_string_field_free_memory(user);
+	user->profile = unref_profile(user->profile);
+	free(user);
+}
+
+/*! \brief Destroy entire user list */
+static void delete_users(void)
+{
+	struct user *user;
+
+	AST_RWLIST_WRLOCK(&users);
+	while ((user = AST_LIST_REMOVE_HEAD(&users, entry)))
+		delete_user(user);
+	AST_RWLIST_UNLOCK(&users);
+}
+
+/*! \brief Set all timezone-related variables based on a zone (i.e. America/New_York)
+	\param headp pointer to list of user variables
+	\param zone A time zone. NULL sets variables based on timezone of the machine
+*/
+static void set_timezone_variables(struct varshead *headp, const char *zone)
+{
+	time_t utc_time;
+	int dstenable;
+	time_t dststart;
+	time_t dstend;
+	struct ast_tm tm_info;
+	int tzoffset;
+	char buffer[21];
+	struct ast_var_t *var;
+	struct timeval tv;
+
+	time(&utc_time);
+	ast_get_dst_info(&utc_time, &dstenable, &dststart, &dstend, &tzoffset, zone);
+	snprintf(buffer, sizeof(buffer), "%d", tzoffset);
+	var = ast_var_assign("TZOFFSET", buffer);
+	if (var)
+		AST_LIST_INSERT_TAIL(headp, var, entries); 
+
+	if (!dstenable)
+		return;
+
+	if ((var = ast_var_assign("DST_ENABLE", "1")))
+		AST_LIST_INSERT_TAIL(headp, var, entries);
+
+	tv.tv_sec = dststart; 
+	ast_localtime(&tv, &tm_info, zone);
+
+	snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mon+1);
+	if ((var = ast_var_assign("DST_START_MONTH", buffer)))
+		AST_LIST_INSERT_TAIL(headp, var, entries);
+
+	snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mday);
+	if ((var = ast_var_assign("DST_START_MDAY", buffer)))
+		AST_LIST_INSERT_TAIL(headp, var, entries);
+
+	snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_hour);
+	if ((var = ast_var_assign("DST_START_HOUR", buffer)))
+		AST_LIST_INSERT_TAIL(headp, var, entries);
+
+	tv.tv_sec = dstend;
+	ast_localtime(&tv, &tm_info, zone);
+
+	snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mon + 1);
+	if ((var = ast_var_assign("DST_END_MONTH", buffer)))
+		AST_LIST_INSERT_TAIL(headp, var, entries);
+
+	snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mday);
+	if ((var = ast_var_assign("DST_END_MDAY", buffer)))
+		AST_LIST_INSERT_TAIL(headp, var, entries);
+
+	snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_hour);
+	if ((var = ast_var_assign("DST_END_HOUR", buffer)))
+		AST_LIST_INSERT_TAIL(headp, var, entries);
+}
+
+/*! \brief Build and return a user structure based on gathered config data */
+static struct user *build_user(struct ast_config *cfg, const char *name, const char *mac, struct phone_profile *profile)
+{
+	struct user *user;
+	struct ast_var_t *var;
+	const char *tmp;
+	int i;
+	
+	if (!(user = ast_calloc(1, sizeof(*user)))) {
+		profile = unref_profile(profile);
+		return NULL;
+	}
+	
+	if (!(user->headp = ast_calloc(1, sizeof(*user->headp)))) {
+		profile = unref_profile(profile);
+		ast_free(user);
+		return NULL;
+	}
+
+	if (ast_string_field_init(user, 32)) {
+		profile = unref_profile(profile);
+		delete_user(user);
+		return NULL;
+	}
+
+	ast_string_field_set(user, name, name);
+	ast_string_field_set(user, macaddress, mac);
+	user->profile = profile; /* already ref counted by find_profile */
+
+	for (i = 0; i < PP_VAR_LIST_LENGTH; i++) {
+		tmp = ast_variable_retrieve(cfg, name, pp_variable_list[i].user_var);
+
+		if (i == PP_TIMEZONE) {
+			/* perfectly ok if tmp is NULL, will set variables based on server's time zone */
+			set_timezone_variables(user->headp, tmp);
+		}
+
+		if (tmp && (var = ast_var_assign(pp_variable_list[i].template_var, tmp)))
+			AST_LIST_INSERT_TAIL(user->headp, var, entries);
+	}
+
+	if (!ast_strlen_zero(global_server)) {
+		if ((var = ast_var_assign("SERVER", global_server)))
+			AST_LIST_INSERT_TAIL(user->headp, var, entries);
+		if (!ast_strlen_zero(global_serverport)) {
+			if ((var = ast_var_assign("SERVER_PORT", global_serverport)))
+				AST_LIST_INSERT_TAIL(user->headp, var, entries);
+		}
+	}
+
+	/* Append profile variables here, and substitute variables on profile
+	 * setvars, so that we can use user specific variables in them */
+	AST_LIST_TRAVERSE(user->profile->headp, var, entries) {
+		char expand_buf[VAR_BUF_SIZE] = {0,};
+		struct ast_var_t *var2;
+
+		pbx_substitute_variables_varshead(user->headp, var->value, expand_buf, sizeof(expand_buf));
+		if ((var2 = ast_var_assign(var->name, expand_buf)))
+			AST_LIST_INSERT_TAIL(user->headp, var2, entries);
+	}
+
+	return user;
+}
+
+/*! \brief Add an http route for dynamic files attached to the profile of the user */
+static int build_user_routes(struct user *user)
+{
+	struct phoneprov_file *pp_file;
+
+	AST_LIST_TRAVERSE(&user->profile->dynamic_files, pp_file, entry) {
+		char expand_buf[VAR_BUF_SIZE] = { 0, };
+
+		pbx_substitute_variables_varshead(user->headp, pp_file->format, expand_buf, sizeof(expand_buf));
+		build_route(pp_file, user, expand_buf);
+	}
+
+	return 0;
+}
+
+/* \brief Parse config files and create appropriate structures */
+static int set_config(void)
+{
+	struct ast_config *phoneprov_cfg, *users_cfg;
+	char *cat;
+	struct ast_variable *v;
+	struct ast_flags config_flags = { 0 };
+
+	if (!(phoneprov_cfg = ast_config_load("phoneprov.conf", config_flags))) {
+		ast_log(LOG_ERROR, "Unable to load config phoneprov.conf\n");
+		return -1;
+	}
+
+	cat = NULL;
+	while ((cat = ast_category_browse(phoneprov_cfg, cat))) {
+		if (!strcasecmp(cat, "general")) {
+			for (v = ast_variable_browse(phoneprov_cfg, cat); v; v = v->next) {
+				if (!strcasecmp(v->name, "serveraddr"))
+					ast_copy_string(global_server, v->value, sizeof(global_server));
+				else if (!strcasecmp(v->name, "serveriface")) {
+					struct in_addr addr;
+					lookup_iface(v->value, &addr);
+					ast_copy_string(global_server, ast_inet_ntoa(addr), sizeof(global_server));
+				} else if (!strcasecmp(v->name, "serverport"))
+					ast_copy_string(global_serverport, v->value, sizeof(global_serverport));
+				else if (!strcasecmp(v->name, "default_profile"))
+					ast_copy_string(global_default_profile, v->value, sizeof(global_default_profile));
+			}
+			if (ast_strlen_zero(global_server))
+				ast_log(LOG_WARNING, "No serveraddr/serveriface set in phoneprov.conf.  Breakage likely.\n");
+		} else 
+			build_profile(cat, ast_variable_browse(phoneprov_cfg, cat));
+	}
+
+	ast_config_destroy(phoneprov_cfg);
+
+	if (!(users_cfg = ast_config_load("users.conf", config_flags))) {
+		ast_log(LOG_WARNING, "Unable to load users.cfg\n");
+		return 0;
+	}
+
+	cat = NULL;
+	while ((cat = ast_category_browse(users_cfg, cat))) {
+		const char *tmp, *mac;
+		struct user *user;
+		struct phone_profile *profile;
+		struct ast_var_t *var;
+
+		if (!strcasecmp(cat, "general")) {
+			for (v = ast_variable_browse(users_cfg, cat); v; v = v->next) {
+				if (!strcasecmp(v->name, "vmexten")) {
+					if ((var = ast_var_assign("VOICEMAIL_EXTEN", v->value)))
+						AST_LIST_INSERT_TAIL(&global_variables, var, entries);
+				}
+				if (!strcasecmp(v->name, "localextenlength")) {
+					if ((var = ast_var_assign("EXTENSION_LENGTH", v->value)))
+						AST_LIST_INSERT_TAIL(&global_variables, var, entries);
+				}
+			}
+		}
+			  
+		if (!strcasecmp(cat, "authentication"))
+			continue;
+
+		if (!((tmp = ast_variable_retrieve(users_cfg, cat, "autoprov")) && ast_true(tmp)))	
+			continue;
+
+		if (!(mac = ast_variable_retrieve(users_cfg, cat, "macaddress"))) {
+			ast_log(LOG_WARNING, "autoprov set for %s, but no mac address - skipping.\n", cat);
+			continue;
+		}
+
+		tmp = S_OR(ast_variable_retrieve(users_cfg, cat, "profile"), global_default_profile);
+		if (ast_strlen_zero(tmp)) {
+			ast_log(LOG_WARNING, "No profile for user [%s] with mac '%s' - skipping\n", cat, mac);
+			continue;
+		}
+
+		if (!(profile = find_profile(tmp))) {
+			ast_log(LOG_WARNING, "Could not look up profile '%s' - skipping.\n", tmp);
+			continue;
+		}
+
+		if (!(user = build_user(users_cfg, cat, mac, profile))) {
+			ast_log(LOG_WARNING, "Could not create user %s - skipping.\n", cat);
+			continue;
+		}
+
+		if (build_user_routes(user)) {
+			ast_log(LOG_WARNING, "Could not create http routes for %s - skipping\n", user->name);
+			delete_user(user);
+			continue;
+		}
+
+		AST_RWLIST_WRLOCK(&users);
+		AST_RWLIST_INSERT_TAIL(&users, user, entry);
+		AST_RWLIST_UNLOCK(&users);
+	}
+
+	ast_config_destroy(users_cfg);
+
+	return 0;
+}
+
+/*! \brief Delete all http routes, freeing their memory */
+static void delete_routes(void)
+{
+	struct ao2_iterator i;
+	struct http_route *route;
+	
+	i = ao2_iterator_init(http_routes, 0);
+	while ((route = ao2_iterator_next(&i))) {
+		ao2_unlink(http_routes, route);
+		route = unref_route(route);
+	}
+}
+
+/*! \brief Delete all phone profiles, freeing their memory */
+static void delete_profiles(void)
+{
+	struct ao2_iterator i;
+	struct phone_profile *profile;
+
+	i = ao2_iterator_init(profiles, 0);
+	while ((profile = ao2_iterator_next(&i))) {
+		ao2_unlink(profiles, profile);
+		profile = unref_profile(profile);
+	}
+}
+
+/*! \brief A dialplan function that can be used to print a string for each phoneprov user */
+static int pp_each_user_exec(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
+{
+	char *tmp, expand_buf[VAR_BUF_SIZE] = {0,};
+	struct user *user;
+	AST_DECLARE_APP_ARGS(args,
+		AST_APP_ARG(string);
+		AST_APP_ARG(exclude_mac);
+	);
+	AST_STANDARD_APP_ARGS(args, data);
+
+	/* Fix data by turning %{ into ${ */
+	while ((tmp = strstr(args.string, "%{")))
+		*tmp = '$';
+
+	AST_RWLIST_RDLOCK(&users);
+	AST_RWLIST_TRAVERSE(&users, user, entry) {
+		if (!ast_strlen_zero(args.exclude_mac) && !strcasecmp(user->macaddress, args.exclude_mac))
+			continue;
+		pbx_substitute_variables_varshead(user->headp, args.string, expand_buf, sizeof(expand_buf));
+		ast_build_string(&buf, &len, expand_buf);
+	}
+	AST_RWLIST_UNLOCK(&users);
+
+	return 0;
+}
+
+static struct ast_custom_function pp_each_user_function = {
+	.name = "PP_EACH_USER",
+	.synopsis = "Generate a string for each phoneprov user",
+	.syntax = "PP_EACH_USER(<string>|<exclude_mac>)",
+	.desc =
+		"Pass in a string, with phoneprov variables you want substituted in the format of\n"
+		"%{VARNAME}, and you will get the string rendered for each user in phoneprov\n"
+		"excluding ones with MAC address <exclude_mac>. Probably not useful outside of\n"
+		"res_phoneprov.\n"
+		"\nExample: ${PP_EACH_USER(<item><fn>%{DISPLAY_NAME}</fn></item>|${MAC})",
+	.read = pp_each_user_exec,
+};
+
+/*! \brief CLI command to list static and dynamic routes */
+static char *handle_show_routes(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
+{
+#define FORMAT "%-40.40s  %-30.30s\n"
+	struct ao2_iterator i;
+	struct http_route *route;
+	
+	switch(cmd) {
+	case CLI_INIT:
+		e->command = "phoneprov show routes";
+		e->usage =
+			"Usage: phoneprov show routes\n"
+			"       Lists all registered phoneprov http routes.\n";
+		return NULL;
+	case CLI_GENERATE:
+		return NULL;
+	}
+
+	/* This currently iterates over routes twice, but it is the only place I've needed
+	 * to really separate static an dynamic routes, so I've just left it this way. */
+	ast_cli(a->fd, "Static routes\n\n");
+	ast_cli(a->fd, FORMAT, "Relative URI", "Physical location");
+	i = ao2_iterator_init(http_routes, 0);
+	while ((route = ao2_iterator_next(&i))) {
+		if (!route->user)
+			ast_cli(a->fd, FORMAT, route->uri, route->file->template);
+		route = unref_route(route);
+	}
+
+	ast_cli(a->fd, "\nDynamic routes\n\n");
+	ast_cli(a->fd, FORMAT, "Relative URI", "Template");
+
+	i = ao2_iterator_init(http_routes, 0);
+	while ((route = ao2_iterator_next(&i))) {
+		if (route->user)
+			ast_cli(a->fd, FORMAT, route->uri, route->file->template);
+		route = unref_route(route);
+	}
+
+	return CLI_SUCCESS;
+}
+
+static struct ast_cli_entry pp_cli[] = {
+	AST_CLI_DEFINE(handle_show_routes, "Show registered phoneprov http routes"),
+};
+
+static struct ast_http_uri phoneprovuri = {
+	.callback = phoneprov_callback,
+	.description = "Asterisk HTTP Phone Provisioning Tool",
+	.uri = "phoneprov",
+	.has_subtree = 1,
+};
+
+static int load_module(void)
+{
+	profiles = ao2_container_alloc(MAX_PROFILE_BUCKETS, profile_hash_fn, profile_cmp_fn);
+
+	http_routes = ao2_container_alloc(MAX_ROUTE_BUCKETS, routes_hash_fn, routes_cmp_fn);
+
+	AST_LIST_HEAD_INIT_NOLOCK(&global_variables);
+	
+	ast_custom_function_register(&pp_each_user_function);
+	ast_cli_register_multiple(pp_cli, ARRAY_LEN(pp_cli));
+
+	set_config();
+	ast_http_uri_link(&phoneprovuri); 
+
+	return 0;
+}
+
+static int unload_module(void)
+{
+	struct ast_var_t *var;
+
+	ast_http_uri_unlink(&phoneprovuri);
+	ast_custom_function_unregister(&pp_each_user_function);
+	ast_cli_unregister_multiple(pp_cli, ARRAY_LEN(pp_cli));
+
+	delete_routes();
+	delete_users();
+	delete_profiles();
+	ao2_ref(profiles, -1);
+	ao2_ref(http_routes, -1);
+
+	while ((var = AST_LIST_REMOVE_HEAD(&global_variables, entries)))
+		ast_var_delete(var);
+
+	return 0;
+}
+
+static int reload(void) 
+{
+	delete_routes();
+	delete_users();
+	delete_profiles();
+	set_config();
+
+	return 0;
+}
+
+AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "HTTP Phone Provisioning",
+		.load = load_module,
+		.unload = unload_module,
+		.reload = reload,
+	);