X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/e83d0967d4c0965eb8036248acc20d1bf12ad1d8..f8f8039fc44104b43b94467d17a8d71fc40f219b:/lib/configuration.c

diff --git a/lib/configuration.c b/lib/configuration.c
index 5881f87..47ba9f4 100644
--- a/lib/configuration.c
+++ b/lib/configuration.c
@@ -17,6 +17,9 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file lib/configuration.c
+ * @brief Configuration file support
+ */
 
 #include <config.h>
 #include "types.h"
@@ -49,32 +52,51 @@
 #include "regsub.h"
 #include "signame.h"
 
+/** @brief Path to config file 
+ *
+ * set_configfile() sets the deafult if it is null.
+ */
 char *configfile;
 
+/** @brief Config file parser state */
 struct config_state {
+  /** @brief Filename */
   const char *path;
+  /** @brief Line number */
   int line;
+  /** @brief Configuration object under construction */
   struct config *config;
 };
 
+/** @brief Current configuration */
 struct config *config;
 
+/** @brief One configuration item */
 struct conf {
+  /** @brief Name as it appears in the config file */
   const char *name;
+  /** @brief Offset in @ref config structure */
   size_t offset;
+  /** @brief Pointer to item type */
   const struct conftype *type;
+  /** @brief Pointer to item-specific validation routine */
   int (*validate)(const struct config_state *cs,
 		  int nvec, char **vec);
 };
 
+/** @brief Type of a configuration item */
 struct conftype {
+  /** @brief Pointer to function to set item */
   int (*set)(const struct config_state *cs,
 	     const struct conf *whoami,
 	     int nvec, char **vec);
+  /** @brief Pointer to function to free item */
   void (*free)(struct config *c, const struct conf *whoami);
 };
 
+/** @brief Compute the address of an item */
 #define ADDRESS(C, TYPE) ((TYPE *)((char *)(C) + whoami->offset))
+/** @brief Return the value of an item */
 #define VALUE(C, TYPE) (*ADDRESS(C, TYPE))
 
 static int set_signal(const struct config_state *cs,
@@ -772,7 +794,7 @@ static int validate_addrport(const struct config_state attribute((unused)) *cs,
   }
 }
 
-static int validate_address(const struct config_state attribute((unused)) *cs,
+static int validate_port(const struct config_state attribute((unused)) *cs,
 			 int nvec,
 			 char attribute((unused)) **vec) {
   switch(nvec) {
@@ -784,22 +806,23 @@ static int validate_address(const struct config_state attribute((unused)) *cs,
   case 2:
     return 0;
   default:
-    error(0, "%s:%d: expected ADDRESS PORT",
+    error(0, "%s:%d: expected [ADDRESS] PORT",
 	  cs->path, cs->line);
     return -1;
   }
 }
 
-/* configuration table */
-
+/** @brief Item name and and offset */
 #define C(x) #x, offsetof(struct config, x)
+/** @brief Item name and and offset */
 #define C2(x,y) #x, offsetof(struct config, y)
 
+/** @brief All configuration items */
 static const struct conf conf[] = {
   { C(alias),            &type_string,           validate_alias },
   { C(allow),            &type_stringlist_accum, validate_allow },
   { C(broadcast),        &type_stringlist,       validate_addrport },
-  { C(broadcast_from),   &type_stringlist,       validate_address },
+  { C(broadcast_from),   &type_stringlist,       validate_addrport },
   { C(channel),          &type_string,           validate_channel },
   { C(checkpoint_kbyte), &type_integer,          validate_non_negative },
   { C(checkpoint_min),   &type_integer,          validate_non_negative },
@@ -809,9 +832,10 @@ static const struct conf conf[] = {
   { C(gap),              &type_integer,          validate_non_negative },
   { C(history),          &type_integer,          validate_positive },
   { C(home),             &type_string,           validate_isdir },
-  { C(listen),           &type_stringlist,       validate_addrport },
+  { C(listen),           &type_stringlist,       validate_port },
   { C(lock),             &type_boolean,          validate_any },
   { C(mixer),            &type_string,           validate_ischr },
+  { C(multicast_ttl),    &type_integer,          validate_non_negative },
   { C(namepart),         &type_namepart,         validate_any },
   { C2(nice, nice_rescan), &type_integer,        validate_non_negative },
   { C(nice_rescan),      &type_integer,          validate_non_negative },
@@ -839,7 +863,7 @@ static const struct conf conf[] = {
   { C(username),         &type_string,           validate_any },
 };
 
-/* find a configuration item's definition by key */
+/** @brief Find a configuration item's definition by key */
 static const struct conf *find(const char *key) {
   int n;
 
@@ -848,7 +872,7 @@ static const struct conf *find(const char *key) {
   return &conf[n];
 }
 
-/* set a new configuration value */
+/** @brief Set a new configuration value */
 static int config_set(const struct config_state *cs,
 		      int nvec, char **vec) {
   const struct conf *which;
@@ -863,13 +887,14 @@ static int config_set(const struct config_state *cs,
 	  || which->type->set(cs, which, nvec - 1, vec + 1));
 }
 
+/** @brief Error callback used by config_include() */
 static void config_error(const char *msg, void *u) {
   const struct config_state *cs = u;
 
   error(0, "%s:%d: %s", cs->path, cs->line, msg);
 }
 
-/* include a file by name */
+/** @brief Include a file by name */
 static int config_include(struct config *c, const char *path) {
   FILE *fp;
   char *buffer, *inputbuffer, **vec;
@@ -921,7 +946,7 @@ static int config_include(struct config *c, const char *path) {
   return ret;
 }
 
-/* make a new default config */
+/** @brief Make a new default configuration */
 static struct config *config_default(void) {
   struct config *c = xmalloc(sizeof *c);
   const char *logname;
@@ -949,6 +974,7 @@ static struct config *config_default(void) {
   c->sample_format.byte_format = AO_FMT_NATIVE;
   c->queue_pad = 10;
   c->speaker_backend = -1;
+  c->multicast_ttl = 1;
   return c;
 }
 
@@ -959,12 +985,13 @@ static char *get_file(struct config *c, const char *name) {
   return s;
 }
 
+/** @brief Set the default configuration file */
 static void set_configfile(void) {
   if(!configfile)
     byte_xasprintf(&configfile, "%s/config", pkgconfdir);
 }
 
-/* free the config file */
+/** @brief Free a configuration object */
 static void config_free(struct config *c) {
   int n;
 
@@ -978,6 +1005,7 @@ static void config_free(struct config *c) {
   }
 }
 
+/** @brief Set post-parse defaults */
 static void config_postdefaults(struct config *c) {
   struct config_state cs;
   const struct conf *whoami;
@@ -1033,7 +1061,7 @@ static void config_postdefaults(struct config *c) {
     fatal(0, "speaker_backend is network but broadcast is not set");
 }
 
-/* re-read the config file */
+/** @brief (Re-)read the config file */
 int config_read() {
   struct config *c;
   char *privconf;
@@ -1041,8 +1069,10 @@ int config_read() {
 
   set_configfile();
   c = config_default();
-  if(config_include(c, configfile))
-    return -1;
+  /* standalone Disobedience installs might not have a global config file */
+  if(access(configfile, F_OK) == 0)
+    if(config_include(c, configfile))
+      return -1;
   /* if we can read the private config file, do */
   if((privconf = config_private())
      && access(privconf, R_OK) == 0
@@ -1071,6 +1101,7 @@ int config_read() {
   return 0;
 }
 
+/** @brief Return the path to the private configuration file */
 char *config_private(void) {
   char *s;
 
@@ -1079,6 +1110,7 @@ char *config_private(void) {
   return s;
 }
 
+/** @brief Return the path to user's personal configuration file */
 char *config_userconf(const char *home, const struct passwd *pw) {
   char *s;
 
@@ -1086,7 +1118,8 @@ char *config_userconf(const char *home, const struct passwd *pw) {
   return s;
 }
 
-char *config_usersysconf(const struct passwd *pw ) {
+/** @brief Return the path to user-specific system configuration */
+char *config_usersysconf(const struct passwd *pw) {
   char *s;
 
   set_configfile();