/**
* @file src/util/configuration.c
* @brief configuration management
- *
* @author Christian Grothoff
*/
/**
- * Parse a configuration file, add all of the options in the
- * file to the configuration environment.
+ * De-serializes configuration
*
* @param cfg configuration to update
- * @param filename name of the configuration file
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @param mem the memory block of serialized configuration
+ * @param size the size of the memory block
+ * @param allow_inline set to GNUNET_YES if we recursively load configuration
+ * from inlined configurations; GNUNET_NO if not and raise warnings
+ * when we come across them
+ * @return GNUNET_OK on success, GNUNET_ERROR on error
*/
int
-GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg,
- const char *filename)
+GNUNET_CONFIGURATION_deserialize (struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *mem,
+ const size_t size,
+ int allow_inline)
{
- int dirty;
- char line[256];
- char tag[64];
- char value[192];
- FILE *fp;
+ char *line;
+ char *line_orig;
+ size_t line_size;
+ char *pos;
unsigned int nr;
- int i;
+ size_t r_bytes;
+ size_t to_read;
+ size_t i;
int emptyline;
int ret;
char *section;
- char *fn;
+ char *eq;
+ char *tag;
+ char *value;
- fn = GNUNET_STRINGS_filename_expand (filename);
- if (fn == NULL)
- return GNUNET_SYSERR;
- dirty = cfg->dirty; /* back up value! */
- if (NULL == (fp = FOPEN (fn, "r")))
- {
- LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "fopen", fn);
- GNUNET_free (fn);
- return GNUNET_SYSERR;
- }
- GNUNET_free (fn);
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Deserializing config file\n");
ret = GNUNET_OK;
section = GNUNET_strdup ("");
- memset (line, 0, 256);
nr = 0;
- while (NULL != fgets (line, 255, fp))
+ r_bytes = 0;
+ line_orig = NULL;
+ while (r_bytes < size)
{
+ GNUNET_free_non_null (line_orig);
+ /* fgets-like behaviour on buffer */
+ to_read = size - r_bytes;
+ pos = memchr (&mem[r_bytes], '\n', to_read);
+ if (NULL == pos)
+ {
+ line_orig = GNUNET_strndup (&mem[r_bytes], line_size = to_read);
+ r_bytes += line_size;
+ }
+ else
+ {
+ line_orig = GNUNET_strndup (&mem[r_bytes], line_size = (pos - &mem[r_bytes]));
+ r_bytes += line_size + 1;
+ }
+ line = line_orig;
+ /* increment line number */
nr++;
- for (i = 0; i < 255; i++)
+ /* tabs and '\r' are whitespace */
+ emptyline = GNUNET_YES;
+ for (i = 0; i < line_size; i++)
+ {
if (line[i] == '\t')
line[i] = ' ';
- if (line[0] == '\n' || line[0] == '#' || line[0] == '%' || line[0] == '\r')
- continue;
- emptyline = 1;
- for (i = 0; (i < 255 && line[i] != 0); i++)
- if (line[i] != ' ' && line[i] != '\n' && line[i] != '\r')
- emptyline = 0;
- if (emptyline == 1)
+ if (line[i] == '\r')
+ line[i] = ' ';
+ if (' ' != line[i])
+ emptyline = GNUNET_NO;
+ }
+ /* ignore empty lines */
+ if (GNUNET_YES == emptyline)
continue;
+
/* remove tailing whitespace */
- for (i = strlen (line) - 1; (i >= 0) && (isspace ((unsigned char) line[i]));
- i--)
+ for (i = line_size - 1; (i >= 1) && (isspace ((unsigned char) line[i]));i--)
line[i] = '\0';
- if (1 == sscanf (line, "@INLINE@ %191[^\n]", value))
- {
+
+ /* remove leading whitespace */
+ for (; line[0] != '\0' && (isspace ((unsigned char) line[0])); line++);
+
+ /* ignore comments */
+ if ( ('#' == line[0]) || ('%' == line[0]) )
+ continue;
+
+ /* handle special "@INLINE@" directive */
+ if (0 == strncasecmp (line,
+ "@INLINE@ ",
+ strlen ("@INLINE@ ")))
+ {
/* @INLINE@ value */
- if (GNUNET_OK != GNUNET_CONFIGURATION_parse (cfg, value))
- ret = GNUNET_SYSERR; /* failed to parse included config */
+ value = &line[strlen ("@INLINE@ ")];
+ if (GNUNET_YES == allow_inline)
+ {
+ if (GNUNET_OK != GNUNET_CONFIGURATION_parse (cfg, value))
+ {
+ ret = GNUNET_SYSERR; /* failed to parse included config */
+ break;
+ }
+ }
+ else
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Ignoring parsing @INLINE@ configurations, not allowed!\n");
+ ret = GNUNET_SYSERR;
+ break;
+ }
+ continue;
}
- else if (1 == sscanf (line, "[%99[^]]]", value))
+ if ( ('[' == line[0]) && (']' == line[line_size - 1]) )
{
/* [value] */
+ line[line_size - 1] = '\0';
+ value = &line[1];
GNUNET_free (section);
section = GNUNET_strdup (value);
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Config section `%s'\n",
+ section);
+ continue;
}
- else if (2 == sscanf (line, " %63[^= ] = %191[^\n]", tag, value))
+ if (NULL != (eq = strchr (line, '=')))
{
/* tag = value */
- /* Strip LF */
- i = strlen (value) - 1;
- while ((i >= 0) && (isspace ((unsigned char) value[i])))
- value[i--] = '\0';
+ tag = GNUNET_strndup (line, eq - line);
+ /* remove tailing whitespace */
+ for (i = strlen (tag) - 1; (i >= 1) && (isspace ((unsigned char) tag[i]));i--)
+ tag[i] = '\0';
+
+ /* Strip whitespace */
+ value = eq + 1;
+ while (isspace ((unsigned char) value[0]))
+ value++;
+ for (i = strlen (value) - 1; (i >= 1) && (isspace ((unsigned char) value[i]));i--)
+ value[i] = '\0';
+
/* remove quotes */
i = 0;
- if (value[0] == '"')
+ if ( ('"' == value[0]) &&
+ ('"' == value[strlen (value) - 1]) )
{
- i = 1;
- while ((value[i] != '\0') && (value[i] != '"'))
- i++;
- if (value[i] == '"')
- {
- value[i] = '\0';
- i = 1;
- }
- else
- i = 0;
+ value[strlen (value) - 1] = '\0';
+ value++;
}
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Config value %s=\"%s\"\n", tag, value);
GNUNET_CONFIGURATION_set_value_string (cfg, section, tag, &value[i]);
+ GNUNET_free (tag);
+ continue;
}
- else if (1 == sscanf (line, " %63[^= ] =[^\n]", tag))
- {
- /* tag = */
- GNUNET_CONFIGURATION_set_value_string (cfg, section, tag, "");
- }
- else
- {
- /* parse error */
- LOG (GNUNET_ERROR_TYPE_WARNING,
- _("Syntax error in configuration file `%s' at line %u.\n"), filename,
- nr);
- ret = GNUNET_SYSERR;
- break;
- }
+ /* parse error */
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ _("Syntax error while deserializing in line %u\n"),
+ nr);
+ ret = GNUNET_SYSERR;
+ break;
+ }
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Finished deserializing config\n");
+ GNUNET_free_non_null (line_orig);
+ GNUNET_free (section);
+ GNUNET_assert ( (GNUNET_OK != ret) || (r_bytes == size) );
+ return ret;
+}
+
+
+/**
+ * Parse a configuration file, add all of the options in the
+ * file to the configuration environment.
+ *
+ * @param cfg configuration to update
+ * @param filename name of the configuration file
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ */
+int
+GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *filename)
+{
+ uint64_t fs64;
+ size_t fs;
+ char *fn;
+ char *mem;
+ int dirty;
+ int ret;
+
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Asked to parse config file `%s'\n", filename);
+ fn = GNUNET_STRINGS_filename_expand (filename);
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Config file name expanded to `%s'\n", fn);
+ if (fn == NULL)
+ return GNUNET_SYSERR;
+ dirty = cfg->dirty; /* back up value! */
+ if (GNUNET_SYSERR ==
+ GNUNET_DISK_file_size (fn, &fs64, GNUNET_YES, GNUNET_YES))
+ {
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ "Error while determining the file size of %s\n", fn);
+ GNUNET_free (fn);
+ return GNUNET_SYSERR;
+ }
+ if (fs64 > SIZE_MAX)
+ {
+ GNUNET_break (0); /* File size is more than the heap size */
+ GNUNET_free (fn);
+ return GNUNET_SYSERR;
+ }
+ fs = fs64;
+ mem = GNUNET_malloc (fs);
+ if (fs != GNUNET_DISK_fn_read (fn, mem, fs))
+ {
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ "Error while reading file %s\n", fn);
+ GNUNET_free (fn);
+ GNUNET_free (mem);
+ return GNUNET_SYSERR;
}
- GNUNET_assert (0 == fclose (fp));
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Deserializing contents of file `%s'\n", fn);
+ GNUNET_free (fn);
+ ret = GNUNET_CONFIGURATION_deserialize (cfg, mem, fs, GNUNET_YES);
+ GNUNET_free (mem);
/* restore dirty flag - anything we set in the meantime
* came from disk */
cfg->dirty = dirty;
- GNUNET_free (section);
return ret;
}
/**
- * Write configuration file.
+ * Serializes the given configuration.
*
- * @param cfg configuration to write
- * @param filename where to write the configuration
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @param cfg configuration to serialize
+ * @param size will be set to the size of the serialized memory block
+ * @return the memory block where the serialized configuration is
+ * present. This memory should be freed by the caller
*/
-int
-GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg,
- const char *filename)
+char *
+GNUNET_CONFIGURATION_serialize (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ size_t *size)
{
struct ConfigSection *sec;
struct ConfigEntry *ent;
- FILE *fp;
- int error;
- char *fn;
+ char *mem;
+ char *cbuf;
char *val;
char *pos;
+ int len;
+ size_t m_size;
+ size_t c_size;
- fn = GNUNET_STRINGS_filename_expand (filename);
- if (fn == NULL)
- return GNUNET_SYSERR;
- if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn))
- {
- GNUNET_free (fn);
- return GNUNET_SYSERR;
- }
- if (NULL == (fp = FOPEN (fn, "w")))
- {
- LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "fopen", fn);
- GNUNET_free (fn);
- return GNUNET_SYSERR;
- }
- GNUNET_free (fn);
- error = 0;
+
+ /* Pass1 : calculate the buffer size required */
+ m_size = 0;
sec = cfg->sections;
- while (sec != NULL)
+ while (NULL != sec)
{
- if (0 > fprintf (fp, "[%s]\n", sec->name))
+ /* For each section we need to add 3 charaters: {'[',']','\n'} */
+ m_size += strlen (sec->name) + 3;
+ ent = sec->entries;
+ while (NULL != ent)
{
- error = 1;
- break;
+ if (NULL != ent->val)
+ {
+ /* if val has any '\n' then they occupy +1 character as '\n'->'\\','n' */
+ pos = ent->val;
+ while (NULL != (pos = strstr (pos, "\n")))
+ {
+ m_size++;
+ pos++;
+ }
+ /* For each key = value pair we need to add 4 characters (2
+ spaces and 1 equal-to character and 1 new line) */
+ m_size += strlen (ent->key) + strlen (ent->val) + 4;
+ }
+ ent = ent->next;
}
+ /* A new line after section end */
+ m_size++;
+ sec = sec->next;
+ }
+
+ /* Pass2: Allocate memory and write the configuration to it */
+ mem = GNUNET_malloc (m_size);
+ sec = cfg->sections;
+ c_size = 0;
+ *size = c_size;
+ while (NULL != sec)
+ {
+ len = GNUNET_asprintf (&cbuf, "[%s]\n", sec->name);
+ GNUNET_assert (0 < len);
+ memcpy (mem + c_size, cbuf, len);
+ c_size += len;
+ GNUNET_free (cbuf);
ent = sec->entries;
- while (ent != NULL)
+ while (NULL != ent)
{
- if (ent->val != NULL)
+ if (NULL != ent->val)
{
- val = GNUNET_malloc (strlen (ent->val) * 2 + 1);
- strcpy (val, ent->val);
+ val = GNUNET_malloc (strlen (ent->val) * 2 + 1);
+ strcpy (val, ent->val);
while (NULL != (pos = strstr (val, "\n")))
{
memmove (&pos[2], &pos[1], strlen (&pos[1]));
pos[0] = '\\';
pos[1] = 'n';
}
- if (0 > fprintf (fp, "%s = %s\n", ent->key, val))
- {
- error = 1;
- GNUNET_free (val);
- break;
- }
- GNUNET_free (val);
+ len = GNUNET_asprintf (&cbuf, "%s = %s\n", ent->key, val);
+ GNUNET_free (val);
+ memcpy (mem + c_size, cbuf, len);
+ c_size += len;
+ GNUNET_free (cbuf);
}
ent = ent->next;
}
- if (error != 0)
- break;
- if (0 > fprintf (fp, "\n"))
- {
- error = 1;
- break;
- }
+ memcpy (mem + c_size, "\n", 1);
+ c_size ++;
sec = sec->next;
}
- if (error != 0)
- LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "fprintf", filename);
- GNUNET_assert (0 == fclose (fp));
- if (error != 0)
+ GNUNET_assert (c_size == m_size);
+ *size = c_size;
+ return mem;
+}
+
+
+/**
+ * Write configuration file.
+ *
+ * @param cfg configuration to write
+ * @param filename where to write the configuration
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ */
+int
+GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *filename)
+{
+ char *fn;
+ char *cfg_buf;
+ size_t size;
+
+ fn = GNUNET_STRINGS_filename_expand (filename);
+ if (fn == NULL)
+ return GNUNET_SYSERR;
+ if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn))
+ {
+ GNUNET_free (fn);
+ return GNUNET_SYSERR;
+ }
+ cfg_buf = GNUNET_CONFIGURATION_serialize (cfg, &size);
+ if (size != GNUNET_DISK_fn_write (fn, cfg_buf, size,
+ GNUNET_DISK_PERM_USER_READ
+ | GNUNET_DISK_PERM_USER_WRITE
+ | GNUNET_DISK_PERM_GROUP_READ
+ | GNUNET_DISK_PERM_GROUP_WRITE))
{
+ GNUNET_free (fn);
+ GNUNET_free (cfg_buf);
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ "Writing configration to file: %s failed\n", filename);
cfg->dirty = GNUNET_SYSERR; /* last write failed */
return GNUNET_SYSERR;
}
+ GNUNET_free (fn);
+ GNUNET_free (cfg_buf);
cfg->dirty = GNUNET_NO; /* last write succeeded */
return GNUNET_OK;
}
struct ConfigEntry *epos;
spos = cfg->sections;
- while ((spos != NULL) && (0 != strcmp (spos->name, section)))
+ while ((spos != NULL) && (0 != strcasecmp (spos->name, section)))
spos = spos->next;
if (spos == NULL)
spos = cfg->sections;
while (spos != NULL)
{
- if (0 == strcmp (section, spos->name))
+ if (0 == strcasecmp (section, spos->name))
{
if (prev == NULL)
cfg->sections = spos->next;
* @param value value to copy (of the default conf.)
*/
static void
-compareEntries (void *cls, const char *section, const char *option,
- const char *value)
+compare_entries (void *cls, const char *section, const char *option,
+ const char *value)
{
struct DiffHandle *dh = cls;
struct ConfigEntry *entNew;
}
+/**
+ * Compute configuration with only entries that have been changed
+ *
+ * @param cfgDefault original configuration
+ * @param cfgNew new configuration
+ * @return configuration with only the differences, never NULL
+ */
+struct GNUNET_CONFIGURATION_Handle *
+GNUNET_CONFIGURATION_get_diff (const struct GNUNET_CONFIGURATION_Handle
+ *cfgDefault,
+ const struct GNUNET_CONFIGURATION_Handle
+ *cfgNew)
+{
+ struct DiffHandle diffHandle;
+
+ diffHandle.cfgDiff = GNUNET_CONFIGURATION_create ();
+ diffHandle.cfgDefault = cfgDefault;
+ GNUNET_CONFIGURATION_iterate (cfgNew, &compare_entries, &diffHandle);
+ return diffHandle.cfgDiff;
+}
+
+
/**
* Write only configuration entries that have been changed to configuration file
* @param cfgDefault default configuration
*cfgNew, const char *filename)
{
int ret;
- struct DiffHandle diffHandle;
+ struct GNUNET_CONFIGURATION_Handle *diff;
- diffHandle.cfgDiff = GNUNET_CONFIGURATION_create ();
- diffHandle.cfgDefault = cfgDefault;
- GNUNET_CONFIGURATION_iterate (cfgNew, compareEntries, &diffHandle);
- ret = GNUNET_CONFIGURATION_write (diffHandle.cfgDiff, filename);
- GNUNET_CONFIGURATION_destroy (diffHandle.cfgDiff);
+ diff = GNUNET_CONFIGURATION_get_diff (cfgDefault, cfgNew);
+ ret = GNUNET_CONFIGURATION_write (diff, filename);
+ GNUNET_CONFIGURATION_destroy (diff);
return ret;
}
{
struct ConfigSection *sec;
struct ConfigEntry *e;
+ char *nv;
e = findEntry (cfg, section, option);
if (e != NULL)
{
+ nv = GNUNET_strdup (value);
GNUNET_free_non_null (e->val);
- e->val = GNUNET_strdup (value);
+ e->val = nv;
return;
}
sec = findSection (cfg, section);
{
struct ConfigEntry *e;
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Asked to retrieve string `%s' in section `%s'\n", option, section);
e = findEntry (cfg, section, option);
if ((e == NULL) || (e->val == NULL))
{
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to retrieve the string\n");
*value = NULL;
return GNUNET_SYSERR;
}
*value = GNUNET_strdup (e->val);
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Retrieved string `%s'\n", e->val);
return GNUNET_OK;
}
const char *post;
const char *env;
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Asked to $-expand %s\n", orig);
+
if (orig[0] != '$')
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Doesn't start with $ - not expanding\n");
return orig;
+ }
i = 0;
while ((orig[i] != '/') && (orig[i] != '\\') && (orig[i] != '\0'))
i++;
orig[i] = '\0';
post = &orig[i + 1];
}
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Split into `%s' and `%s'\n", orig, post);
if (GNUNET_OK !=
GNUNET_CONFIGURATION_get_value_filename (cfg, "PATHS", &orig[1], &prefix))
{
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Filename for `%s' is not in PATHS config section\n", &orig[1]);
if (NULL == (env = getenv (&orig[1])))
{
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "`%s' is not an environment variable\n", &orig[1]);
orig[i] = DIR_SEPARATOR;
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Expanded to `%s' (returning orig)\n", orig);
return orig;
}
prefix = GNUNET_strdup (env);
}
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Prefix is `%s'\n", prefix);
result = GNUNET_malloc (strlen (prefix) + strlen (post) + 2);
strcpy (result, prefix);
if ((strlen (prefix) == 0) ||
strcat (result, post);
GNUNET_free (prefix);
GNUNET_free (orig);
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Expanded to `%s'\n", result);
return result;
}
const char *option, char **value)
{
char *tmp;
-
+
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Asked to retrieve filename `%s' in section `%s'\n", option, section);
if (GNUNET_OK !=
GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &tmp))
{
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to retrieve filename\n");
*value = NULL;
return GNUNET_SYSERR;
}
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Retrieved filename `%s', $-expanding\n", tmp);
tmp = GNUNET_CONFIGURATION_expand_dollar (cfg, tmp);
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Expanded to filename `%s', *nix-expanding\n", tmp);
*value = GNUNET_STRINGS_filename_expand (tmp);
GNUNET_free (tmp);
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Filename result is `%s'\n", *value);
if (*value == NULL)
return GNUNET_SYSERR;
return GNUNET_OK;
parse_configuration_file (void *cls, const char *filename)
{
struct GNUNET_CONFIGURATION_Handle *cfg = cls;
+ char * ext;
int ret;
+ /* Examine file extension */
+ ext = strrchr (filename, '.');
+ if ((NULL == ext) || (0 != strcmp (ext, ".conf")))
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Skipping file `%s'\n", filename);
+ return GNUNET_OK;
+ }
+
ret = GNUNET_CONFIGURATION_parse (cfg, filename);
return ret;
}
+/**
+ * Load default configuration. This function will parse the
+ * defaults from the given defaults_d directory.
+ *
+ * @param cfg configuration to update
+ * @param defaults_d directory with the defaults
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ */
+int
+GNUNET_CONFIGURATION_load_from (struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *defaults_d)
+{
+ if (GNUNET_SYSERR ==
+ GNUNET_DISK_directory_scan (defaults_d, &parse_configuration_file, cfg))
+ return GNUNET_SYSERR; /* no configuration at all found */
+ return GNUNET_OK;
+}
+
+
/**
* Load configuration (starts with defaults, then loads
* system-specific configuration).