A few more "moremanager" fixes
[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
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include "asterisk/_private.h"
31 #include <regex.h>
32 #include <signal.h>
33
34 #include "asterisk/dnsmgr.h"
35 #include "asterisk/linkedlists.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/config.h"
38 #include "asterisk/sched.h"
39 #include "asterisk/cli.h"
40 #include "asterisk/manager.h"
41
42 static struct sched_context *sched;
43 static int refresh_sched = -1;
44 static pthread_t refresh_thread = AST_PTHREADT_NULL;
45
46 struct ast_dnsmgr_entry {
47         /*! where we will store the resulting address */
48         struct in_addr *result;
49         /*! the last result, used to check if address has changed */
50         struct in_addr last;
51         /*! Set to 1 if the entry changes */
52         int changed:1;
53         ast_mutex_t lock;
54         AST_RWLIST_ENTRY(ast_dnsmgr_entry) list;
55         /*! just 1 here, but we use calloc to allocate the correct size */
56         char name[1];
57 };
58
59 static AST_RWLIST_HEAD_STATIC(entry_list, ast_dnsmgr_entry);
60
61 AST_MUTEX_DEFINE_STATIC(refresh_lock);
62
63 #define REFRESH_DEFAULT 300
64
65 static int enabled;
66 static int refresh_interval;
67
68 struct refresh_info {
69         struct entry_list *entries;
70         int verbose;
71         unsigned int regex_present:1;
72         regex_t filter;
73 };
74
75 static struct refresh_info master_refresh_info = {
76         .entries = &entry_list,
77         .verbose = 0,
78 };
79
80 struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct in_addr *result)
81 {
82         struct ast_dnsmgr_entry *entry;
83
84         if (!result || ast_strlen_zero(name) || !(entry = ast_calloc(1, sizeof(*entry) + strlen(name))))
85                 return NULL;
86
87         entry->result = result;
88         ast_mutex_init(&entry->lock);
89         strcpy(entry->name, name);
90         memcpy(&entry->last, result, sizeof(entry->last));
91
92         AST_RWLIST_WRLOCK(&entry_list);
93         AST_RWLIST_INSERT_HEAD(&entry_list, entry, list);
94         AST_RWLIST_UNLOCK(&entry_list);
95
96         return entry;
97 }
98
99 void ast_dnsmgr_release(struct ast_dnsmgr_entry *entry)
100 {
101         if (!entry)
102                 return;
103
104         AST_RWLIST_WRLOCK(&entry_list);
105         AST_RWLIST_REMOVE(&entry_list, entry, list);
106         AST_RWLIST_UNLOCK(&entry_list);
107         ast_verb(4, "removing dns manager for '%s'\n", entry->name);
108
109         ast_mutex_destroy(&entry->lock);
110         ast_free(entry);
111 }
112
113 int ast_dnsmgr_lookup(const char *name, struct in_addr *result, struct ast_dnsmgr_entry **dnsmgr)
114 {
115         struct ast_hostent ahp;
116         struct hostent *hp;
117
118         if (ast_strlen_zero(name) || !result || !dnsmgr)
119                 return -1;
120
121         if (*dnsmgr && !strcasecmp((*dnsmgr)->name, name))
122                 return 0;
123
124         ast_verb(4, "doing dnsmgr_lookup for '%s'\n", name);
125
126         /* if it's actually an IP address and not a name,
127            there's no need for a managed lookup */
128         if (inet_aton(name, result))
129                 return 0;
130
131         /* do a lookup now but add a manager so it will automagically get updated in the background */
132         if ((hp = ast_gethostbyname(name, &ahp)))
133                 memcpy(result, hp->h_addr, sizeof(result));
134         
135         /* if dnsmgr is not enable don't bother adding an entry */
136         if (!enabled)
137                 return 0;
138         
139         ast_verb(3, "adding dns manager for '%s'\n", name);
140         *dnsmgr = ast_dnsmgr_get(name, result);
141         return !*dnsmgr;
142 }
143
144 /*
145  * Refresh a dnsmgr entry
146  */
147 static int dnsmgr_refresh(struct ast_dnsmgr_entry *entry, int verbose)
148 {
149         struct ast_hostent ahp;
150         struct hostent *hp;
151         char iabuf[INET_ADDRSTRLEN];
152         char iabuf2[INET_ADDRSTRLEN];
153         struct in_addr tmp;
154         int changed = 0;
155         
156         ast_mutex_lock(&entry->lock);
157         if (verbose)
158                 ast_verb(3, "refreshing '%s'\n", entry->name);
159
160         if ((hp = ast_gethostbyname(entry->name, &ahp))) {
161                 /* check to see if it has changed, do callback if requested (where de callback is defined ????) */
162                 memcpy(&tmp, hp->h_addr, sizeof(tmp));
163                 if (tmp.s_addr != entry->last.s_addr) {
164                         ast_copy_string(iabuf, ast_inet_ntoa(entry->last), sizeof(iabuf));
165                         ast_copy_string(iabuf2, ast_inet_ntoa(tmp), sizeof(iabuf2));
166                         ast_log(LOG_NOTICE, "host '%s' changed from %s to %s\n", 
167                                 entry->name, iabuf, iabuf2);
168                         memcpy(entry->result, hp->h_addr, sizeof(entry->result));
169                         memcpy(&entry->last, hp->h_addr, sizeof(entry->last));
170                         changed = entry->changed = 1;
171                 } 
172                 
173         }
174         ast_mutex_unlock(&entry->lock);
175         return changed;
176 }
177
178 int ast_dnsmgr_refresh(struct ast_dnsmgr_entry *entry)
179 {
180         return dnsmgr_refresh(entry, 0);
181 }
182
183 /*
184  * Check if dnsmgr entry has changed from since last call to this function
185  */
186 int ast_dnsmgr_changed(struct ast_dnsmgr_entry *entry) 
187 {
188         int changed;
189
190         ast_mutex_lock(&entry->lock);
191
192         changed = entry->changed;
193         entry->changed = 0;
194
195         ast_mutex_unlock(&entry->lock);
196         
197         return changed;
198 }
199
200 static void *do_refresh(void *data)
201 {
202         for (;;) {
203                 pthread_testcancel();
204                 usleep((ast_sched_wait(sched)*1000));
205                 pthread_testcancel();
206                 ast_sched_runq(sched);
207         }
208         return NULL;
209 }
210
211 static int refresh_list(const void *data)
212 {
213         struct refresh_info *info = (struct refresh_info *)data;
214         struct ast_dnsmgr_entry *entry;
215
216         /* if a refresh or reload is already in progress, exit now */
217         if (ast_mutex_trylock(&refresh_lock)) {
218                 if (info->verbose)
219                         ast_log(LOG_WARNING, "DNS Manager refresh already in progress.\n");
220                 return -1;
221         }
222
223         ast_verb(3, "Refreshing DNS lookups.\n");
224         AST_RWLIST_RDLOCK(info->entries);
225         AST_RWLIST_TRAVERSE(info->entries, entry, list) {
226                 if (info->regex_present && regexec(&info->filter, entry->name, 0, NULL, 0))
227                     continue;
228
229                 dnsmgr_refresh(entry, info->verbose);
230         }
231         AST_RWLIST_UNLOCK(info->entries);
232
233         ast_mutex_unlock(&refresh_lock);
234
235         /* automatically reschedule based on the interval */
236         return refresh_interval * 1000;
237 }
238
239 void dnsmgr_start_refresh(void)
240 {
241         if (refresh_sched > -1) {
242                 ast_sched_del(sched, refresh_sched);
243                 refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
244         }
245 }
246
247 static int do_reload(int loading);
248
249 static char *handle_cli_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
250 {
251         switch (cmd) {
252         case CLI_INIT:
253                 e->command = "dnsmgr reload";
254                 e->usage = 
255                         "Usage: dnsmgr reload\n"
256                         "       Reloads the DNS manager configuration.\n";
257                 return NULL;
258         case CLI_GENERATE:
259                 return NULL;    
260         }
261         if (a->argc > 2)
262                 return CLI_SHOWUSAGE;
263
264         do_reload(0);
265         return CLI_SUCCESS;
266 }
267
268 static char *handle_cli_refresh(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
269 {
270         struct refresh_info info = {
271                 .entries = &entry_list,
272                 .verbose = 1,
273         };
274         switch (cmd) {
275         case CLI_INIT:
276                 e->command = "dnsmgr refresh";
277                 e->usage = 
278                         "Usage: dnsmgr refresh [pattern]\n"
279                         "       Peforms an immediate refresh of the managed DNS entries.\n"
280                         "       Optional regular expression pattern is used to filter the entries to refresh.\n";
281                 return NULL;
282         case CLI_GENERATE:
283                 return NULL;    
284         }
285         if (a->argc > 3)
286                 return CLI_SHOWUSAGE;
287
288         if (a->argc == 3) {
289                 if ( regcomp(&info.filter, a->argv[2], REG_EXTENDED | REG_NOSUB) )
290                         return CLI_SHOWUSAGE;
291                 else
292                         info.regex_present = 1;
293         }
294
295         refresh_list(&info);
296
297         if (info.regex_present)
298                 regfree(&info.filter);
299
300         return CLI_SUCCESS;
301 }
302
303 static char *handle_cli_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
304 {
305         int count = 0;
306         struct ast_dnsmgr_entry *entry;
307         switch (cmd) {
308         case CLI_INIT:
309                 e->command = "dnsmgr status";
310                 e->usage = 
311                         "Usage: dnsmgr status\n"
312                         "       Displays the DNS manager status.\n";
313                 return NULL;
314         case CLI_GENERATE:
315                 return NULL;    
316         }
317
318         if (a->argc > 2)
319                 return CLI_SHOWUSAGE;
320
321         ast_cli(a->fd, "DNS Manager: %s\n", enabled ? "enabled" : "disabled");
322         ast_cli(a->fd, "Refresh Interval: %d seconds\n", refresh_interval);
323         AST_RWLIST_RDLOCK(&entry_list);
324         AST_RWLIST_TRAVERSE(&entry_list, entry, list)
325                 count++;
326         AST_RWLIST_UNLOCK(&entry_list);
327         ast_cli(a->fd, "Number of entries: %d\n", count);
328
329         return CLI_SUCCESS;
330 }
331
332 static struct ast_cli_entry cli_reload = AST_CLI_DEFINE(handle_cli_reload, "Reloads the DNS manager configuration");
333 static struct ast_cli_entry cli_refresh = AST_CLI_DEFINE(handle_cli_refresh, "Performs an immediate refresh");
334 static struct ast_cli_entry cli_status = AST_CLI_DEFINE(handle_cli_status, "Display the DNS manager status");
335
336 int dnsmgr_init(void)
337 {
338         if (!(sched = sched_context_create())) {
339                 ast_log(LOG_ERROR, "Unable to create schedule context.\n");
340                 return -1;
341         }
342         ast_cli_register(&cli_reload);
343         ast_cli_register(&cli_status);
344         ast_cli_register(&cli_refresh);
345         return do_reload(1);
346 }
347
348 int dnsmgr_reload(void)
349 {
350         return do_reload(0);
351 }
352
353 static int do_reload(int loading)
354 {
355         struct ast_config *config;
356         struct ast_flags config_flags = { loading ? 0 : CONFIG_FLAG_FILEUNCHANGED };
357         const char *interval_value;
358         const char *enabled_value;
359         int interval;
360         int was_enabled;
361         int res = -1;
362
363         if ((config = ast_config_load("dnsmgr.conf", config_flags)) == CONFIG_STATUS_FILEUNCHANGED)
364                 return 0;
365
366         /* ensure that no refresh cycles run while the reload is in progress */
367         ast_mutex_lock(&refresh_lock);
368
369         /* reset defaults in preparation for reading config file */
370         refresh_interval = REFRESH_DEFAULT;
371         was_enabled = enabled;
372         enabled = 0;
373
374         if (refresh_sched > -1)
375                 ast_sched_del(sched, refresh_sched);
376
377         if (config) {
378                 if ((enabled_value = ast_variable_retrieve(config, "general", "enable"))) {
379                         enabled = ast_true(enabled_value);
380                 }
381                 if ((interval_value = ast_variable_retrieve(config, "general", "refreshinterval"))) {
382                         if (sscanf(interval_value, "%d", &interval) < 1)
383                                 ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", interval_value);
384                         else if (interval < 0)
385                                 ast_log(LOG_WARNING, "Invalid refresh interval '%d' specified, using default\n", interval);
386                         else
387                                 refresh_interval = interval;
388                 }
389                 ast_config_destroy(config);
390         }
391
392         if (enabled && refresh_interval)
393                 ast_log(LOG_NOTICE, "Managed DNS entries will be refreshed every %d seconds.\n", refresh_interval);
394
395         /* if this reload enabled the manager, create the background thread
396            if it does not exist */
397         if (enabled) {
398                 if (!was_enabled && (refresh_thread == AST_PTHREADT_NULL)) {
399                         if (ast_pthread_create_background(&refresh_thread, NULL, do_refresh, NULL) < 0) {
400                                 ast_log(LOG_ERROR, "Unable to start refresh thread.\n");
401                         }
402                 }
403                 /* make a background refresh happen right away */
404                 refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
405                 res = 0;
406         }
407         /* if this reload disabled the manager and there is a background thread,
408            kill it */
409         else if (!enabled && was_enabled && (refresh_thread != AST_PTHREADT_NULL)) {
410                 /* wake up the thread so it will exit */
411                 pthread_cancel(refresh_thread);
412                 pthread_kill(refresh_thread, SIGURG);
413                 pthread_join(refresh_thread, NULL);
414                 refresh_thread = AST_PTHREADT_NULL;
415                 ast_cli_unregister(&cli_refresh);
416                 res = 0;
417         }
418         else
419                 res = 0;
420
421         ast_mutex_unlock(&refresh_lock);
422         manager_event(EVENT_FLAG_SYSTEM, "Reload", "Module: DNSmgr\r\nStatus: %s\r/nMessage: DNSmgr reload Requested\r\n", enabled ? "Enabled" : "Disabled");
423
424         return res;
425 }