CHANNEL(callid): Give dialplan access to the callid.
[asterisk/asterisk.git] / main / dnsmgr.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005-2006, Kevin P. Fleming
5  *
6  * Kevin P. Fleming <kpfleming@digium.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 Background DNS update manager
22  *
23  * \author Kevin P. Fleming <kpfleming@digium.com>
24  *
25  * \bug There is a minor race condition.  In the event that an IP address
26  * of a dnsmgr managed host changes, there is the potential for the consumer
27  * of that address to access the in_addr data at the same time that the dnsmgr
28  * thread is in the middle of updating it to the new address.
29  */
30
31
32 /*! \li \ref dnsmgr.c uses the configuration file \ref dnsmgr.conf
33  * \addtogroup configuration_file Configuration Files
34  */
35
36 /*!
37  * \page dnsmgr.conf dnsmgr.conf
38  * \verbinclude dnsmgr.conf.sample
39  */
40
41
42 /*** MODULEINFO
43         <support_level>core</support_level>
44  ***/
45
46 #include "asterisk.h"
47
48 #include "asterisk/_private.h"
49 #include <regex.h>
50 #include <signal.h>
51
52 #include "asterisk/dnsmgr.h"
53 #include "asterisk/linkedlists.h"
54 #include "asterisk/utils.h"
55 #include "asterisk/config.h"
56 #include "asterisk/sched.h"
57 #include "asterisk/cli.h"
58 #include "asterisk/manager.h"
59 #include "asterisk/acl.h"
60
61 static struct ast_sched_context *sched;
62 static int refresh_sched = -1;
63 static pthread_t refresh_thread = AST_PTHREADT_NULL;
64
65 struct ast_dnsmgr_entry {
66         /*! where we will store the resulting IP address and port number */
67         struct ast_sockaddr *result;
68         /*! SRV record to lookup, if provided. Composed of service, protocol, and domain name: _Service._Proto.Name */
69         char *service;
70         /*! Address family to filter DNS responses. */
71         unsigned int family;
72         /*! Set to 1 if the entry changes */
73         unsigned int changed:1;
74         /*! Data to pass back to update_func */
75         void *data;
76         /*! The callback function to execute on address update */
77         dns_update_func update_func;
78         ast_mutex_t lock;
79         AST_RWLIST_ENTRY(ast_dnsmgr_entry) list;
80         /*! just 1 here, but we use calloc to allocate the correct size */
81         char name[1];
82 };
83
84 static AST_RWLIST_HEAD_STATIC(entry_list, ast_dnsmgr_entry);
85
86 AST_MUTEX_DEFINE_STATIC(refresh_lock);
87
88 #define REFRESH_DEFAULT 300
89
90 static int enabled;
91 static int refresh_interval;
92
93 struct refresh_info {
94         struct entry_list *entries;
95         int verbose;
96         unsigned int regex_present:1;
97         regex_t filter;
98 };
99
100 static struct refresh_info master_refresh_info = {
101         .entries = &entry_list,
102         .verbose = 0,
103 };
104
105 struct ast_dnsmgr_entry *ast_dnsmgr_get_family(const char *name, struct ast_sockaddr *result, const char *service, unsigned int family)
106 {
107         struct ast_dnsmgr_entry *entry;
108         int total_size = sizeof(*entry) + strlen(name) + (service ? strlen(service) + 1 : 0);
109
110         if (!result || ast_strlen_zero(name) || !(entry = ast_calloc(1, total_size))) {
111                 return NULL;
112         }
113
114         entry->result = result;
115         ast_mutex_init(&entry->lock);
116         strcpy(entry->name, name);
117         if (service) {
118                 entry->service = ((char *) entry) + sizeof(*entry) + strlen(name);
119                 strcpy(entry->service, service);
120         }
121         entry->family = family;
122
123         AST_RWLIST_WRLOCK(&entry_list);
124         AST_RWLIST_INSERT_HEAD(&entry_list, entry, list);
125         AST_RWLIST_UNLOCK(&entry_list);
126
127         return entry;
128 }
129
130 struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct ast_sockaddr *result, const char *service)
131 {
132         return ast_dnsmgr_get_family(name, result, service, 0);
133 }
134
135 void ast_dnsmgr_release(struct ast_dnsmgr_entry *entry)
136 {
137         if (!entry) {
138                 return;
139         }
140
141         AST_RWLIST_WRLOCK(&entry_list);
142         AST_RWLIST_REMOVE(&entry_list, entry, list);
143         AST_RWLIST_UNLOCK(&entry_list);
144         ast_debug(6, "removing dns manager for '%s'\n", entry->name);
145
146         ast_mutex_destroy(&entry->lock);
147         ast_free(entry);
148 }
149
150 static int internal_dnsmgr_lookup(const char *name, struct ast_sockaddr *result, struct ast_dnsmgr_entry **dnsmgr, const char *service, dns_update_func func, void *data)
151 {
152         unsigned int family;
153
154         if (ast_strlen_zero(name) || !result || !dnsmgr) {
155                 return -1;
156         }
157
158         if (*dnsmgr && !strcasecmp((*dnsmgr)->name, name)) {
159                 return 0;
160         }
161
162         /* Lookup address family filter. */
163         family = result->ss.ss_family;
164
165         /*
166          * If it's actually an IP address and not a name, there's no
167          * need for a managed lookup.
168          */
169         if (ast_sockaddr_parse(result, name, PARSE_PORT_FORBID)) {
170                 return 0;
171         }
172
173         ast_debug(6, "doing dnsmgr_lookup for '%s'\n", name);
174
175         /* do a lookup now but add a manager so it will automagically get updated in the background */
176         ast_get_ip_or_srv(result, name, service);
177
178         /* if dnsmgr is not enable don't bother adding an entry */
179         if (!enabled) {
180                 return 0;
181         }
182
183         ast_debug(6, "adding dns manager for '%s'\n", name);
184         *dnsmgr = ast_dnsmgr_get_family(name, result, service, family);
185         (*dnsmgr)->update_func = func;
186         (*dnsmgr)->data = data;
187         return !*dnsmgr;
188 }
189
190 int ast_dnsmgr_lookup(const char *name, struct ast_sockaddr *result, struct ast_dnsmgr_entry **dnsmgr, const char *service)
191 {
192         return internal_dnsmgr_lookup(name, result, dnsmgr, service, NULL, NULL);
193 }
194
195 int ast_dnsmgr_lookup_cb(const char *name, struct ast_sockaddr *result, struct ast_dnsmgr_entry **dnsmgr, const char *service, dns_update_func func, void *data)
196 {
197         return internal_dnsmgr_lookup(name, result, dnsmgr, service, func, data);
198 }
199
200 /*
201  * Refresh a dnsmgr entry
202  */
203 static int dnsmgr_refresh(struct ast_dnsmgr_entry *entry, int verbose)
204 {
205         struct ast_sockaddr tmp = { .len = 0, };
206         int changed = 0;
207
208         ast_mutex_lock(&entry->lock);
209
210         ast_debug(6, "refreshing '%s'\n", entry->name);
211
212         tmp.ss.ss_family = entry->family;
213         if (!ast_get_ip_or_srv(&tmp, entry->name, entry->service)) {
214                 if (!ast_sockaddr_port(&tmp)) {
215                         ast_sockaddr_set_port(&tmp, ast_sockaddr_port(entry->result));
216                 }
217                 if (ast_sockaddr_cmp(&tmp, entry->result)) {
218                         const char *old_addr = ast_strdupa(ast_sockaddr_stringify(entry->result));
219                         const char *new_addr = ast_strdupa(ast_sockaddr_stringify(&tmp));
220
221                         if (entry->update_func) {
222                                 entry->update_func(entry->result, &tmp, entry->data);
223                         } else {
224                                 ast_log(LOG_NOTICE, "dnssrv: host '%s' changed from %s to %s\n",
225                                                 entry->name, old_addr, new_addr);
226
227                                 ast_sockaddr_copy(entry->result, &tmp);
228                                 changed = entry->changed = 1;
229                         }
230                 }
231         }
232
233         ast_mutex_unlock(&entry->lock);
234
235         return changed;
236 }
237
238 int ast_dnsmgr_refresh(struct ast_dnsmgr_entry *entry)
239 {
240         return dnsmgr_refresh(entry, 0);
241 }
242
243 /*
244  * Check if dnsmgr entry has changed from since last call to this function
245  */
246 int ast_dnsmgr_changed(struct ast_dnsmgr_entry *entry)
247 {
248         int changed;
249
250         ast_mutex_lock(&entry->lock);
251
252         changed = entry->changed;
253         entry->changed = 0;
254
255         ast_mutex_unlock(&entry->lock);
256
257         return changed;
258 }
259
260 static void *do_refresh(void *data)
261 {
262         for (;;) {
263                 pthread_testcancel();
264                 usleep((ast_sched_wait(sched)*1000));
265                 pthread_testcancel();
266                 ast_sched_runq(sched);
267         }
268         return NULL;
269 }
270
271 static int refresh_list(const void *data)
272 {
273         struct refresh_info *info = (struct refresh_info *)data;
274         struct ast_dnsmgr_entry *entry;
275
276         /* if a refresh or reload is already in progress, exit now */
277         if (ast_mutex_trylock(&refresh_lock)) {
278                 if (info->verbose) {
279                         ast_log(LOG_WARNING, "DNS Manager refresh already in progress.\n");
280                 }
281                 return -1;
282         }
283
284         ast_debug(6, "Refreshing DNS lookups.\n");
285         AST_RWLIST_RDLOCK(info->entries);
286         AST_RWLIST_TRAVERSE(info->entries, entry, list) {
287                 if (info->regex_present && regexec(&info->filter, entry->name, 0, NULL, 0)) {
288                         continue;
289                 }
290
291                 dnsmgr_refresh(entry, info->verbose);
292         }
293         AST_RWLIST_UNLOCK(info->entries);
294
295         ast_mutex_unlock(&refresh_lock);
296
297         /* automatically reschedule based on the interval */
298         return refresh_interval * 1000;
299 }
300
301 void dnsmgr_start_refresh(void)
302 {
303         if (refresh_sched > -1) {
304                 AST_SCHED_DEL(sched, refresh_sched);
305                 refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
306         }
307 }
308
309 static int do_reload(int loading);
310
311 static char *handle_cli_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
312 {
313         switch (cmd) {
314         case CLI_INIT:
315                 e->command = "dnsmgr reload";
316                 e->usage =
317                         "Usage: dnsmgr reload\n"
318                         "       Reloads the DNS manager configuration.\n";
319                 return NULL;
320         case CLI_GENERATE:
321                 return NULL;
322         }
323         if (a->argc > 2) {
324                 return CLI_SHOWUSAGE;
325         }
326
327         do_reload(0);
328         return CLI_SUCCESS;
329 }
330
331 static char *handle_cli_refresh(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
332 {
333         struct refresh_info info = {
334                 .entries = &entry_list,
335                 .verbose = 1,
336         };
337         switch (cmd) {
338         case CLI_INIT:
339                 e->command = "dnsmgr refresh";
340                 e->usage =
341                         "Usage: dnsmgr refresh [pattern]\n"
342                         "       Peforms an immediate refresh of the managed DNS entries.\n"
343                         "       Optional regular expression pattern is used to filter the entries to refresh.\n";
344                 return NULL;
345         case CLI_GENERATE:
346                 return NULL;
347         }
348
349         if (!enabled) {
350                 ast_cli(a->fd, "DNS Manager is disabled.\n");
351                 return 0;
352         }
353
354         if (a->argc > 3) {
355                 return CLI_SHOWUSAGE;
356         }
357
358         if (a->argc == 3) {
359                 if (regcomp(&info.filter, a->argv[2], REG_EXTENDED | REG_NOSUB)) {
360                         return CLI_SHOWUSAGE;
361                 } else {
362                         info.regex_present = 1;
363                 }
364         }
365
366         refresh_list(&info);
367
368         if (info.regex_present) {
369                 regfree(&info.filter);
370         }
371
372         return CLI_SUCCESS;
373 }
374
375 static char *handle_cli_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
376 {
377         int count = 0;
378         struct ast_dnsmgr_entry *entry;
379         switch (cmd) {
380         case CLI_INIT:
381                 e->command = "dnsmgr status";
382                 e->usage =
383                         "Usage: dnsmgr status\n"
384                         "       Displays the DNS manager status.\n";
385                 return NULL;
386         case CLI_GENERATE:
387                 return NULL;
388         }
389
390         if (a->argc > 2) {
391                 return CLI_SHOWUSAGE;
392         }
393
394         ast_cli(a->fd, "DNS Manager: %s\n", enabled ? "enabled" : "disabled");
395         ast_cli(a->fd, "Refresh Interval: %d seconds\n", refresh_interval);
396         AST_RWLIST_RDLOCK(&entry_list);
397         AST_RWLIST_TRAVERSE(&entry_list, entry, list)
398                 count++;
399         AST_RWLIST_UNLOCK(&entry_list);
400         ast_cli(a->fd, "Number of entries: %d\n", count);
401
402         return CLI_SUCCESS;
403 }
404
405 static struct ast_cli_entry cli_reload = AST_CLI_DEFINE(handle_cli_reload, "Reloads the DNS manager configuration");
406 static struct ast_cli_entry cli_refresh = AST_CLI_DEFINE(handle_cli_refresh, "Performs an immediate refresh");
407 static struct ast_cli_entry cli_status = AST_CLI_DEFINE(handle_cli_status, "Display the DNS manager status");
408
409 static void dnsmgr_shutdown(void)
410 {
411         ast_cli_unregister(&cli_reload);
412         ast_cli_unregister(&cli_status);
413         ast_cli_unregister(&cli_refresh);
414
415         /* Destroy refresh thread. */
416         ast_mutex_lock(&refresh_lock);
417         if (refresh_thread != AST_PTHREADT_NULL) {
418                 /* wake up the thread so it will exit */
419                 pthread_cancel(refresh_thread);
420                 pthread_kill(refresh_thread, SIGURG);
421                 pthread_join(refresh_thread, NULL);
422                 refresh_thread = AST_PTHREADT_NULL;
423         }
424         ast_mutex_unlock(&refresh_lock);
425
426         ast_sched_context_destroy(sched);
427 }
428
429 int dnsmgr_init(void)
430 {
431         if (!(sched = ast_sched_context_create())) {
432                 ast_log(LOG_ERROR, "Unable to create schedule context.\n");
433                 return -1;
434         }
435         ast_cli_register(&cli_reload);
436         ast_cli_register(&cli_status);
437         ast_cli_register(&cli_refresh);
438
439         ast_register_cleanup(dnsmgr_shutdown);
440
441         return do_reload(1);
442 }
443
444 int dnsmgr_reload(void)
445 {
446         return do_reload(0);
447 }
448
449 static int do_reload(int loading)
450 {
451         struct ast_config *config;
452         struct ast_variable *v;
453         struct ast_flags config_flags = { loading ? 0 : CONFIG_FLAG_FILEUNCHANGED };
454         int interval;
455         int was_enabled;
456
457         if ((config = ast_config_load2("dnsmgr.conf", "dnsmgr", config_flags)) == CONFIG_STATUS_FILEUNCHANGED) {
458                 return 0;
459         }
460
461         /* ensure that no refresh cycles run while the reload is in progress */
462         ast_mutex_lock(&refresh_lock);
463
464         /* reset defaults in preparation for reading config file */
465         refresh_interval = REFRESH_DEFAULT;
466         was_enabled = enabled;
467         enabled = 0;
468
469         if (config == CONFIG_STATUS_FILEMISSING || config == CONFIG_STATUS_FILEINVALID) {
470                 ast_mutex_unlock(&refresh_lock);
471                 return 0;
472         }
473
474         AST_SCHED_DEL(sched, refresh_sched);
475
476         for (v = ast_variable_browse(config, "general"); v; v = v->next) {
477                 if (!strcasecmp(v->name, "enable")) {
478                         enabled = ast_true(v->value);
479                 } else if (!strcasecmp(v->name, "refreshinterval")) {
480                         if (sscanf(v->value, "%30d", &interval) < 1) {
481                                 ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", v->value);
482                         } else if (interval < 0) {
483                                 ast_log(LOG_WARNING, "Invalid refresh interval '%d' specified, using default\n", interval);
484                         } else {
485                                 refresh_interval = interval;
486                         }
487                 }
488         }
489         ast_config_destroy(config);
490
491         if (enabled && refresh_interval) {
492                 ast_log(LOG_NOTICE, "Managed DNS entries will be refreshed every %d seconds.\n", refresh_interval);
493         }
494
495         /* if this reload enabled the manager, create the background thread
496            if it does not exist */
497         if (enabled) {
498                 if (!was_enabled && (refresh_thread == AST_PTHREADT_NULL)) {
499                         if (ast_pthread_create_background(&refresh_thread, NULL, do_refresh, NULL) < 0) {
500                                 ast_log(LOG_ERROR, "Unable to start refresh thread.\n");
501                         }
502                 }
503                 /* make a background refresh happen right away */
504                 refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
505         /* if this reload disabled the manager and there is a background thread, kill it */
506         } else if (!enabled && was_enabled && (refresh_thread != AST_PTHREADT_NULL)) {
507                 /* wake up the thread so it will exit */
508                 pthread_cancel(refresh_thread);
509                 pthread_kill(refresh_thread, SIGURG);
510                 pthread_join(refresh_thread, NULL);
511                 refresh_thread = AST_PTHREADT_NULL;
512         }
513
514         ast_mutex_unlock(&refresh_lock);
515
516         return 0;
517 }