major dialplan functions update
[asterisk/asterisk.git] / funcs / func_enum.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006
5  *
6  * Mark Spencer <markster@digium.com>
7  * Oleksiy Krivoshey <oleksiyk@gmail.com>
8  * Russell Bryant <russelb@clemson.edu>
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  * This program is free software, distributed under the terms of
17  * the GNU General Public License Version 2. See the LICENSE file
18  * at the top of the source tree.
19  */
20
21 /*! \file
22  *
23  * \brief ENUM Functions
24  *
25  * \author Mark Spencer <markster@digium.com>
26  * \author Oleksiy Krivoshey <oleksiyk@gmail.com>
27  * \author Russell Bryant <russelb@clemson.edu>
28  *
29  * \arg See also AstENUM
30  */
31
32 #include <stdlib.h>
33 #include <stdio.h>
34
35 #include "asterisk.h"
36
37 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
38
39 #include "asterisk/module.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/utils.h"
43 #include "asterisk/lock.h"
44 #include "asterisk/file.h"
45 #include "asterisk/logger.h"
46 #include "asterisk/pbx.h"
47 #include "asterisk/options.h"
48 #include "asterisk/enum.h"
49 #include "asterisk/app.h"
50
51  static char *synopsis = "Syntax: ENUMLOOKUP(number[|Method-type[|options[|record#[|zone-suffix]]]])\n";
52
53 STANDARD_LOCAL_USER;
54
55 LOCAL_USER_DECL;
56
57 static int function_enum(struct ast_channel *chan, char *cmd, char *data,
58                          char *buf, size_t len)
59 {
60         AST_DECLARE_APP_ARGS(args,
61                 AST_APP_ARG(number);
62                 AST_APP_ARG(tech);
63                 AST_APP_ARG(options);
64                 AST_APP_ARG(record);
65                 AST_APP_ARG(zone);
66         );
67         int res = 0;
68         char tech[80];
69         char dest[80] = "";
70         char *zone;
71         char *options;
72         struct localuser *u;
73         char *s, *p;
74
75         buf[0] = '\0';
76
77         if (ast_strlen_zero(data)) {
78                 ast_log(LOG_WARNING, synopsis);
79                 return -1;
80         }
81
82         AST_STANDARD_APP_ARGS(args, data);
83
84         if (args.argc < 1) {
85                 ast_log(LOG_WARNING, synopsis);
86                 return -1;
87         }
88
89         ast_copy_string(tech, args.tech ? args.tech : "sip", sizeof(tech));
90
91         if (!args.zone)
92                 args.zone = "e164.arpa";
93
94         if (!args.options)
95                 args.options = "1";
96
97         /* strip any '-' signs from number */
98         for (p = args.number, s = p; *s; *s++) {
99                 if (*s != '-')
100                         *p++ = *s;
101         }
102         *p = '\0';
103
104         LOCAL_USER_ACF_ADD(u);
105
106         res = ast_get_enum(chan, p, dest, sizeof(dest), tech, sizeof(tech), zone,
107                            options);
108
109         LOCAL_USER_REMOVE(u);
110
111         p = strchr(dest, ':');
112         if (p && strcasecmp(tech, "ALL"))
113                 ast_copy_string(buf, p + 1, len);
114         else
115                 ast_copy_string(buf, dest, len);
116
117         return 0;
118 }
119
120 static struct ast_custom_function enum_function = {
121         .name = "ENUMLOOKUP",
122         .synopsis =
123                 "ENUMLOOKUP allows for general or specific querying of NAPTR records"
124                 " or counts of NAPTR types for ENUM or ENUM-like DNS pointers",
125         .syntax =
126                 "ENUMLOOKUP(number[|Method-type[|options[|record#[|zone-suffix]]]])",
127         .desc =
128                 "Option 'c' returns an integer count of the number of NAPTRs of a certain RR type.\n"
129                 "Combination of 'c' and Method-type of 'ALL' will return a count of all NAPTRs for the record.\n"
130                 "Defaults are: Method-type=sip, no options, record=1, zone-suffix=e164.arpa\n\n"
131                 "For more information, see README.enum",
132         .read = function_enum,
133 };
134
135 static int function_txtcidname(struct ast_channel *chan, char *cmd,
136                                char *data, char *buf, size_t len)
137 {
138         int res;
139         char tech[80];
140         char txt[256] = "";
141         char dest[80];
142         struct localuser *u;
143
144         buf[0] = '\0';
145
146         LOCAL_USER_ACF_ADD(u);
147
148         if (ast_strlen_zero(data)) {
149                 ast_log(LOG_WARNING, "TXTCIDNAME requires an argument (number)\n");
150                 LOCAL_USER_REMOVE(u);
151                 return -1;
152         }
153
154         res = ast_get_txt(chan, data, dest, sizeof(dest), tech, sizeof(tech), txt,
155                           sizeof(txt));
156
157         if (!ast_strlen_zero(txt))
158                 ast_copy_string(buf, txt, len);
159
160         LOCAL_USER_REMOVE(u);
161
162         return 0;
163 }
164
165 static struct ast_custom_function txtcidname_function = {
166         .name = "TXTCIDNAME",
167         .synopsis = "TXTCIDNAME looks up a caller name via DNS",
168         .syntax = "TXTCIDNAME(<number>)",
169         .desc =
170                 "This function looks up the given phone number in DNS to retrieve\n"
171                 "the caller id name.  The result will either be blank or be the value\n"
172                 "found in the TXT record in DNS.\n",
173         .read = function_txtcidname,
174 };
175
176 static char *tdesc = "ENUM related dialplan functions";
177
178 int unload_module(void)
179 {
180         int res = 0;
181
182         res |= ast_custom_function_unregister(&enum_function);
183         res |= ast_custom_function_unregister(&txtcidname_function);
184
185         STANDARD_HANGUP_LOCALUSERS;
186
187         return res;
188 }
189
190 int load_module(void)
191 {
192         int res = 0;
193
194         res |= ast_custom_function_register(&enum_function);
195         res |= ast_custom_function_register(&txtcidname_function);
196
197         return res;
198 }
199
200 char *description(void)
201 {
202         return tdesc;
203 }
204
205 int usecount(void)
206 {
207         int res;
208
209         STANDARD_USECOUNT(res);
210
211         return res;
212 }
213
214 char *key()
215 {
216         return ASTERISK_GPL_KEY;
217 }