Doxygen 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  * \ingroup functions
32  */
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include <stdlib.h>
39 #include <stdio.h>
40
41 #include "asterisk/module.h"
42 #include "asterisk/channel.h"
43 #include "asterisk/pbx.h"
44 #include "asterisk/utils.h"
45 #include "asterisk/lock.h"
46 #include "asterisk/file.h"
47 #include "asterisk/logger.h"
48 #include "asterisk/pbx.h"
49 #include "asterisk/options.h"
50 #include "asterisk/enum.h"
51 #include "asterisk/app.h"
52
53  static char *synopsis = "Syntax: ENUMLOOKUP(number[|Method-type[|options[|record#[|zone-suffix]]]])\n";
54
55 static int function_enum(struct ast_channel *chan, const char *cmd, char *data,
56                          char *buf, size_t len)
57 {
58         AST_DECLARE_APP_ARGS(args,
59                 AST_APP_ARG(number);
60                 AST_APP_ARG(tech);
61                 AST_APP_ARG(options);
62                 AST_APP_ARG(record);
63                 AST_APP_ARG(zone);
64         );
65         int res = 0;
66         char tech[80];
67         char dest[256] = "", tmp[2] = "", num[AST_MAX_EXTENSION] = "";
68         struct ast_module_user *u;
69         char *s, *p;
70         unsigned int record = 1;
71
72         buf[0] = '\0';
73
74         if (ast_strlen_zero(data)) {
75                 ast_log(LOG_WARNING, synopsis);
76                 return -1;
77         }
78
79         AST_STANDARD_APP_ARGS(args, data);
80
81         if (args.argc < 1) {
82                 ast_log(LOG_WARNING, synopsis);
83                 return -1;
84         }
85
86         u = ast_module_user_add(chan);
87
88         ast_copy_string(tech, args.tech ? args.tech : "sip", sizeof(tech));
89
90         if (!args.zone)
91                 args.zone = "e164.arpa";
92
93         if (!args.options)
94                 args.options = "";
95
96         if (args.record)
97                 record = atoi(args.record);
98
99         /* strip any '-' signs from number */
100         for (s = p = args.number; *s; s++) {
101                 if (*s != '-') {
102                         snprintf(tmp, sizeof(tmp), "%c", *s);
103                         strncat(num, tmp, sizeof(num));
104                 }
105
106         }
107
108         res = ast_get_enum(chan, num, dest, sizeof(dest), tech, sizeof(tech), args.zone,
109                            args.options, record);
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         ast_module_user_remove(u);
118
119         return 0;
120 }
121
122 static struct ast_custom_function enum_function = {
123         .name = "ENUMLOOKUP",
124         .synopsis =
125                 "ENUMLOOKUP allows for general or specific querying of NAPTR records"
126                 " or counts of NAPTR types for ENUM or ENUM-like DNS pointers",
127         .syntax =
128                 "ENUMLOOKUP(number[|Method-type[|options[|record#[|zone-suffix]]]])",
129         .desc =
130                 "Option 'c' returns an integer count of the number of NAPTRs of a certain RR type.\n"
131                 "Combination of 'c' and Method-type of 'ALL' will return a count of all NAPTRs for the record.\n"
132                 "Defaults are: Method-type=sip, no options, record=1, zone-suffix=e164.arpa\n\n"
133                 "For more information, see doc/enum.txt",
134         .read = function_enum,
135 };
136
137 static int function_txtcidname(struct ast_channel *chan, const char *cmd,
138                                char *data, char *buf, size_t len)
139 {
140         int res;
141         char tech[80];
142         char txt[256] = "";
143         char dest[80];
144         struct ast_module_user *u;
145
146         buf[0] = '\0';
147
148
149         if (ast_strlen_zero(data)) {
150                 ast_log(LOG_WARNING, "TXTCIDNAME requires an argument (number)\n");
151                 return -1;
152         }
153
154         u = ast_module_user_add(chan);
155
156         res = ast_get_txt(chan, data, dest, sizeof(dest), tech, sizeof(tech), txt,
157                           sizeof(txt));
158
159         if (!ast_strlen_zero(txt))
160                 ast_copy_string(buf, txt, len);
161
162         ast_module_user_remove(u);
163
164         return 0;
165 }
166
167 static struct ast_custom_function txtcidname_function = {
168         .name = "TXTCIDNAME",
169         .synopsis = "TXTCIDNAME looks up a caller name via DNS",
170         .syntax = "TXTCIDNAME(<number>)",
171         .desc =
172                 "This function looks up the given phone number in DNS to retrieve\n"
173                 "the caller id name.  The result will either be blank or be the value\n"
174                 "found in the TXT record in DNS.\n",
175         .read = function_txtcidname,
176 };
177
178 static 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         ast_module_user_hangup_all();
186
187         return res;
188 }
189
190 static 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 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "ENUM related dialplan functions");