Merge "res_calendar: Specialized calendars depend on symbols of general calendar."
[asterisk/asterisk.git] / main / dnsmgr.c
index 2761a97..0e5efd6 100644 (file)
  *
  * \brief Background DNS update manager
  *
- * \author Kevin P. Fleming <kpfleming@digium.com> 
+ * \author Kevin P. Fleming <kpfleming@digium.com>
+ *
+ * \bug There is a minor race condition.  In the event that an IP address
+ * of a dnsmgr managed host changes, there is the potential for the consumer
+ * of that address to access the in_addr data at the same time that the dnsmgr
+ * thread is in the middle of updating it to the new address.
+ */
+
+
+/*! \li \ref dnsmgr.c uses the configuration file \ref dnsmgr.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*!
+ * \page dnsmgr.conf dnsmgr.conf
+ * \verbinclude dnsmgr.conf.sample
  */
 
+
+/*** MODULEINFO
+       <support_level>core</support_level>
+ ***/
+
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
-#include <sys/types.h>
-#include <netinet/in.h>
-#include <sys/socket.h>
-#include <arpa/inet.h>
-#include <resolv.h>
-#include <stdio.h>
-#include <string.h>
-#include <unistd.h>
-#include <stdlib.h>
+#include "asterisk/_private.h"
 #include <regex.h>
 #include <signal.h>
 
@@ -43,22 +53,28 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/linkedlists.h"
 #include "asterisk/utils.h"
 #include "asterisk/config.h"
-#include "asterisk/logger.h"
 #include "asterisk/sched.h"
-#include "asterisk/options.h"
 #include "asterisk/cli.h"
+#include "asterisk/manager.h"
+#include "asterisk/acl.h"
 
-static struct sched_context *sched;
+static struct ast_sched_context *sched;
 static int refresh_sched = -1;
 static pthread_t refresh_thread = AST_PTHREADT_NULL;
 
 struct ast_dnsmgr_entry {
-       /*! where we will store the resulting address */
-       struct in_addr *result;
-       /*! the last result, used to check if address has changed */
-       struct in_addr last;
+       /*! where we will store the resulting IP address and port number */
+       struct ast_sockaddr *result;
+       /*! SRV record to lookup, if provided. Composed of service, protocol, and domain name: _Service._Proto.Name */
+       char *service;
+       /*! Address family to filter DNS responses. */
+       unsigned int family;
        /*! Set to 1 if the entry changes */
-       int changed:1;
+       unsigned int changed:1;
+       /*! Data to pass back to update_func */
+       void *data;
+       /*! The callback function to execute on address update */
+       dns_update_func update_func;
        ast_mutex_t lock;
        AST_RWLIST_ENTRY(ast_dnsmgr_entry) list;
        /*! just 1 here, but we use calloc to allocate the correct size */
@@ -86,17 +102,23 @@ static struct refresh_info master_refresh_info = {
        .verbose = 0,
 };
 
-struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct in_addr *result)
+struct ast_dnsmgr_entry *ast_dnsmgr_get_family(const char *name, struct ast_sockaddr *result, const char *service, unsigned int family)
 {
        struct ast_dnsmgr_entry *entry;
+       int total_size = sizeof(*entry) + strlen(name) + (service ? strlen(service) + 1 : 0);
 
-       if (!result || ast_strlen_zero(name) || !(entry = ast_calloc(1, sizeof(*entry) + strlen(name))))
+       if (!result || ast_strlen_zero(name) || !(entry = ast_calloc(1, total_size))) {
                return NULL;
+       }
 
        entry->result = result;
        ast_mutex_init(&entry->lock);
        strcpy(entry->name, name);
-       memcpy(&entry->last, result, sizeof(entry->last));
+       if (service) {
+               entry->service = ((char *) entry) + sizeof(*entry) + strlen(name);
+               strcpy(entry->service, service);
+       }
+       entry->family = family;
 
        AST_RWLIST_WRLOCK(&entry_list);
        AST_RWLIST_INSERT_HEAD(&entry_list, entry, list);
@@ -105,82 +127,111 @@ struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct in_addr *result
        return entry;
 }
 
+struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct ast_sockaddr *result, const char *service)
+{
+       return ast_dnsmgr_get_family(name, result, service, 0);
+}
+
 void ast_dnsmgr_release(struct ast_dnsmgr_entry *entry)
 {
-       if (!entry)
+       if (!entry) {
                return;
+       }
 
        AST_RWLIST_WRLOCK(&entry_list);
        AST_RWLIST_REMOVE(&entry_list, entry, list);
        AST_RWLIST_UNLOCK(&entry_list);
-       ast_verb(4, "removing dns manager for '%s'\n", entry->name);
+       ast_debug(6, "removing dns manager for '%s'\n", entry->name);
 
        ast_mutex_destroy(&entry->lock);
        ast_free(entry);
 }
 
-int ast_dnsmgr_lookup(const char *name, struct in_addr *result, struct ast_dnsmgr_entry **dnsmgr)
+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)
 {
-       struct ast_hostent ahp;
-       struct hostent *hp;
+       unsigned int family;
 
-       if (ast_strlen_zero(name) || !result || !dnsmgr)
+       if (ast_strlen_zero(name) || !result || !dnsmgr) {
                return -1;
+       }
 
-       if (*dnsmgr && !strcasecmp((*dnsmgr)->name, name))
+       if (*dnsmgr && !strcasecmp((*dnsmgr)->name, name)) {
                return 0;
+       }
 
-       ast_verb(4, "doing dnsmgr_lookup for '%s'\n", name);
+       /* Lookup address family filter. */
+       family = result->ss.ss_family;
 
-       /* if it's actually an IP address and not a name,
-          there's no need for a managed lookup */
-       if (inet_aton(name, result))
+       /*
+        * If it's actually an IP address and not a name, there's no
+        * need for a managed lookup.
+        */
+       if (ast_sockaddr_parse(result, name, PARSE_PORT_FORBID)) {
                return 0;
+       }
+
+       ast_debug(6, "doing dnsmgr_lookup for '%s'\n", name);
 
        /* do a lookup now but add a manager so it will automagically get updated in the background */
-       if ((hp = ast_gethostbyname(name, &ahp)))
-               memcpy(result, hp->h_addr, sizeof(result));
-       
+       ast_get_ip_or_srv(result, name, service);
+
        /* if dnsmgr is not enable don't bother adding an entry */
-       if (!enabled)
+       if (!enabled) {
                return 0;
-       
-       ast_verb(3, "adding dns manager for '%s'\n", name);
-       *dnsmgr = ast_dnsmgr_get(name, result);
+       }
+
+       ast_debug(6, "adding dns manager for '%s'\n", name);
+       *dnsmgr = ast_dnsmgr_get_family(name, result, service, family);
+       (*dnsmgr)->update_func = func;
+       (*dnsmgr)->data = data;
        return !*dnsmgr;
 }
 
+int ast_dnsmgr_lookup(const char *name, struct ast_sockaddr *result, struct ast_dnsmgr_entry **dnsmgr, const char *service)
+{
+       return internal_dnsmgr_lookup(name, result, dnsmgr, service, NULL, NULL);
+}
+
+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)
+{
+       return internal_dnsmgr_lookup(name, result, dnsmgr, service, func, data);
+}
+
 /*
  * Refresh a dnsmgr entry
  */
 static int dnsmgr_refresh(struct ast_dnsmgr_entry *entry, int verbose)
 {
-       struct ast_hostent ahp;
-       struct hostent *hp;
-       char iabuf[INET_ADDRSTRLEN];
-       char iabuf2[INET_ADDRSTRLEN];
-       struct in_addr tmp;
+       struct ast_sockaddr tmp = { .len = 0, };
        int changed = 0;
-        
+
        ast_mutex_lock(&entry->lock);
-       if (verbose)
-               ast_verb(3, "refreshing '%s'\n", entry->name);
-
-       if ((hp = ast_gethostbyname(entry->name, &ahp))) {
-               /* check to see if it has changed, do callback if requested (where de callback is defined ????) */
-               memcpy(&tmp, hp->h_addr, sizeof(tmp));
-               if (tmp.s_addr != entry->last.s_addr) {
-                       ast_copy_string(iabuf, ast_inet_ntoa(entry->last), sizeof(iabuf));
-                       ast_copy_string(iabuf2, ast_inet_ntoa(tmp), sizeof(iabuf2));
-                       ast_log(LOG_NOTICE, "host '%s' changed from %s to %s\n", 
-                               entry->name, iabuf, iabuf2);
-                       memcpy(entry->result, hp->h_addr, sizeof(entry->result));
-                       memcpy(&entry->last, hp->h_addr, sizeof(entry->last));
-                       changed = entry->changed = 1;
-               } 
-               
+
+       ast_debug(6, "refreshing '%s'\n", entry->name);
+
+       tmp.ss.ss_family = entry->family;
+       if (!ast_get_ip_or_srv(&tmp, entry->name, entry->service)) {
+               if (!ast_sockaddr_port(&tmp)) {
+                       ast_sockaddr_set_port(&tmp, ast_sockaddr_port(entry->result));
+               }
+               if (ast_sockaddr_cmp(&tmp, entry->result)) {
+                       const char *old_addr = ast_strdupa(ast_sockaddr_stringify(entry->result));
+                       const char *new_addr = ast_strdupa(ast_sockaddr_stringify(&tmp));
+
+                       if (entry->update_func) {
+                               entry->update_func(entry->result, &tmp, entry->data);
+                       } else {
+                               ast_log(LOG_NOTICE, "dnssrv: host '%s' changed from %s to %s\n",
+                                               entry->name, old_addr, new_addr);
+
+                               ast_sockaddr_copy(entry->result, &tmp);
+                               changed = entry->changed = 1;
+                       }
+               }
        }
+
        ast_mutex_unlock(&entry->lock);
+
        return changed;
 }
 
@@ -192,7 +243,7 @@ int ast_dnsmgr_refresh(struct ast_dnsmgr_entry *entry)
 /*
  * Check if dnsmgr entry has changed from since last call to this function
  */
-int ast_dnsmgr_changed(struct ast_dnsmgr_entry *entry) 
+int ast_dnsmgr_changed(struct ast_dnsmgr_entry *entry)
 {
        int changed;
 
@@ -202,7 +253,7 @@ int ast_dnsmgr_changed(struct ast_dnsmgr_entry *entry)
        entry->changed = 0;
 
        ast_mutex_unlock(&entry->lock);
-       
+
        return changed;
 }
 
@@ -224,16 +275,18 @@ static int refresh_list(const void *data)
 
        /* if a refresh or reload is already in progress, exit now */
        if (ast_mutex_trylock(&refresh_lock)) {
-               if (info->verbose)
+               if (info->verbose) {
                        ast_log(LOG_WARNING, "DNS Manager refresh already in progress.\n");
+               }
                return -1;
        }
 
-       ast_verb(3, "Refreshing DNS lookups.\n");
+       ast_debug(6, "Refreshing DNS lookups.\n");
        AST_RWLIST_RDLOCK(info->entries);
        AST_RWLIST_TRAVERSE(info->entries, entry, list) {
-               if (info->regex_present && regexec(&info->filter, entry->name, 0, NULL, 0))
-                   continue;
+               if (info->regex_present && regexec(&info->filter, entry->name, 0, NULL, 0)) {
+                       continue;
+               }
 
                dnsmgr_refresh(entry, info->verbose);
        }
@@ -248,7 +301,7 @@ static int refresh_list(const void *data)
 void dnsmgr_start_refresh(void)
 {
        if (refresh_sched > -1) {
-               ast_sched_del(sched, refresh_sched);
+               AST_SCHED_DEL(sched, refresh_sched);
                refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
        }
 }
@@ -260,15 +313,16 @@ static char *handle_cli_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_
        switch (cmd) {
        case CLI_INIT:
                e->command = "dnsmgr reload";
-               e->usage = 
+               e->usage =
                        "Usage: dnsmgr reload\n"
                        "       Reloads the DNS manager configuration.\n";
                return NULL;
        case CLI_GENERATE:
-               return NULL;    
+               return NULL;
        }
-       if (a->argc > 2)
+       if (a->argc > 2) {
                return CLI_SHOWUSAGE;
+       }
 
        do_reload(0);
        return CLI_SUCCESS;
@@ -283,28 +337,37 @@ static char *handle_cli_refresh(struct ast_cli_entry *e, int cmd, struct ast_cli
        switch (cmd) {
        case CLI_INIT:
                e->command = "dnsmgr refresh";
-               e->usage = 
+               e->usage =
                        "Usage: dnsmgr refresh [pattern]\n"
                        "       Peforms an immediate refresh of the managed DNS entries.\n"
                        "       Optional regular expression pattern is used to filter the entries to refresh.\n";
                return NULL;
        case CLI_GENERATE:
-               return NULL;    
+               return NULL;
        }
-       if (a->argc > 3)
+
+       if (!enabled) {
+               ast_cli(a->fd, "DNS Manager is disabled.\n");
+               return 0;
+       }
+
+       if (a->argc > 3) {
                return CLI_SHOWUSAGE;
+       }
 
        if (a->argc == 3) {
-               if ( regcomp(&info.filter, a->argv[2], REG_EXTENDED | REG_NOSUB) )
+               if (regcomp(&info.filter, a->argv[2], REG_EXTENDED | REG_NOSUB)) {
                        return CLI_SHOWUSAGE;
-               else
+               } else {
                        info.regex_present = 1;
+               }
        }
 
        refresh_list(&info);
 
-       if (info.regex_present)
+       if (info.regex_present) {
                regfree(&info.filter);
+       }
 
        return CLI_SUCCESS;
 }
@@ -316,16 +379,17 @@ static char *handle_cli_status(struct ast_cli_entry *e, int cmd, struct ast_cli_
        switch (cmd) {
        case CLI_INIT:
                e->command = "dnsmgr status";
-               e->usage = 
+               e->usage =
                        "Usage: dnsmgr status\n"
                        "       Displays the DNS manager status.\n";
                return NULL;
        case CLI_GENERATE:
-               return NULL;    
+               return NULL;
        }
 
-       if (a->argc > 2)
+       if (a->argc > 2) {
                return CLI_SHOWUSAGE;
+       }
 
        ast_cli(a->fd, "DNS Manager: %s\n", enabled ? "enabled" : "disabled");
        ast_cli(a->fd, "Refresh Interval: %d seconds\n", refresh_interval);
@@ -338,19 +402,42 @@ static char *handle_cli_status(struct ast_cli_entry *e, int cmd, struct ast_cli_
        return CLI_SUCCESS;
 }
 
-static struct ast_cli_entry cli_reload = NEW_CLI(handle_cli_reload, "Reloads the DNS manager configuration");
-static struct ast_cli_entry cli_refresh = NEW_CLI(handle_cli_refresh, "Performs an immediate refresh");
-static struct ast_cli_entry cli_status = NEW_CLI(handle_cli_status, "Display the DNS manager status");
+static struct ast_cli_entry cli_reload = AST_CLI_DEFINE(handle_cli_reload, "Reloads the DNS manager configuration");
+static struct ast_cli_entry cli_refresh = AST_CLI_DEFINE(handle_cli_refresh, "Performs an immediate refresh");
+static struct ast_cli_entry cli_status = AST_CLI_DEFINE(handle_cli_status, "Display the DNS manager status");
+
+static void dnsmgr_shutdown(void)
+{
+       ast_cli_unregister(&cli_reload);
+       ast_cli_unregister(&cli_status);
+       ast_cli_unregister(&cli_refresh);
+
+       /* Destroy refresh thread. */
+       ast_mutex_lock(&refresh_lock);
+       if (refresh_thread != AST_PTHREADT_NULL) {
+               /* wake up the thread so it will exit */
+               pthread_cancel(refresh_thread);
+               pthread_kill(refresh_thread, SIGURG);
+               pthread_join(refresh_thread, NULL);
+               refresh_thread = AST_PTHREADT_NULL;
+       }
+       ast_mutex_unlock(&refresh_lock);
+
+       ast_sched_context_destroy(sched);
+}
 
 int dnsmgr_init(void)
 {
-       if (!(sched = sched_context_create())) {
+       if (!(sched = ast_sched_context_create())) {
                ast_log(LOG_ERROR, "Unable to create schedule context.\n");
                return -1;
        }
        ast_cli_register(&cli_reload);
        ast_cli_register(&cli_status);
        ast_cli_register(&cli_refresh);
+
+       ast_register_cleanup(dnsmgr_shutdown);
+
        return do_reload(1);
 }
 
@@ -362,15 +449,14 @@ int dnsmgr_reload(void)
 static int do_reload(int loading)
 {
        struct ast_config *config;
+       struct ast_variable *v;
        struct ast_flags config_flags = { loading ? 0 : CONFIG_FLAG_FILEUNCHANGED };
-       const char *interval_value;
-       const char *enabled_value;
        int interval;
        int was_enabled;
-       int res = -1;
 
-       if ((config = ast_config_load("dnsmgr.conf", config_flags)) == CONFIG_STATUS_FILEUNCHANGED)
+       if ((config = ast_config_load2("dnsmgr.conf", "dnsmgr", config_flags)) == CONFIG_STATUS_FILEUNCHANGED) {
                return 0;
+       }
 
        /* ensure that no refresh cycles run while the reload is in progress */
        ast_mutex_lock(&refresh_lock);
@@ -380,26 +466,31 @@ static int do_reload(int loading)
        was_enabled = enabled;
        enabled = 0;
 
-       if (refresh_sched > -1)
-               ast_sched_del(sched, refresh_sched);
+       if (config == CONFIG_STATUS_FILEMISSING || config == CONFIG_STATUS_FILEINVALID) {
+               ast_mutex_unlock(&refresh_lock);
+               return 0;
+       }
 
-       if (config) {
-               if ((enabled_value = ast_variable_retrieve(config, "general", "enable"))) {
-                       enabled = ast_true(enabled_value);
-               }
-               if ((interval_value = ast_variable_retrieve(config, "general", "refreshinterval"))) {
-                       if (sscanf(interval_value, "%d", &interval) < 1)
-                               ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", interval_value);
-                       else if (interval < 0)
+       AST_SCHED_DEL(sched, refresh_sched);
+
+       for (v = ast_variable_browse(config, "general"); v; v = v->next) {
+               if (!strcasecmp(v->name, "enable")) {
+                       enabled = ast_true(v->value);
+               } else if (!strcasecmp(v->name, "refreshinterval")) {
+                       if (sscanf(v->value, "%30d", &interval) < 1) {
+                               ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", v->value);
+                       } else if (interval < 0) {
                                ast_log(LOG_WARNING, "Invalid refresh interval '%d' specified, using default\n", interval);
-                       else
+                       } else {
                                refresh_interval = interval;
+                       }
                }
-               ast_config_destroy(config);
        }
+       ast_config_destroy(config);
 
-       if (enabled && refresh_interval)
+       if (enabled && refresh_interval) {
                ast_log(LOG_NOTICE, "Managed DNS entries will be refreshed every %d seconds.\n", refresh_interval);
+       }
 
        /* if this reload enabled the manager, create the background thread
           if it does not exist */
@@ -411,23 +502,16 @@ static int do_reload(int loading)
                }
                /* make a background refresh happen right away */
                refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
-               res = 0;
-       }
-       /* if this reload disabled the manager and there is a background thread,
-          kill it */
-       else if (!enabled && was_enabled && (refresh_thread != AST_PTHREADT_NULL)) {
+       /* if this reload disabled the manager and there is a background thread, kill it */
+       } else if (!enabled && was_enabled && (refresh_thread != AST_PTHREADT_NULL)) {
                /* wake up the thread so it will exit */
                pthread_cancel(refresh_thread);
                pthread_kill(refresh_thread, SIGURG);
                pthread_join(refresh_thread, NULL);
                refresh_thread = AST_PTHREADT_NULL;
-               ast_cli_unregister(&cli_refresh);
-               res = 0;
        }
-       else
-               res = 0;
 
        ast_mutex_unlock(&refresh_lock);
 
-       return res;
+       return 0;
 }