implement TXTCIDNAME as a dialplan function and mark the application deprecated
[asterisk/asterisk.git] / funcs / func_enum.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005
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 /*
22  *
23  * Enum Functions
24  *
25  */
26
27 #include <stdlib.h>
28
29 #include "asterisk.h"
30
31 #ifndef BUILTIN_FUNC
32 #include "asterisk/module.h"
33 #endif /* BUILTIN_FUNC */
34 #include "asterisk/channel.h"
35 #include "asterisk/pbx.h"
36 #include "asterisk/utils.h"
37
38 #include "asterisk/lock.h"
39 #include "asterisk/file.h"
40 #include "asterisk/logger.h"
41
42 #include "asterisk/pbx.h"
43 #include "asterisk/options.h"
44
45 #include "asterisk/enum.h"
46
47 static char* synopsis = "Syntax: ENUMLOOKUP(number[,Method-type[,options|record#[,zone-suffix]]])\n";
48
49 STANDARD_LOCAL_USER;
50
51 LOCAL_USER_DECL;
52
53 static char *function_enum(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
54 {
55        int res=0;
56        char tech[80];
57        char dest[80] = "";
58        char *zone;
59        char *options;
60        struct localuser *u;
61        char *params[4];
62        char *p = data;
63        char *s;
64        int i = 0;
65
66
67        if (!data || ast_strlen_zero(data)) {
68                ast_log(LOG_WARNING, synopsis);
69                return "";
70        }
71
72        do {
73                if(i>3){
74                        ast_log(LOG_WARNING, synopsis);
75                        return "";
76                }
77                params[i++] = p;
78                p = strchr(p, '|');
79                if(p){
80                        *p = '\0';
81                        p++;
82                }
83        } while(p);
84
85        if(i < 1){
86                ast_log(LOG_WARNING, synopsis);
87                return "";
88        }
89
90        if( (i > 1 && strlen(params[1]) == 0) || i < 2){
91                ast_copy_string(tech, "sip", sizeof(tech));
92        } else {
93                ast_copy_string(tech, params[1], sizeof(tech));
94        }
95
96        if( (i > 3 && strlen(params[3]) == 0) || i<4){
97                zone = "e164.arpa";
98        } else {
99                zone = params[3];
100        }
101
102        if( (i > 2 && strlen(params[2]) == 0) || i<3){
103                options = "1";
104        } else {
105                options = params[2];
106        }
107
108        /* strip any '-' signs from number */
109        p = params[0];
110        /*
111        while(*p == '+'){
112                p++;
113        }
114        */
115        s = p;
116        i = 0;
117        while(*p && *s){
118                if(*s == '-'){
119                        s++;
120                } else {
121                        p[i++] = *s++;
122                }
123        }
124        p[i] = 0;
125
126        LOCAL_USER_ACF_ADD(u);
127
128        res = ast_get_enum(chan, p, dest, sizeof(dest), tech, sizeof(tech), zone, options);
129
130        LOCAL_USER_REMOVE(u);
131
132        p = strchr(dest, ':');
133        if(p && strncasecmp(tech, "ALL", sizeof(tech))) {
134                ast_copy_string(buf, p+1, sizeof(dest));
135        } else {
136                ast_copy_string(buf, dest, sizeof(dest));
137        }
138
139        return buf;
140 }
141
142 #ifndef BUILTIN_FUNC
143 static
144 #endif
145 struct ast_custom_function enum_function = {
146        .name = "ENUMLOOKUP",
147        .synopsis = "ENUMLOOKUP allows for general or specific querying of NAPTR records"
148        " or counts of NAPTR types for ENUM or ENUM-like DNS pointers",
149        .syntax = "ENUMLOOKUP(number[,Method-type[,options|record#[,zone-suffix]]])",
150        .desc = "Option 'c' returns an integer count of the number of NAPTRs of a certain RR type.\n"
151        "Combination of 'c' and Method-type of 'ALL' will return a count of all NAPTRs for the record.\n"
152        "Defaults are: Method-type=sip, no options, record=1, zone-suffix=e164.arpa\n\n"
153        "For more information, see README.enum",
154        .read = function_enum,
155 };
156
157 static char *function_txtcidname(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
158 {
159         int res;
160         char tech[80];
161         char txt[256] = "";
162         char dest[80];
163         struct localuser *u;
164
165         LOCAL_USER_ACF_ADD(u);
166
167         buf[0] = '\0';
168
169         if (!data || ast_strlen_zero(data)) {
170                 ast_log(LOG_WARNING, "TXTCIDNAME requires an argument (number)\n");
171                 LOCAL_USER_REMOVE(u);
172                 return buf;     
173         }
174
175         res = ast_get_txt(chan, data, dest, sizeof(dest), tech, sizeof(tech), txt, sizeof(txt));
176         
177         if (!ast_strlen_zero(txt))
178                 ast_copy_string(buf, txt, len);
179         
180         LOCAL_USER_REMOVE(u);
181
182         return buf;
183 }
184
185 #ifndef BUILTIN_FUNC
186 static
187 #endif
188 struct ast_custom_function txtcidname_function = {
189        .name = "TXTCIDNAME",
190        .synopsis = "TXTCIDNAME looks up a caller name via DNS",
191        .syntax = "TXTCIDNAME(<number>)",
192        .desc = "This function looks up the given phone number in DNS to retrieve\n"
193         "the caller id name.  The result will either be blank or be the value\n"
194         "found in the TXT record in DNS.\n",
195        .read = function_txtcidname,
196 };
197
198 #ifndef BUILTIN_FUNC
199
200 static char *tdesc = "ENUMLOOKUP allows for general or specific querying of NAPTR records or counts of NAPTR types for ENUM or ENUM-like DNS pointers";
201
202 int unload_module(void)
203 {
204         ast_custom_function_unregister(&enum_function);
205         ast_custom_function_unregister(&txtcidname_function);
206         
207         return 0;
208 }
209
210 int load_module(void)
211 {
212         int res;
213         
214         res = ast_custom_function_register(&enum_function);
215         if (!res)
216                 ast_custom_function_register(&txtcidname_function);
217
218         return res;
219 }
220
221 char *description(void)
222 {
223        return tdesc;
224 }
225
226 int usecount(void)
227 {
228         int res;
229         
230         STANDARD_USECOUNT(res);
231
232         return res;
233 }
234
235 char *key()
236 {
237        return ASTERISK_GPL_KEY;
238 }
239 #endif /* BUILTIN_FUNC */
240