GNUnet  0.19.3
configuration.c File Reference

configuration management More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_configuration_lib.h"
Include dependency graph for configuration.c:

Go to the source code of this file.

Data Structures

struct  ConfigEntry
 configuration entry More...
 
struct  ConfigSection
 configuration section More...
 
struct  ConfigFile
 
struct  GNUNET_CONFIGURATION_Handle
 configuration data More...
 
struct  DiffHandle
 Used for diffing a configuration object against the default one. More...
 
struct  CollectFilesContext
 Closure to collect_files_cb. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from (kind, "util", __VA_ARGS__)
 
#define LOG_STRERROR_FILE(kind, syscall, filename)    GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
 

Functions

void GNUNET_CONFIGURATION_enable_diagnostics (struct GNUNET_CONFIGURATION_Handle *cfg)
 Enable extra diagnostics. More...
 
struct GNUNET_CONFIGURATION_HandleGNUNET_CONFIGURATION_create ()
 Create a new configuration object. More...
 
void GNUNET_CONFIGURATION_destroy (struct GNUNET_CONFIGURATION_Handle *cfg)
 Destroy configuration object. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_parse_and_run (const char *filename, GNUNET_CONFIGURATION_Callback cb, void *cb_cls)
 Parse a configuration file filename and run the function cb with the resulting configuration object. More...
 
static int collect_files_cb (void *cls, const char *filename)
 Function called with a filename. More...
 
static struct ConfigSectionfind_section (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
 Find a section entry from a configuration. More...
 
static int pstrcmp (const void *a, const void *b)
 
enum GNUNET_GenericReturnValue handle_inline (struct GNUNET_CONFIGURATION_Handle *cfg, const char *path_or_glob, bool path_is_glob, const char *restrict_section, const char *source_filename, unsigned int source_lineno)
 Handle an inline directive. More...
 
static struct ConfigEntryfind_entry (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *key)
 Find an entry from a configuration. More...
 
static void set_entry_hint (struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *hint_filename, unsigned int hint_line)
 Set a configuration hint. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_deserialize (struct GNUNET_CONFIGURATION_Handle *cfg, const char *mem, size_t size, const char *source_filename)
 De-serializes configuration. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
 Parse a configuration file, add all of the options in the file to the configuration environment. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_is_dirty (const struct GNUNET_CONFIGURATION_Handle *cfg)
 Test if there are configuration options that were changed since the last save. More...
 
static bool do_skip (const char *sec, const char *key)
 Should we skip this configuration entry when serializing? More...
 
char * GNUNET_CONFIGURATION_serialize (const struct GNUNET_CONFIGURATION_Handle *cfg, size_t *size)
 Serializes the given configuration. More...
 
char * GNUNET_CONFIGURATION_serialize_diagnostics (const struct GNUNET_CONFIGURATION_Handle *cfg)
 Serializes the given configuration with diagnostics information. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
 Write configuration file. More...
 
void GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls)
 Iterate over all options in the configuration. More...
 
void GNUNET_CONFIGURATION_iterate_section_values (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls)
 Iterate over values of a section in the configuration. More...
 
void GNUNET_CONFIGURATION_iterate_sections (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CONFIGURATION_SectionIterator iter, void *iter_cls)
 Iterate over all sections in the configuration. More...
 
void GNUNET_CONFIGURATION_remove_section (struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
 Remove the given section and all options in it. More...
 
static void copy_entry (void *cls, const char *section, const char *option, const char *value)
 Copy a configuration value to the given target configuration. More...
 
struct GNUNET_CONFIGURATION_HandleGNUNET_CONFIGURATION_dup (const struct GNUNET_CONFIGURATION_Handle *cfg)
 Duplicate an existing configuration object. More...
 
static void compare_entries (void *cls, const char *section, const char *option, const char *value)
 A callback function, compares entries from two configurations (default against a new configuration) and write the diffs in a diff-configuration object (the callback object). More...
 
struct GNUNET_CONFIGURATION_HandleGNUNET_CONFIGURATION_get_diff (const struct GNUNET_CONFIGURATION_Handle *cfg_default, const struct GNUNET_CONFIGURATION_Handle *cfg_new)
 Compute configuration with only entries that have been changed. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_write_diffs (const struct GNUNET_CONFIGURATION_Handle *cfg_default, const struct GNUNET_CONFIGURATION_Handle *cfg_new, const char *filename)
 Write only configuration entries that have been changed to configuration file. More...
 
void GNUNET_CONFIGURATION_set_value_string (struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
 Set a configuration value that should be a string. More...
 
void GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long number)
 Set a configuration value that should be a number. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_number (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
 Get a configuration value that should be a number. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_float (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, float *number)
 Get a configuration value that should be a floating point number. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_time (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, struct GNUNET_TIME_Relative *time)
 Get a configuration value that should be a relative time. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_size (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *size)
 Get a configuration value that should be a size in bytes. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
 Get a configuration value that should be a string. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *const *choices, const char **value)
 Get a configuration value that should be in a set of predefined strings. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_data (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, void *buf, size_t buf_size)
 Get Crockford32-encoded fixed-size binary data from a configuration. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
 Test if we have a value for a particular option. More...
 
static char * expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cfg, char *orig, unsigned int depth)
 Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR" where either in the "PATHS" section or the environment "FOO" is set to "DIRECTORY". More...
 
char * GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cfg, char *orig)
 Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR" where either in the "PATHS" section or the environment "FOO" is set to "DIRECTORY". More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_filename (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
 Get a configuration value that should be the name of a file or directory. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
 Get a configuration value that should be in a set of "YES" or "NO". More...
 
int GNUNET_CONFIGURATION_iterate_value_filenames (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, GNUNET_FileNameCallback cb, void *cb_cls)
 Iterate over the set of filenames stored in a configuration value. More...
 
static char * escape_name (const char *value)
 FIXME. More...
 
static enum GNUNET_GenericReturnValue test_match (void *cls, const char *fn)
 FIXME. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_append_value_filename (struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
 Append a filename to a configuration value that represents a list of filenames. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_remove_value_filename (struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
 Remove a filename from a configuration value that represents a list of filenames. More...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_load_from (struct GNUNET_CONFIGURATION_Handle *cfg, const char *defaults_d)
 Load default configuration. More...
 
char * GNUNET_CONFIGURATION_default_filename (void)
 Return the filename of the default configuration filename that is used when no explicit configuration entry point has been specified. More...
 
struct GNUNET_CONFIGURATION_HandleGNUNET_CONFIGURATION_default (void)
 Return GNUnet's default configuration. More...
 
int GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
 Load configuration (starts with defaults, then loads system-specific configuration). More...
 

Detailed Description

configuration management

Author
Christian Grothoff

Definition in file configuration.c.

Macro Definition Documentation

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log_from (kind, "util", __VA_ARGS__)

Definition at line 30 of file configuration.c.

◆ LOG_STRERROR_FILE

#define LOG_STRERROR_FILE (   kind,
  syscall,
  filename 
)     GNUNET_log_from_strerror_file (kind, "util", syscall, filename)

Definition at line 32 of file configuration.c.

Function Documentation

◆ collect_files_cb()

static int collect_files_cb ( void *  cls,
const char *  filename 
)
static

Function called with a filename.

Parameters
clsclosure
filenamecomplete filename (absolute path)
Returns
GNUNET_OK to continue to iterate, GNUNET_NO to stop iteration with no error, GNUNET_SYSERR to abort iteration with error!

Definition at line 378 of file configuration.c.

380 {
381  struct CollectFilesContext *igc = cls;
382 
384  igc->files_length,
386  return GNUNET_OK;
387 }
static char * filename
@ GNUNET_OK
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
#define GNUNET_array_append(arr, len, element)
Append an element to an array (growing the array by one).
Closure to collect_files_cb.
char ** files
Collected files from globbing.
unsigned int files_length
Size of the files array.

References filename, CollectFilesContext::files, CollectFilesContext::files_length, GNUNET_array_append, GNUNET_OK, and GNUNET_strdup.

◆ find_section()

static struct ConfigSection* find_section ( const struct GNUNET_CONFIGURATION_Handle cfg,
const char *  section 
)
static

Find a section entry from a configuration.

Parameters
cfgconfiguration to search in
sectionname of the section to look for
Returns
matching entry, NULL if not found

Definition at line 398 of file configuration.c.

400 {
401  struct ConfigSection *pos;
402 
403  pos = cfg->sections;
404  while ((pos != NULL) && (0 != strcasecmp (section, pos->name)))
405  pos = pos->next;
406  return pos;
407 }
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
configuration section
Definition: configuration.c:71
char * name
name of the section
Definition: configuration.c:85
struct ConfigSection * next
This is a linked list.
Definition: configuration.c:75
struct ConfigSection * sections
Configuration sections.

References cfg, ConfigSection::name, ConfigSection::next, and GNUNET_CONFIGURATION_Handle::sections.

Referenced by find_entry(), and GNUNET_CONFIGURATION_set_value_string().

Here is the caller graph for this function:

◆ pstrcmp()

static int pstrcmp ( const void *  a,
const void *  b 
)
static

Definition at line 411 of file configuration.c.

412 {
413  return strcmp (*((const char **) a), *((const char **) b));
414 }

◆ handle_inline()

enum GNUNET_GenericReturnValue handle_inline ( struct GNUNET_CONFIGURATION_Handle cfg,
const char *  path_or_glob,
bool  path_is_glob,
const char *  restrict_section,
const char *  source_filename,
unsigned int  source_lineno 
)

Handle an inline directive.

Returns
GNUNET_SYSERR on error, GNUNET_OK otherwise

Definition at line 411 of file configuration.c.

429 {
430  char *inline_path = NULL;
431  struct GNUNET_CONFIGURATION_Handle *other_cfg = NULL;
432  struct CollectFilesContext igc = {
433  .files = NULL,
434  .files_length = 0,
435  };
436  enum GNUNET_GenericReturnValue fun_ret;
437  unsigned int old_nest_level = cfg->current_nest_level++;
438 
439  /* We support the section restriction only for non-globs */
440  GNUNET_assert (! (path_is_glob && (NULL != restrict_section)));
441 
442  if (NULL == source_filename)
443  {
445  "Refusing to parse inline configurations, "
446  "not allowed without source filename!\n");
447  fun_ret = GNUNET_SYSERR;
448  goto cleanup;
449  }
450 
451  if ('/' == *path_or_glob)
452  inline_path = GNUNET_strdup (path_or_glob);
453  else
454  {
455  /* We compute the canonical, absolute path first,
456  so that relative imports resolve properly with symlinked
457  config files. */
458  char *source_realpath;
459  char *endsep;
460 
461  source_realpath = realpath (source_filename,
462  NULL);
463  if (NULL == source_realpath)
464  {
465  /* Couldn't even resolve path of base dir. */
466  GNUNET_break (0);
467  /* failed to parse included config */
468  fun_ret = GNUNET_SYSERR;
469  goto cleanup;
470  }
471  endsep = strrchr (source_realpath, '/');
472  GNUNET_assert (NULL != endsep);
473  *endsep = '\0';
474  GNUNET_asprintf (&inline_path,
475  "%s/%s",
476  source_realpath,
477  path_or_glob);
478  free (source_realpath);
479  }
480 
481  if (path_is_glob)
482  {
483  int nret;
484 
486  "processing config glob '%s'\n",
487  inline_path);
488 
489  nret = GNUNET_DISK_glob (inline_path, collect_files_cb, &igc);
490  if (-1 == nret)
491  {
492  fun_ret = GNUNET_SYSERR;
493  goto cleanup;
494  }
495  GNUNET_assert (nret == igc.files_length);
496  qsort (igc.files, igc.files_length, sizeof (char *), pstrcmp);
497  for (int i = 0; i < nret; i++)
498  {
499  if (GNUNET_OK !=
501  igc.files[i]))
502  {
503  fun_ret = GNUNET_SYSERR;
504  goto cleanup;
505  }
506  }
507  fun_ret = GNUNET_OK;
508  }
509  else if (NULL != restrict_section)
510  {
511  enum GNUNET_GenericReturnValue inner_ret;
512  struct ConfigSection *cs;
513  struct ConfigFile *cf = GNUNET_new (struct ConfigFile);
514 
515  inner_ret = GNUNET_DISK_file_test_read (inline_path);
516 
517  cs = find_section (cfg, restrict_section);
518 
519  if (NULL == cs)
520  {
521  cs = GNUNET_new (struct ConfigSection);
522  cs->name = GNUNET_strdup (restrict_section);
523  cs->next = cfg->sections;
524  cfg->sections = cs;
525  cs->entries = NULL;
526  }
527  if (cfg->diagnostics)
528  {
529  char *sfn = GNUNET_STRINGS_filename_expand (inline_path);
530  struct stat istat;
531 
532  cs->hint_secret_filename = sfn;
533  if (0 == stat (sfn, &istat))
534  {
535  struct passwd *pw = getpwuid (istat.st_uid);
536  struct group *gr = getgrgid (istat.st_gid);
537  char *pwname = (NULL == pw) ? "<unknown>" : pw->pw_name;
538  char *grname = (NULL == gr) ? "<unknown>" : gr->gr_name;
539 
541  "%s:%s %o",
542  pwname,
543  grname,
544  istat.st_mode);
545  }
546  else
547  {
548  cs->hint_secret_stat = GNUNET_strdup ("<can't stat file>");
549  }
550  if (source_filename)
551  {
552  /* Possible that this secret section has been inlined before */
554  cs->hint_inlined_from_filename = GNUNET_strdup (source_filename);
555  cs->hint_inlined_from_line = source_lineno;
556  }
557  }
558 
559  /* Put file in the load list for diagnostics, even if we can't access it. */
560  {
562  cf->source_filename = GNUNET_strdup (inline_path);
563  cf->hint_restrict_section = GNUNET_strdup (restrict_section);
566  cf);
567  }
568 
569  if (GNUNET_OK != inner_ret)
570  {
571  cs->inaccessible = true;
572  cf->hint_inaccessible = true;
573  /* File can't be accessed, but that's okay. */
574  fun_ret = GNUNET_OK;
575  goto cleanup;
576  }
577 
578  other_cfg = GNUNET_CONFIGURATION_create ();
579  other_cfg->restrict_section = restrict_section;
580  inner_ret = GNUNET_CONFIGURATION_parse (other_cfg,
581  inline_path);
582  if (GNUNET_OK != inner_ret)
583  {
584  cf->hint_inaccessible = true;
585  fun_ret = inner_ret;
586  goto cleanup;
587  }
588 
589  cs = find_section (other_cfg, restrict_section);
590  if (NULL == cs)
591  {
593  "Configuration file '%s' loaded with @inline-secret@ "
594  "does not contain section '%s'.\n",
595  inline_path,
596  restrict_section);
597  /* Inlined onfiguration is accessible but doesn't contain any values.
598  We treat this as if the inlined section was empty, and do not
599  consider it an error. */
600  fun_ret = GNUNET_OK;
601  goto cleanup;
602  }
603  for (struct ConfigEntry *ce = cs->entries;
604  NULL != ce;
605  ce = ce->next)
607  restrict_section,
608  ce->key,
609  ce->val);
610  fun_ret = GNUNET_OK;
611  }
612  else if (GNUNET_OK !=
614  inline_path))
615  {
616  fun_ret = GNUNET_SYSERR;
617  goto cleanup;
618  }
619  else
620  {
621  fun_ret = GNUNET_OK;
622  }
623 cleanup:
624  cfg->current_nest_level = old_nest_level;
625  if (NULL != other_cfg)
626  GNUNET_CONFIGURATION_destroy (other_cfg);
627  GNUNET_free (inline_path);
628  if (igc.files_length > 0)
629  {
630  for (size_t i = 0; i < igc.files_length; i++)
631  GNUNET_free (igc.files[i]);
632  GNUNET_array_grow (igc.files, igc.files_length, 0);
633  }
634  return fun_ret;
635 }
static int pstrcmp(const void *a, const void *b)
static struct ConfigSection * find_section(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
Find a section entry from a configuration.
#define LOG(kind,...)
Definition: configuration.c:30
static int collect_files_cb(void *cls, const char *filename)
Function called with a filename.
static void cleanup(void *cls)
Function scheduled as very last function, cleans up after us.
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create()
Create a new configuration object.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_parse(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Parse a configuration file, add all of the options in the file to the configuration environment.
int GNUNET_DISK_glob(const char *glob_pattern, GNUNET_FileNameCallback callback, void *callback_cls)
Find all files matching a glob pattern.
Definition: disk.c:1006
enum GNUNET_GenericReturnValue GNUNET_DISK_file_test_read(const char *fil)
Check that fil corresponds to a filename and the file has read permissions.
Definition: disk.c:488
#define GNUNET_CONTAINER_DLL_insert_tail(head, tail, element)
Insert an element at the tail of a DLL.
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_SYSERR
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
@ GNUNET_ERROR_TYPE_DEBUG
@ GNUNET_ERROR_TYPE_INFO
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
#define GNUNET_array_grow(arr, size, tsize)
Grow a well-typed (!) array.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
char * GNUNET_STRINGS_filename_expand(const char *fil)
Complete filename (a la shell) from abbrevition.
Definition: strings.c:494
configuration entry
Definition: configuration.c:39
struct ConfigEntry * next
This is a linked list.
Definition: configuration.c:43
char * hint_restrict_section
Was this configuration file parsed via @inline-secret@?
char * source_filename
Source filename.
bool hint_inaccessible
Was this configuration file inaccessible?
unsigned int level
Level in the tree of loaded config files.
char * hint_inlined_from_filename
For secret sections: Where was this inlined from?
struct ConfigEntry * entries
entries in the section
Definition: configuration.c:80
bool inaccessible
Is the configuration section marked as inaccessible?
Definition: configuration.c:93
char * hint_secret_filename
Diagnostics hint for the secret file.
Definition: configuration.c:98
unsigned int hint_inlined_from_line
For secret sections: Where was this inlined from?
char * hint_secret_stat
Extra information regarding permissions of the secret file.
struct ConfigFile * loaded_files_tail
Linked list of loaded files.
unsigned int current_nest_level
Current nesting level of file loading.
struct ConfigFile * loaded_files_head
Linked list of loaded files.
bool diagnostics
Enable diagnostics.
const char * restrict_section
When parsing into this configuration, and this value is non-NULL, only parse sections of the same nam...

◆ find_entry()

static struct ConfigEntry* find_entry ( const struct GNUNET_CONFIGURATION_Handle cfg,
const char *  section,
const char *  key 
)
static

Find an entry from a configuration.

Parameters
cfghandle to the configuration
sectionsection the option is in
keythe option
Returns
matching entry, NULL if not found

Definition at line 647 of file configuration.c.

650 {
651  struct ConfigSection *sec;
652  struct ConfigEntry *pos;
653 
654  if (NULL == (sec = find_section (cfg, section)))
655  return NULL;
656  if (sec->inaccessible)
657  {
659  "Section '%s' is marked as inaccessible, because the configuration "
660  " file that contains the section can't be read. Attempts to use "
661  "option '%s' will fail.\n",
662  section,
663  key);
664  return NULL;
665  }
666  pos = sec->entries;
667  while ((pos != NULL) && (0 != strcasecmp (key, pos->key)))
668  pos = pos->next;
669  return pos;
670 }
struct GNUNET_HashCode key
The key used in the DHT.
@ GNUNET_ERROR_TYPE_WARNING
char * key
key for this entry
Definition: configuration.c:48

References cfg, ConfigSection::entries, find_section(), GNUNET_ERROR_TYPE_WARNING, ConfigSection::inaccessible, key, ConfigEntry::key, LOG, and ConfigEntry::next.

Referenced by compare_entries(), GNUNET_CONFIGURATION_deserialize(), and GNUNET_CONFIGURATION_set_value_string().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_entry_hint()

static void set_entry_hint ( struct GNUNET_CONFIGURATION_Handle cfg,
const char *  section,
const char *  option,
const char *  hint_filename,
unsigned int  hint_line 
)
static

Set a configuration hint.

Parameters
cfgconfiguration handle
sectionsection
optionconfig option
hint_filename
hint_line

Definition at line 683 of file configuration.c.

688 {
689  struct ConfigEntry *e = find_entry (cfg, section, option);
690  if (! cfg->diagnostics)
691  return;
692  if (! e)
693  return;
694  e->hint_filename = GNUNET_strdup (hint_filename);
695  e->hint_lineno = hint_line;
696 }
static struct ConfigEntry * find_entry(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *key)
Find an entry from a configuration.
static struct Experiment * e
char * hint_filename
Diagnostics information for the filename.
Definition: configuration.c:58

◆ do_skip()

static bool do_skip ( const char *  sec,
const char *  key 
)
static

Should we skip this configuration entry when serializing?

Parameters
secsection name
keykey
Returns
true if we should skip it

Definition at line 1095 of file configuration.c.

1097 {
1098  if (0 != strcasecmp ("PATHS",
1099  sec))
1100  return false;
1101  return ( (0 == strcasecmp ("DATADIR",
1102  key)) ||
1103  (0 == strcasecmp ("LIBDIR",
1104  key)) ||
1105  (0 == strcasecmp ("BINDIR",
1106  key)) ||
1107  (0 == strcasecmp ("PREFIX",
1108  key)) ||
1109  (0 == strcasecmp ("LOCALEDIR",
1110  key)) ||
1111  (0 == strcasecmp ("ICONDIR",
1112  key)) ||
1113  (0 == strcasecmp ("DOCDIR",
1114  key)) ||
1115  (0 == strcasecmp ("DEFAULTCONFIG",
1116  key)) ||
1117  (0 == strcasecmp ("LIBEXECDIR",
1118  key)) );
1119 }

References key.

Referenced by GNUNET_CONFIGURATION_serialize(), and GNUNET_CONFIGURATION_serialize_diagnostics().

Here is the caller graph for this function:

◆ copy_entry()

static void copy_entry ( void *  cls,
const char *  section,
const char *  option,
const char *  value 
)
static

Copy a configuration value to the given target configuration.

Overwrites existing entries.

Parameters
clsthe destination configuration (struct GNUNET_CONFIGURATION_Handle *)
sectionsection for the value
optionoption name of the value
valuevalue to copy

Definition at line 1508 of file configuration.c.

1512 {
1513  struct GNUNET_CONFIGURATION_Handle *dst = cls;
1514 
1515  GNUNET_CONFIGURATION_set_value_string (dst, section, option, value);
1516 }
static char * value
Value of the record to add/remove.

References GNUNET_CONFIGURATION_set_value_string(), and value.

Referenced by GNUNET_CONFIGURATION_dup().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ compare_entries()

static void compare_entries ( void *  cls,
const char *  section,
const char *  option,
const char *  value 
)
static

A callback function, compares entries from two configurations (default against a new configuration) and write the diffs in a diff-configuration object (the callback object).

Parameters
clsthe diff configuration (struct DiffHandle *)
sectionsection for the value (of the default conf.)
optionoption name of the value (of the default conf.)
valuevalue to copy (of the default conf.)

Definition at line 1541 of file configuration.c.

1545 {
1546  struct DiffHandle *dh = cls;
1547  struct ConfigEntry *entNew;
1548 
1549  entNew = find_entry (dh->cfg_default, section, option);
1550  if ((NULL != entNew) && (NULL != entNew->val) &&
1551  (0 == strcmp (entNew->val, value)))
1552  return;
1553  GNUNET_CONFIGURATION_set_value_string (dh->cfgDiff, section, option, value);
1554 }
char * val
current, committed value
Definition: configuration.c:53
Used for diffing a configuration object against the default one.
const struct GNUNET_CONFIGURATION_Handle * cfg_default
struct GNUNET_CONFIGURATION_Handle * cfgDiff

References DiffHandle::cfg_default, DiffHandle::cfgDiff, find_entry(), GNUNET_CONFIGURATION_set_value_string(), ConfigEntry::val, and value.

Referenced by GNUNET_CONFIGURATION_get_diff().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ expand_dollar()

static char* expand_dollar ( const struct GNUNET_CONFIGURATION_Handle cfg,
char *  orig,
unsigned int  depth 
)
static

Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR" where either in the "PATHS" section or the environment "FOO" is set to "DIRECTORY".

We also support default expansion, i.e. ${VARIABLE:-default} will expand to $VARIABLE if VARIABLE is set in PATHS or the environment, and otherwise to "default". Note that "default" itself can also be a $-expression, thus "${VAR1:-{$VAR2}}" will expand to VAR1 and if that is not defined to VAR2.

Parameters
cfgconfiguration to use for path expansion
origstring to $-expand (will be freed!)
depthrecursion depth, used to detect recursive expansions
Returns
$-expanded string, never NULL unless orig was NULL

Definition at line 1844 of file configuration.c.

1847 {
1848  char *prefix;
1849  char *result;
1850  char *start;
1851  const char *post;
1852  const char *env;
1853  char *def;
1854  char *end;
1855  unsigned int lopen;
1856  char erased_char;
1857  char *erased_pos;
1858  size_t len;
1859 
1860  if (NULL == orig)
1861  return NULL;
1862  if (depth > 128)
1863  {
1865  _ (
1866  "Recursive expansion suspected, aborting $-expansion for term `%s'\n"),
1867  orig);
1868  return orig;
1869  }
1870  LOG (GNUNET_ERROR_TYPE_DEBUG, "Asked to $-expand %s\n", orig);
1871  if ('$' != orig[0])
1872  {
1873  LOG (GNUNET_ERROR_TYPE_DEBUG, "Doesn't start with $ - not expanding\n");
1874  return orig;
1875  }
1876  erased_char = 0;
1877  erased_pos = NULL;
1878  if ('{' == orig[1])
1879  {
1880  start = &orig[2];
1881  lopen = 1;
1882  end = &orig[1];
1883  while (lopen > 0)
1884  {
1885  end++;
1886  switch (*end)
1887  {
1888  case '}':
1889  lopen--;
1890  break;
1891 
1892  case '{':
1893  lopen++;
1894  break;
1895 
1896  case '\0':
1898  _ ("Missing closing `%s' in option `%s'\n"),
1899  "}",
1900  orig);
1901  return orig;
1902 
1903  default:
1904  break;
1905  }
1906  }
1907  erased_char = *end;
1908  erased_pos = end;
1909  *end = '\0';
1910  post = end + 1;
1911  def = strchr (orig, ':');
1912  if (NULL != def)
1913  {
1914  *def = '\0';
1915  def++;
1916  if (('-' == *def) || ('=' == *def))
1917  def++;
1918  def = GNUNET_strdup (def);
1919  }
1920  }
1921  else
1922  {
1923  int i;
1924 
1925  start = &orig[1];
1926  def = NULL;
1927  i = 0;
1928  while ((orig[i] != '/') && (orig[i] != '\\') && (orig[i] != '\0') &&
1929  (orig[i] != ' '))
1930  i++;
1931  if (orig[i] == '\0')
1932  {
1933  post = "";
1934  }
1935  else
1936  {
1937  erased_char = orig[i];
1938  erased_pos = &orig[i];
1939  orig[i] = '\0';
1940  post = &orig[i + 1];
1941  }
1942  }
1944  "Split into `%s' and `%s' with default %s\n",
1945  start,
1946  post,
1947  def);
1948  if (GNUNET_OK !=
1950  {
1951  if (NULL == (env = getenv (start)))
1952  {
1953  /* try default */
1954  def = expand_dollar (cfg, def, depth + 1);
1955  env = def;
1956  }
1957  if (NULL == env)
1958  {
1960  if (erased_pos)
1961  *erased_pos = erased_char;
1963  _ (
1964  "Failed to expand `%s' in `%s' as it is neither found in [PATHS] nor defined as an environmental variable\n"),
1965  start,
1966  orig);
1967  GNUNET_free (start);
1968  return orig;
1969  }
1970  prefix = GNUNET_strdup (env);
1971  }
1973  if ((erased_pos) && ('}' != erased_char))
1974  {
1975  len = strlen (prefix) + 1;
1976  prefix = GNUNET_realloc (prefix, len + 1);
1977  prefix[len - 1] = erased_char;
1978  prefix[len] = '\0';
1979  }
1980  result = GNUNET_malloc (strlen (prefix) + strlen (post) + 1);
1981  strcpy (result, prefix);
1982  strcat (result, post);
1983  GNUNET_free (def);
1984  GNUNET_free (prefix);
1985  GNUNET_free (orig);
1986  return result;
1987 }
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
static char * expand_dollar(const struct GNUNET_CONFIGURATION_Handle *cfg, char *orig, unsigned int depth)
Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR" where either in the "PATHS" section or...
char * getenv()
static int start
Set if we are to start default services (including ARM).
Definition: gnunet-arm.c:39
static int end
Set if we are to shutdown all services (including ARM).
Definition: gnunet-arm.c:34
static int prefix
If printing the value of PREFIX has been requested.
Definition: gnunet-config.c:59
uint16_t len
length of data (which is always a uint32_t, but presumably this can be used to specify that fewer byt...
static int result
Global testing status.
char * GNUNET_CONFIGURATION_expand_dollar(const struct GNUNET_CONFIGURATION_Handle *cfg, char *orig)
Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR" where either in the "PATHS" section or...
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be a string.
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_realloc(ptr, size)
Wrapper around realloc.
#define _(String)
GNU gettext support macro.
Definition: platform.h:177

References _, cfg, end, env, getenv(), GNUNET_CONFIGURATION_expand_dollar(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_malloc, GNUNET_OK, GNUNET_realloc, GNUNET_strdup, len, LOG, prefix, result, and start.

Referenced by GNUNET_CONFIGURATION_expand_dollar().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ escape_name()

static char* escape_name ( const char *  value)
static

FIXME.

Parameters
valueFIXME
Returns
FIXME

Definition at line 2135 of file configuration.c.

2136 {
2137  char *escaped;
2138  const char *rpos;
2139  char *wpos;
2140 
2141  escaped = GNUNET_malloc (strlen (value) * 2 + 1);
2142  memset (escaped, 0, strlen (value) * 2 + 1);
2143  rpos = value;
2144  wpos = escaped;
2145  while (rpos[0] != '\0')
2146  {
2147  switch (rpos[0])
2148  {
2149  case '\\':
2150  case ' ':
2151  wpos[0] = '\\';
2152  wpos[1] = rpos[0];
2153  wpos += 2;
2154  break;
2155 
2156  default:
2157  wpos[0] = rpos[0];
2158  wpos++;
2159  }
2160  rpos++;
2161  }
2162  return escaped;
2163 }

◆ test_match()

static enum GNUNET_GenericReturnValue test_match ( void *  cls,
const char *  fn 
)
static

FIXME.

Parameters
clsstring we compare with (const char*)
fnfilename we are currently looking at
Returns
GNUNET_OK if the names do not match, GNUNET_SYSERR if they do

Definition at line 2135 of file configuration.c.

2175 {
2176  const char *of = cls;
2177 
2178  return (0 == strcmp (of, fn)) ? GNUNET_SYSERR : GNUNET_OK;
2179 }