README files have changed names, better change references too :-)
[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 LOCAL_USER_DECL;
54
55 static int function_enum(struct ast_channel *chan, 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] = "";
68         struct localuser *u;
69         char *s, *p;
70
71         buf[0] = '\0';
72
73         if (ast_strlen_zero(data)) {
74                 ast_log(LOG_WARNING, synopsis);
75                 return -1;
76         }
77
78         AST_STANDARD_APP_ARGS(args, data);
79
80         if (args.argc < 1) {
81                 ast_log(LOG_WARNING, synopsis);
82                 return -1;
83         }
84
85         ast_copy_string(tech, args.tech ? args.tech : "sip", sizeof(tech));
86
87         if (!args.zone)
88                 args.zone = "e164.arpa";
89
90         if (!args.options)
91                 args.options = "1";
92
93         /* strip any '-' signs from number */
94         for (s = p = args.number; *s; s++) {
95                 if (*s != '-')
96                         *p++ = *s;
97         }
98         *p = '\0';
99
100         LOCAL_USER_ADD(u);
101
102         res = ast_get_enum(chan, p, dest, sizeof(dest), tech, sizeof(tech), args.zone,
103                            args.options);
104
105         LOCAL_USER_REMOVE(u);
106
107         p = strchr(dest, ':');
108         if (p && strcasecmp(tech, "ALL"))
109                 ast_copy_string(buf, p + 1, len);
110         else
111                 ast_copy_string(buf, dest, len);
112
113         return 0;
114 }
115
116 static struct ast_custom_function enum_function = {
117         .name = "ENUMLOOKUP",
118         .synopsis =
119                 "ENUMLOOKUP allows for general or specific querying of NAPTR records"
120                 " or counts of NAPTR types for ENUM or ENUM-like DNS pointers",
121         .syntax =
122                 "ENUMLOOKUP(number[|Method-type[|options[|record#[|zone-suffix]]]])",
123         .desc =
124                 "Option 'c' returns an integer count of the number of NAPTRs of a certain RR type.\n"
125                 "Combination of 'c' and Method-type of 'ALL' will return a count of all NAPTRs for the record.\n"
126                 "Defaults are: Method-type=sip, no options, record=1, zone-suffix=e164.arpa\n\n"
127                 "For more information, see doc/enum.txt",
128         .read = function_enum,
129 };
130
131 static int function_txtcidname(struct ast_channel *chan, char *cmd,
132                                char *data, char *buf, size_t len)
133 {
134         int res;
135         char tech[80];
136         char txt[256] = "";
137         char dest[80];
138         struct localuser *u;
139
140         buf[0] = '\0';
141
142         LOCAL_USER_ADD(u);
143
144         if (ast_strlen_zero(data)) {
145                 ast_log(LOG_WARNING, "TXTCIDNAME requires an argument (number)\n");
146                 LOCAL_USER_REMOVE(u);
147                 return -1;
148         }
149
150         res = ast_get_txt(chan, data, dest, sizeof(dest), tech, sizeof(tech), txt,
151                           sizeof(txt));
152
153         if (!ast_strlen_zero(txt))
154                 ast_copy_string(buf, txt, len);
155
156         LOCAL_USER_REMOVE(u);
157
158         return 0;
159 }
160
161 static struct ast_custom_function txtcidname_function = {
162         .name = "TXTCIDNAME",
163         .synopsis = "TXTCIDNAME looks up a caller name via DNS",
164         .syntax = "TXTCIDNAME(<number>)",
165         .desc =
166                 "This function looks up the given phone number in DNS to retrieve\n"
167                 "the caller id name.  The result will either be blank or be the value\n"
168                 "found in the TXT record in DNS.\n",
169         .read = function_txtcidname,
170 };
171
172 static char *tdesc = "ENUM related dialplan functions";
173
174 int unload_module(void)
175 {
176         int res = 0;
177
178         res |= ast_custom_function_unregister(&enum_function);
179         res |= ast_custom_function_unregister(&txtcidname_function);
180
181         STANDARD_HANGUP_LOCALUSERS;
182
183         return res;
184 }
185
186 int load_module(void)
187 {
188         int res = 0;
189
190         res |= ast_custom_function_register(&enum_function);
191         res |= ast_custom_function_register(&txtcidname_function);
192
193         return res;
194 }
195
196 char *description(void)
197 {
198         return tdesc;
199 }
200
201 int usecount(void)
202 {
203         int res;
204
205         STANDARD_USECOUNT(res);
206
207         return res;
208 }
209
210 char *key()
211 {
212         return ASTERISK_GPL_KEY;
213 }