This commit introduces the first phase of an effort to manage documentation of the interfaces in Asterisk in an XML format. Currently, a new format is available for applications and dialplan functions. A good number of conversions to the new format are also included. For more information, see the following message to asterisk-dev: http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
113 lines
2.8 KiB
C
113 lines
2.8 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (c) 2006 Tilghman Lesher. All rights reserved.
|
|
*
|
|
* Tilghman Lesher <asterisk-vmcount-func@the-tilghman.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
|
|
*
|
|
* \brief VMCOUNT dialplan function
|
|
*
|
|
* \author Tilghman Lesher <asterisk-vmcount-func@the-tilghman.com>
|
|
*
|
|
* \ingroup functions
|
|
*/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include <dirent.h>
|
|
|
|
#include "asterisk/file.h"
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/lock.h"
|
|
#include "asterisk/utils.h"
|
|
#include "asterisk/app.h"
|
|
|
|
/*** DOCUMENTATION
|
|
<function name="VMCOUNT" language="en_US">
|
|
<synopsis>
|
|
Count the voicemails in a specified mailbox.
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="vmbox" required="true" argsep="@">
|
|
<argument name="vmbox" required="true" />
|
|
<argument name="context" required="false">
|
|
<para>If not specified, defaults to <literal>default</literal>.</para>
|
|
</argument>
|
|
</parameter>
|
|
<parameter name="folder" required="false">
|
|
<para>If not specified, defaults to <literal>INBOX</literal></para>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>Count the number of voicemails in a specified mailbox, you could also specify
|
|
the <replaceable>context</replaceable> and the mailbox <replaceable>folder</replaceable>.</para>
|
|
<para>Example: <literal>exten => s,1,Set(foo=${VMCOUNT(125)})</literal></para>
|
|
</description>
|
|
</function>
|
|
***/
|
|
|
|
static int acf_vmcount_exec(struct ast_channel *chan, const char *cmd, char *argsstr, char *buf, size_t len)
|
|
{
|
|
char *context;
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(vmbox);
|
|
AST_APP_ARG(folder);
|
|
);
|
|
|
|
buf[0] = '\0';
|
|
|
|
if (ast_strlen_zero(argsstr))
|
|
return -1;
|
|
|
|
AST_STANDARD_APP_ARGS(args, argsstr);
|
|
|
|
if (strchr(args.vmbox, '@')) {
|
|
context = args.vmbox;
|
|
args.vmbox = strsep(&context, "@");
|
|
} else {
|
|
context = "default";
|
|
}
|
|
|
|
if (ast_strlen_zero(args.folder)) {
|
|
args.folder = "INBOX";
|
|
}
|
|
|
|
snprintf(buf, len, "%d", ast_app_messagecount(context, args.vmbox, args.folder));
|
|
|
|
return 0;
|
|
}
|
|
|
|
struct ast_custom_function acf_vmcount = {
|
|
.name = "VMCOUNT",
|
|
.read = acf_vmcount_exec,
|
|
};
|
|
|
|
static int unload_module(void)
|
|
{
|
|
return ast_custom_function_unregister(&acf_vmcount);
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
return ast_custom_function_register(&acf_vmcount);
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Indicator for whether a voice mailbox has messages in a given folder.");
|