Merge "contrib/sip_to_pjsip: handle setvar in conversion"
[asterisk/asterisk.git] / funcs / func_vmcount.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (c) 2006 Tilghman Lesher.  All rights reserved.
5  *
6  * Tilghman Lesher <asterisk-vmcount-func@the-tilghman.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief VMCOUNT dialplan function
22  *
23  * \author Tilghman Lesher <asterisk-vmcount-func@the-tilghman.com>
24  *
25  * \ingroup functions
26  */
27
28 /*** MODULEINFO
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 #include <dirent.h>
35
36 #include "asterisk/file.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/module.h"
40 #include "asterisk/lock.h"
41 #include "asterisk/utils.h"
42 #include "asterisk/app.h"
43
44 /*** DOCUMENTATION
45         <function name="VMCOUNT" language="en_US">
46                 <synopsis>
47                         Count the voicemails in a specified mailbox.
48                 </synopsis>
49                 <syntax>
50                         <parameter name="vmbox" required="true" />
51                         <parameter name="folder" required="false">
52                                 <para>If not specified, defaults to <literal>INBOX</literal></para>
53                         </parameter>
54                 </syntax>
55                 <description>
56                         <para>Count the number of voicemails in a specified mailbox, you could also specify
57                         the mailbox <replaceable>folder</replaceable>.</para>
58                         <para>Example: <literal>exten => s,1,Set(foo=${VMCOUNT(125@default)})</literal></para>
59                 </description>
60         </function>
61  ***/
62
63 static int acf_vmcount_exec(struct ast_channel *chan, const char *cmd, char *argsstr, char *buf, size_t len)
64 {
65         AST_DECLARE_APP_ARGS(args,
66                 AST_APP_ARG(vmbox);
67                 AST_APP_ARG(folder);
68         );
69
70         buf[0] = '\0';
71
72         if (ast_strlen_zero(argsstr))
73                 return -1;
74
75         AST_STANDARD_APP_ARGS(args, argsstr);
76
77         if (ast_strlen_zero(args.vmbox)) {
78                 return -1;
79         }
80
81         if (ast_strlen_zero(args.folder)) {
82                 args.folder = "INBOX";
83         }
84
85         snprintf(buf, len, "%d", ast_app_messagecount(args.vmbox, args.folder));
86
87         return 0;
88 }
89
90 static struct ast_custom_function acf_vmcount = {
91         .name = "VMCOUNT",
92         .read = acf_vmcount_exec,
93         .read_max = 12,
94 };
95
96 static int unload_module(void)
97 {
98         return ast_custom_function_unregister(&acf_vmcount);
99 }
100
101 static int load_module(void)
102 {
103         return ast_custom_function_register(&acf_vmcount);
104 }
105
106 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Indicator for whether a voice mailbox has messages in a given folder.");