Asterisk data retrieval API.

This module implements an abstraction for retrieving and exporting
asterisk data.
Developed by:
	Brett Bryant <brettbryant@gmail.com>
	Eliel C. Sardanons (LU1ALY) <eliels@gmail.com>
For the Google Summer of code 2009 Project.
Documentation can be found in doxygen format and inside the
header include/asterisk/data.h

Review: https://reviewboard.asterisk.org/r/275/



git-svn-id: http://svn.digium.com/svn/asterisk/trunk@258517 f38db490-d61c-443f-a65b-d21fe96a405b

2 files changed, 482 insertions, 0 deletions

diff --git a/apps/app_queue.c b/apps/app_queue.c
index e689cb080..bc1ca969e 100644
--- a/apps/app_queue.c
+++ b/apps/app_queue.c
@@ -96,6 +96,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/taskprocessor.h"
 #include "asterisk/callerid.h"
 #include "asterisk/cel.h"
+#include "asterisk/data.h"
 
 /* Define, to debug reference counts on queues, without debugging reference counts on queue members */
 /* #define REF_DEBUG_ONLY_QUEUES */
@@ -7616,6 +7617,281 @@ static struct ast_cli_entry cli_queue[] = {
 	AST_CLI_DEFINE(handle_queue_reset, "Reset statistics for a queue"),
 };
 
+/* struct call_queue astdata mapping. */
+#define DATA_EXPORT_CALL_QUEUE(MEMBER)					\
+	MEMBER(call_queue, name, AST_DATA_STRING)			\
+	MEMBER(call_queue, moh, AST_DATA_STRING)			\
+	MEMBER(call_queue, announce, AST_DATA_STRING)			\
+	MEMBER(call_queue, context, AST_DATA_STRING)			\
+	MEMBER(call_queue, membermacro, AST_DATA_STRING)		\
+	MEMBER(call_queue, membergosub, AST_DATA_STRING)		\
+	MEMBER(call_queue, defaultrule, AST_DATA_STRING)		\
+	MEMBER(call_queue, sound_next, AST_DATA_STRING)			\
+	MEMBER(call_queue, sound_thereare, AST_DATA_STRING)		\
+	MEMBER(call_queue, sound_calls, AST_DATA_STRING)		\
+	MEMBER(call_queue, queue_quantity1, AST_DATA_STRING)		\
+	MEMBER(call_queue, queue_quantity2, AST_DATA_STRING)		\
+	MEMBER(call_queue, sound_holdtime, AST_DATA_STRING)		\
+	MEMBER(call_queue, sound_minutes, AST_DATA_STRING)		\
+	MEMBER(call_queue, sound_minute, AST_DATA_STRING)		\
+	MEMBER(call_queue, sound_seconds, AST_DATA_STRING)		\
+	MEMBER(call_queue, sound_thanks, AST_DATA_STRING)		\
+	MEMBER(call_queue, sound_callerannounce, AST_DATA_STRING)	\
+	MEMBER(call_queue, sound_reporthold, AST_DATA_STRING)		\
+	MEMBER(call_queue, dead, AST_DATA_BOOLEAN)			\
+	MEMBER(call_queue, eventwhencalled, AST_DATA_BOOLEAN)		\
+	MEMBER(call_queue, ringinuse, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, setinterfacevar, AST_DATA_BOOLEAN)		\
+	MEMBER(call_queue, setqueuevar, AST_DATA_BOOLEAN)		\
+	MEMBER(call_queue, setqueueentryvar, AST_DATA_BOOLEAN)		\
+	MEMBER(call_queue, reportholdtime, AST_DATA_BOOLEAN)		\
+	MEMBER(call_queue, wrapped, AST_DATA_BOOLEAN)			\
+	MEMBER(call_queue, timeoutrestart, AST_DATA_BOOLEAN)		\
+	MEMBER(call_queue, announceholdtime, AST_DATA_INTEGER)		\
+	MEMBER(call_queue, announceposition, AST_DATA_INTEGER)		\
+	MEMBER(call_queue, strategy, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, maskmemberstatus, AST_DATA_BOOLEAN)		\
+	MEMBER(call_queue, realtime, AST_DATA_BOOLEAN)			\
+	MEMBER(call_queue, found, AST_DATA_BOOLEAN)			\
+	MEMBER(call_queue, announcepositionlimit, AST_DATA_INTEGER)	\
+	MEMBER(call_queue, announcefrequency, AST_DATA_INTEGER)		\
+	MEMBER(call_queue, minannouncefrequency, AST_DATA_INTEGER)	\
+	MEMBER(call_queue, periodicannouncefrequency, AST_DATA_INTEGER)	\
+	MEMBER(call_queue, numperiodicannounce, AST_DATA_INTEGER)	\
+	MEMBER(call_queue, randomperiodicannounce, AST_DATA_INTEGER)	\
+	MEMBER(call_queue, roundingseconds, AST_DATA_INTEGER)		\
+	MEMBER(call_queue, holdtime, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, talktime, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, callscompleted, AST_DATA_INTEGER)		\
+	MEMBER(call_queue, callsabandoned, AST_DATA_INTEGER)		\
+	MEMBER(call_queue, servicelevel, AST_DATA_INTEGER)		\
+	MEMBER(call_queue, callscompletedinsl, AST_DATA_INTEGER)	\
+	MEMBER(call_queue, monfmt, AST_DATA_STRING)			\
+	MEMBER(call_queue, montype, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, count, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, maxlen, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, wrapuptime, AST_DATA_INTEGER)		\
+	MEMBER(call_queue, retry, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, timeout, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, weight, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, autopause, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, timeoutpriority, AST_DATA_INTEGER)		\
+	MEMBER(call_queue, rrpos, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, memberdelay, AST_DATA_INTEGER)		\
+	MEMBER(call_queue, autofill, AST_DATA_INTEGER)			\
+	MEMBER(call_queue, members, AST_DATA_CONTAINER)			\
+	MEMBER(call_queue, membercount, AST_DATA_INTEGER)
+
+AST_DATA_STRUCTURE(call_queue, DATA_EXPORT_CALL_QUEUE);
+
+/* struct member astdata mapping. */
+#define DATA_EXPORT_MEMBER(MEMBER)					\
+	MEMBER(member, interface, AST_DATA_STRING)			\
+	MEMBER(member, state_interface, AST_DATA_STRING)		\
+	MEMBER(member, membername, AST_DATA_STRING)			\
+	MEMBER(member, penalty, AST_DATA_INTEGER)			\
+	MEMBER(member, calls, AST_DATA_INTEGER)				\
+	MEMBER(member, dynamic, AST_DATA_INTEGER)			\
+	MEMBER(member, realtime, AST_DATA_INTEGER)			\
+	MEMBER(member, status, AST_DATA_INTEGER)			\
+	MEMBER(member, paused, AST_DATA_BOOLEAN)			\
+	MEMBER(member, rt_uniqueid, AST_DATA_STRING)
+
+AST_DATA_STRUCTURE(member, DATA_EXPORT_MEMBER);
+
+#define DATA_EXPORT_QUEUE_ENT(MEMBER)						\
+	MEMBER(queue_ent, moh, AST_DATA_STRING)					\
+	MEMBER(queue_ent, announce, AST_DATA_STRING)				\
+	MEMBER(queue_ent, context, AST_DATA_STRING)				\
+	MEMBER(queue_ent, digits, AST_DATA_STRING)				\
+	MEMBER(queue_ent, valid_digits, AST_DATA_INTEGER)			\
+	MEMBER(queue_ent, pos, AST_DATA_INTEGER)				\
+	MEMBER(queue_ent, prio, AST_DATA_INTEGER)				\
+	MEMBER(queue_ent, last_pos_said, AST_DATA_INTEGER)			\
+	MEMBER(queue_ent, last_periodic_announce_time, AST_DATA_INTEGER)	\
+	MEMBER(queue_ent, last_periodic_announce_sound, AST_DATA_INTEGER)	\
+	MEMBER(queue_ent, last_pos, AST_DATA_INTEGER)				\
+	MEMBER(queue_ent, opos, AST_DATA_INTEGER)				\
+	MEMBER(queue_ent, handled, AST_DATA_INTEGER)				\
+	MEMBER(queue_ent, pending, AST_DATA_INTEGER)				\
+	MEMBER(queue_ent, max_penalty, AST_DATA_INTEGER)			\
+	MEMBER(queue_ent, min_penalty, AST_DATA_INTEGER)			\
+	MEMBER(queue_ent, linpos, AST_DATA_INTEGER)				\
+	MEMBER(queue_ent, linwrapped, AST_DATA_INTEGER)				\
+	MEMBER(queue_ent, start, AST_DATA_INTEGER)				\
+	MEMBER(queue_ent, expire, AST_DATA_INTEGER)				\
+	MEMBER(queue_ent, cancel_answered_elsewhere, AST_DATA_INTEGER)
+
+AST_DATA_STRUCTURE(queue_ent, DATA_EXPORT_QUEUE_ENT);
+
+/*!
+ * \internal
+ * \brief Add a queue to the data_root node.
+ * \param[in] search The search tree.
+ * \param[in] data_root The main result node.
+ * \param[in] queue The queue to add.
+ */
+static void queues_data_provider_get_helper(const struct ast_data_search *search,
+	struct ast_data *data_root, struct call_queue *queue)
+{
+	int member_notmatch, caller_notmatch, caller_channel_notmatch;
+	struct ao2_iterator im;
+	struct member *member;
+	struct queue_ent *qe;
+	struct ast_data *data_queue, *data_members = NULL;
+	struct ast_data *data_member, *data_callers = NULL, *data_caller, *data_caller_channel;
+
+	/* compare the search pattern. */
+	if (ast_data_search_cmp_structure(search, call_queue, queue, "queue")) {
+		/* this doesn't match! continue! */
+		return;
+	}
+
+	data_queue = ast_data_add_node(data_root, "queue");
+	if (!data_queue) {
+		return;
+	}
+
+	ast_data_add_structure(call_queue, data_queue, queue);
+
+	member_notmatch = ast_data_search_has_condition(search, "queue/members/member");
+	/* add queue members */
+	im = ao2_iterator_init(queue->members, 0);
+	while ((member = ao2_iterator_next(&im))) {
+		/* compare the member structure. */
+		if (!ast_data_search_cmp_structure(search, member, member,
+					"queue/members/member")) {
+			member_notmatch = 0;
+		}
+
+		if (!data_members) {
+			data_members = ast_data_add_node(data_queue, "members");
+			if (!data_members) {
+				ao2_ref(member, -1);
+				continue;
+			}
+		}
+
+		data_member = ast_data_add_node(data_members, "member");
+		if (!data_member) {
+			ao2_ref(member, -1);
+			continue;
+		}
+
+		ast_data_add_structure(member, data_member, member);
+
+		ao2_ref(member, -1);
+	}
+
+	if (member_notmatch) {
+		ast_data_remove_node(data_root, data_queue);
+		return;
+	}
+
+	caller_notmatch = ast_data_search_has_condition(search, "queue/callers/caller");
+	caller_channel_notmatch = ast_data_search_has_condition(search,
+		"queue/callers/caller/channel");
+	/* include the callers inside the result. */
+	if (queue->head) {
+		for (qe = queue->head; qe; qe = qe->next) {
+			/* compare the member structure. */
+			if (!ast_data_search_cmp_structure(search, queue_ent, qe,
+						"queue/callers/caller")) {
+				caller_notmatch = 0;
+			}
+
+			if (!ast_channel_data_cmp_structure(search, qe->chan,
+				"queue/callers/caller/channel")) {
+				caller_channel_notmatch = 0;
+			}
+
+			if (!data_callers) {
+				data_callers = ast_data_add_node(data_queue, "callers");
+				if (!data_callers) {
+					continue;
+				}
+			}
+
+			data_caller = ast_data_add_node(data_callers, "caller");
+			if (!data_caller) {
+				continue;
+			}
+
+			ast_data_add_structure(queue_ent, data_caller, qe);
+
+			/* add the caller channel. */
+			data_caller_channel = ast_data_add_node(data_caller, "channel");
+			if (!data_caller_channel) {
+				continue;
+			}
+
+			ast_channel_data_add_structure(data_caller_channel, qe->chan);
+		}
+	}
+
+	/* if this queue doesn't match remove the added queue. */
+	if (caller_notmatch || caller_channel_notmatch) {
+		ast_data_remove_node(data_root, data_queue);
+	}
+}
+
+/*!
+ * \internal
+ * \brief Callback used to generate the queues tree.
+ * \param[in] search The search pattern tree.
+ * \retval NULL on error.
+ * \retval non-NULL The generated tree.
+ */
+static int queues_data_provider_get(const struct ast_data_search *search,
+	struct ast_data *data_root)
+{
+	struct ao2_iterator i;
+	struct call_queue *queue, *queue_realtime = NULL;
+	struct ast_config *cfg;
+	char *queuename;
+
+	/* load realtime queues. */
+	cfg = ast_load_realtime_multientry("queues", "name LIKE", "%", SENTINEL);
+	if (cfg) {
+		for (queuename = ast_category_browse(cfg, NULL);
+				!ast_strlen_zero(queuename);
+				queuename = ast_category_browse(cfg, queuename)) {
+			if ((queue = load_realtime_queue(queuename))) {
+				queue_unref(queue);
+			}
+		}
+		ast_config_destroy(cfg);
+	}
+
+	/* static queues. */
+	i = ao2_iterator_init(queues, 0);
+	while ((queue = ao2_iterator_next(&i))) {
+		ao2_lock(queue);
+		if (queue->realtime && !(queue_realtime = load_realtime_queue(queue->name))) {
+			ao2_unlock(queue);
+			queue_unref(queue);
+			continue;
+		} else if (queue->realtime) {
+			queue_unref(queue_realtime);
+		}
+
+		queues_data_provider_get_helper(search, data_root, queue);
+		ao2_unlock(queue);
+		queue_unref(queue);
+	}
+
+	return 0;
+}
+
+static const struct ast_data_handler queues_data_provider = {
+	.version = AST_DATA_HANDLER_VERSION,
+	.get = queues_data_provider_get
+};
+
+static const struct ast_data_entry queue_data_providers[] = {
+	AST_DATA_ENTRY("asterisk/application/app_queue/queues", &queues_data_provider),
+};
+
 static int unload_module(void)
 {
 	int res;
@@ -7646,6 +7922,8 @@ static int unload_module(void)
 	res |= ast_custom_function_unregister(&queuewaitingcount_function);
 	res |= ast_custom_function_unregister(&queuememberpenalty_function);
 
+	res |= ast_data_unregister(NULL);
+
 	if (device_state_sub)
 		ast_event_unsubscribe(device_state_sub);
 
@@ -7690,6 +7968,8 @@ static int load_module(void)
 	if (queue_persistent_members)
 		reload_queue_members();
 
+	ast_data_register_multiple(queue_data_providers, ARRAY_LEN(queue_data_providers));
+
 	ast_cli_register_multiple(cli_queue, ARRAY_LEN(cli_queue));
 	res = ast_register_application_xml(app, queue_exec);
 	res |= ast_register_application_xml(app_aqm, aqm_exec);
diff --git a/apps/app_voicemail.c b/apps/app_voicemail.c
index 48ef85ef7..7fd9a39d0 100644
--- a/apps/app_voicemail.c
+++ b/apps/app_voicemail.c
@@ -10739,6 +10739,206 @@ static struct ast_cli_entry cli_voicemail[] = {
 	AST_CLI_DEFINE(handle_voicemail_reload, "Reload voicemail configuration"),
 };
 
+#ifdef IMAP_STORAGE
+	#define DATA_EXPORT_VM_USERS(USER)					\
+		USER(ast_vm_user, context, AST_DATA_STRING)			\
+		USER(ast_vm_user, mailbox, AST_DATA_STRING)			\
+		USER(ast_vm_user, password, AST_DATA_STRING)			\
+		USER(ast_vm_user, fullname, AST_DATA_STRING)			\
+		USER(ast_vm_user, email, AST_DATA_STRING)			\
+		USER(ast_vm_user, emailsubject, AST_DATA_STRING)		\
+		USER(ast_vm_user, emailbody, AST_DATA_STRING)			\
+		USER(ast_vm_user, pager, AST_DATA_STRING)			\
+		USER(ast_vm_user, serveremail, AST_DATA_STRING)			\
+		USER(ast_vm_user, mailcmd, AST_DATA_STRING)			\
+		USER(ast_vm_user, language, AST_DATA_STRING)			\
+		USER(ast_vm_user, zonetag, AST_DATA_STRING)			\
+		USER(ast_vm_user, callback, AST_DATA_STRING)			\
+		USER(ast_vm_user, dialout, AST_DATA_STRING)			\
+		USER(ast_vm_user, uniqueid, AST_DATA_STRING)			\
+		USER(ast_vm_user, exit, AST_DATA_STRING)			\
+		USER(ast_vm_user, attachfmt, AST_DATA_STRING)			\
+		USER(ast_vm_user, flags, AST_DATA_UNSIGNED_INTEGER)		\
+		USER(ast_vm_user, saydurationm, AST_DATA_INTEGER)		\
+		USER(ast_vm_user, maxmsg, AST_DATA_INTEGER)			\
+		USER(ast_vm_user, maxdeletedmsg, AST_DATA_INTEGER)		\
+		USER(ast_vm_user, maxsecs, AST_DATA_INTEGER)			\
+		USER(ast_vm_user, imapuser, AST_DATA_STRING)			\
+		USER(ast_vm_user, imappassword, AST_DATA_STRING)		\
+		USER(ast_vm_user, imapvmshareid, AST_DATA_STRING)		\
+		USER(ast_vm_user, volgain, AST_DATA_DOUBLE)
+#else
+	#define DATA_EXPORT_VM_USERS(USER)					\
+		USER(ast_vm_user, context, AST_DATA_STRING)			\
+		USER(ast_vm_user, mailbox, AST_DATA_STRING)			\
+		USER(ast_vm_user, password, AST_DATA_STRING)			\
+		USER(ast_vm_user, fullname, AST_DATA_STRING)			\
+		USER(ast_vm_user, email, AST_DATA_STRING)			\
+		USER(ast_vm_user, emailsubject, AST_DATA_STRING)		\
+		USER(ast_vm_user, emailbody, AST_DATA_STRING)			\
+		USER(ast_vm_user, pager, AST_DATA_STRING)			\
+		USER(ast_vm_user, serveremail, AST_DATA_STRING)			\
+		USER(ast_vm_user, mailcmd, AST_DATA_STRING)			\
+		USER(ast_vm_user, language, AST_DATA_STRING)			\
+		USER(ast_vm_user, zonetag, AST_DATA_STRING)			\
+		USER(ast_vm_user, callback, AST_DATA_STRING)			\
+		USER(ast_vm_user, dialout, AST_DATA_STRING)			\
+		USER(ast_vm_user, uniqueid, AST_DATA_STRING)			\
+		USER(ast_vm_user, exit, AST_DATA_STRING)			\
+		USER(ast_vm_user, attachfmt, AST_DATA_STRING)			\
+		USER(ast_vm_user, flags, AST_DATA_UNSIGNED_INTEGER)		\
+		USER(ast_vm_user, saydurationm, AST_DATA_INTEGER)		\
+		USER(ast_vm_user, maxmsg, AST_DATA_INTEGER)			\
+		USER(ast_vm_user, maxdeletedmsg, AST_DATA_INTEGER)		\
+		USER(ast_vm_user, maxsecs, AST_DATA_INTEGER)			\
+		USER(ast_vm_user, volgain, AST_DATA_DOUBLE)
+#endif
+
+AST_DATA_STRUCTURE(ast_vm_user, DATA_EXPORT_VM_USERS);
+
+#define DATA_EXPORT_VM_ZONES(ZONE)			\
+	ZONE(vm_zone, name, AST_DATA_STRING)		\
+	ZONE(vm_zone, timezone, AST_DATA_STRING)	\
+	ZONE(vm_zone, msg_format, AST_DATA_STRING)
+
+AST_DATA_STRUCTURE(vm_zone, DATA_EXPORT_VM_ZONES);
+
+#ifdef IMAP_STORAGE
+	#define DATA_EXPORT_VM_STATES(STATE)						\
+		STATE(vm_state, curbox, AST_DATA_STRING)				\
+		STATE(vm_state, username, AST_DATA_STRING)				\
+		STATE(vm_state, context, AST_DATA_STRING)				\
+		STATE(vm_state, curdir, AST_DATA_STRING)				\
+		STATE(vm_state, vmbox, AST_DATA_STRING)					\
+		STATE(vm_state, fn, AST_DATA_STRING)					\
+		STATE(vm_state, intro, AST_DATA_STRING)					\
+		STATE(vm_state, curmsg, AST_DATA_INTEGER)				\
+		STATE(vm_state, lastmsg, AST_DATA_INTEGER)				\
+		STATE(vm_state, newmessages, AST_DATA_INTEGER)				\
+		STATE(vm_state, oldmessages, AST_DATA_INTEGER)				\
+		STATE(vm_state, urgentmessages, AST_DATA_INTEGER)			\
+		STATE(vm_state, starting, AST_DATA_INTEGER)				\
+		STATE(vm_state, repeats, AST_DATA_INTEGER)				\
+		STATE(vm_state, updated, AST_DATA_INTEGER)				\
+		STATE(vm_state, msgArray, AST_DATA_CONTAINER)				\
+		STATE(vm_state, vmArrayIndex, AST_DATA_INTEGER)				\
+		STATE(vm_state, imapuser, AST_DATA_STRING)				\
+		STATE(vm_state, interactive, AST_DATA_INTEGER)				\
+		STATE(vm_state, introfn, AST_DATA_STRING)				\
+		STATE(vm_state, quota_limit, AST_DATA_UNSIGNED_INTEGER)			\
+		STATE(vm_state, quota_usage, AST_DATA_UNSIGNED_INTEGER)
+#else
+	#define DATA_EXPORT_VM_STATES(STATE)						\
+		STATE(vm_state, curbox, AST_DATA_STRING)				\
+		STATE(vm_state, username, AST_DATA_STRING)				\
+		STATE(vm_state, context, AST_DATA_STRING)				\
+		STATE(vm_state, curdir, AST_DATA_STRING)				\
+		STATE(vm_state, vmbox, AST_DATA_STRING)					\
+		STATE(vm_state, fn, AST_DATA_STRING)					\
+		STATE(vm_state, intro, AST_DATA_STRING)					\
+		STATE(vm_state, curmsg, AST_DATA_INTEGER)				\
+		STATE(vm_state, lastmsg, AST_DATA_INTEGER)				\
+		STATE(vm_state, newmessages, AST_DATA_INTEGER)				\
+		STATE(vm_state, oldmessages, AST_DATA_INTEGER)				\
+		STATE(vm_state, urgentmessages, AST_DATA_INTEGER)			\
+		STATE(vm_state, starting, AST_DATA_INTEGER)				\
+		STATE(vm_state, repeats, AST_DATA_INTEGER)
+#endif
+
+AST_DATA_STRUCTURE(vm_state, DATA_EXPORT_VM_STATES);
+
+/*!
+ * \internal
+ * \brief Add voicemail user to the data_root.
+ * \param[in] search The search tree.
+ * \param[in] data_root The main result node.
+ * \param[in] user The voicemail user.
+ */
+static void vm_users_data_provider_get_helper(const struct ast_data_search *search,
+    struct ast_data *data_root, struct ast_vm_user *user)
+{
+	struct ast_data *data_user, *data_zone;
+#ifdef IMAP_STORAGE
+	struct ast_data *data_state;
+	struct vm_state *state;
+#endif
+	struct vm_zone *zone = NULL;
+
+	/* check the search pattern to make sure it's valid to add it */
+	if (ast_data_search_cmp_structure(search, ast_vm_user, user, "user")) {
+		return;
+	}
+
+	data_user = ast_data_add_node(data_root, "user");
+	if (!data_user) {
+		return;
+	}
+
+	ast_data_add_structure(ast_vm_user, data_user, user);
+
+#ifdef IMAP_STORAGE
+	state = get_vm_state_by_mailbox(user->mailbox, user->context, user->interactive);
+#endif
+
+	AST_LIST_LOCK(&zones);
+	AST_LIST_TRAVERSE(&zones, zone, list) {
+		if (!strcmp(zone->name, user->zonetag)) {
+			break;
+		}
+	}
+	AST_LIST_UNLOCK(&zones);
+
+	/* TODO: Should a user's vm state be accessible without compiling in
+	 *       IMAP support? */
+
+	if (
+#ifdef IMAP_STORAGE
+		!ast_data_search_cmp_structure(search, vm_state, state, "user/state") ||
+#endif
+		(zone && !ast_data_search_cmp_structure(search, vm_zone,
+							zone, "user/zone"))) {
+		ast_data_remove_node(data_root, data_user);
+		return;
+	}
+
+#ifdef IMAP_STORAGE
+	data_state = ast_data_add_node(data_user, "state");
+	ast_data_add_structure(vm_state, data_state, state);
+	ast_data_add_int(data_state, "deleted", *(state->deleted));
+	ast_data_add_int(data_state, "heard", *(state->heard));
+#endif
+
+	if (zone) {
+		data_zone = ast_data_add_node(data_user, "zone");
+		ast_data_add_structure(vm_zone, data_zone, zone);
+	}
+
+	return;
+}
+
+static int vm_data_provider_get(const struct ast_data_search *search,
+	struct ast_data *data_root)
+{
+	struct ast_vm_user *user;
+
+	AST_LIST_LOCK(&users);
+	AST_LIST_TRAVERSE(&users, user, list) {
+		vm_users_data_provider_get_helper(search, data_root, user);
+	}
+	AST_LIST_UNLOCK(&users);
+
+	return 0;
+}
+
+static const struct ast_data_handler vm_data_provider = {
+	.version = AST_DATA_HANDLER_VERSION,
+	.get = vm_data_provider_get
+};
+
+static const struct ast_data_entry vm_data_providers[] = {
+	AST_DATA_ENTRY("asterisk/application/app_voicemail/voicemail", &vm_data_provider)
+};
+
 static void poll_subscribed_mailbox(struct mwi_sub *mwi_sub)
 {
 	int new = 0, old = 0, urgent = 0;
@@ -12241,6 +12441,7 @@ static int unload_module(void)
 	res |= ast_unregister_application(app4);
 	res |= ast_custom_function_unregister(&mailbox_exists_acf);
 	res |= ast_manager_unregister("VoicemailUsersList");
+	res |= ast_data_unregister(NULL);
 #ifdef TEST_FRAMEWORK
 	res |= AST_TEST_UNREGISTER(test_voicemail_vmsayname);
 	res |= AST_TEST_UNREGISTER(test_voicemail_msgcount);
@@ -12301,6 +12502,7 @@ static int load_module(void)
 		return res;
 
 	ast_cli_register_multiple(cli_voicemail, ARRAY_LEN(cli_voicemail));
+	ast_data_register_multiple(vm_data_providers, ARRAY_LEN(vm_data_providers));
 
 	ast_install_vm_functions(has_voicemail, inboxcount, inboxcount2, messagecount, sayname);
 	ast_realtime_require_field("voicemail", "uniqueid", RQ_UINTEGER3, 11, "password", RQ_CHAR, 10, SENTINEL);