GNUnet 0.22.0
configuration.c File Reference
#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 enum GNUNET_GenericReturnValue 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)
 
static 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...
 
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
 Load configuration (starts with defaults, then loads system-specific configuration). More...
 

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 enum GNUNET_GenericReturnValue 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.

Referenced by GNUNET_CONFIGURATION_load_from(), and handle_inline().

Here is the caller graph for this function:

◆ 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 if (NULL == cfg)
404 return NULL;
405
406 pos = cfg->sections;
407 while ((pos != NULL) && (0 != strcasecmp (section, pos->name)))
408 pos = pos->next;
409 return pos;
410}
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:108
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(), GNUNET_CONFIGURATION_set_value_string(), and handle_inline().

Here is the caller graph for this function:

◆ pstrcmp()

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

Definition at line 414 of file configuration.c.

416{
417 return strcmp (*((const char **) a),
418 *((const char **) b));
419}

Referenced by GNUNET_CONFIGURATION_load_from(), and handle_inline().

Here is the caller graph for this function:

◆ handle_inline()

static 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 
)
static

Handle an inline directive.

Returns
GNUNET_SYSERR on error, GNUNET_OK otherwise

Definition at line 428 of file configuration.c.

434{
435 char *inline_path = NULL;
436 struct GNUNET_CONFIGURATION_Handle *other_cfg = NULL;
437 struct CollectFilesContext igc = {
438 .files = NULL,
439 .files_length = 0,
440 };
441 enum GNUNET_GenericReturnValue fun_ret;
442 unsigned int old_nest_level = cfg->current_nest_level++;
443
444 /* We support the section restriction only for non-globs */
445 GNUNET_assert (! (path_is_glob && (NULL != restrict_section)));
446
447 if (NULL == source_filename)
448 {
450 "Refusing to parse inline configurations, "
451 "not allowed without source filename!\n");
452 fun_ret = GNUNET_SYSERR;
453 goto cleanup;
454 }
455
456 if ('/' == *path_or_glob)
457 inline_path = GNUNET_strdup (path_or_glob);
458 else
459 {
460 /* We compute the canonical, absolute path first,
461 so that relative imports resolve properly with symlinked
462 config files. */
463 char *source_realpath;
464 char *endsep;
465
466 source_realpath = realpath (source_filename,
467 NULL);
468 if (NULL == source_realpath)
469 {
470 /* Couldn't even resolve path of base dir. */
471 GNUNET_break (0);
472 /* failed to parse included config */
473 fun_ret = GNUNET_SYSERR;
474 goto cleanup;
475 }
476 endsep = strrchr (source_realpath, '/');
477 GNUNET_assert (NULL != endsep);
478 *endsep = '\0';
479 GNUNET_asprintf (&inline_path,
480 "%s/%s",
481 source_realpath,
482 path_or_glob);
483 free (source_realpath);
484 }
485
486 if (path_is_glob)
487 {
488 int nret;
489
491 "processing config glob '%s'\n",
492 inline_path);
493
494 nret = GNUNET_DISK_glob (inline_path, collect_files_cb, &igc);
495 if (-1 == nret)
496 {
497 fun_ret = GNUNET_SYSERR;
498 goto cleanup;
499 }
500 GNUNET_assert (nret == igc.files_length);
501 qsort (igc.files, igc.files_length, sizeof (char *), pstrcmp);
502 for (int i = 0; i < nret; i++)
503 {
504 if (GNUNET_OK !=
506 igc.files[i]))
507 {
508 fun_ret = GNUNET_SYSERR;
509 goto cleanup;
510 }
511 }
512 fun_ret = GNUNET_OK;
513 }
514 else if (NULL != restrict_section)
515 {
516 enum GNUNET_GenericReturnValue inner_ret;
517 struct ConfigSection *cs;
518 struct ConfigFile *cf = GNUNET_new (struct ConfigFile);
519
520 inner_ret = GNUNET_DISK_file_test_read (inline_path);
521
522 cs = find_section (cfg, restrict_section);
523
524 if (NULL == cs)
525 {
526 cs = GNUNET_new (struct ConfigSection);
527 cs->name = GNUNET_strdup (restrict_section);
528 cs->next = cfg->sections;
529 cfg->sections = cs;
530 cs->entries = NULL;
531 }
532 if (cfg->diagnostics)
533 {
534 const char *pwname;
535 const char *grname;
536 char *sfn = GNUNET_STRINGS_filename_expand (inline_path);
537 struct stat istat;
538
539 cs->hint_secret_filename = sfn;
540 if (0 == stat (sfn, &istat))
541 {
542 struct passwd *pw = getpwuid (istat.st_uid);
543 struct group *gr = getgrgid (istat.st_gid);
544 pwname = (NULL == pw) ? "<unknown>" : pw->pw_name;
545 grname = (NULL == gr) ? "<unknown>" : gr->gr_name;
546
548 "%s:%s %o",
549 pwname,
550 grname,
551 istat.st_mode);
552 }
553 else
554 {
555 cs->hint_secret_stat = GNUNET_strdup ("<can't stat file>");
556 }
557 if (source_filename)
558 {
559 /* Possible that this secret section has been inlined before */
561 cs->hint_inlined_from_filename = GNUNET_strdup (source_filename);
562 cs->hint_inlined_from_line = source_lineno;
563 }
564 }
565
566 /* Put file in the load list for diagnostics, even if we can't access it. */
567 {
569 cf->source_filename = GNUNET_strdup (inline_path);
570 cf->hint_restrict_section = GNUNET_strdup (restrict_section);
573 cf);
574 }
575
576 if (GNUNET_OK != inner_ret)
577 {
578 cs->inaccessible = true;
579 cf->hint_inaccessible = true;
580 /* File can't be accessed, but that's okay. */
581 fun_ret = GNUNET_OK;
582 goto cleanup;
583 }
584
585 other_cfg = GNUNET_CONFIGURATION_create ();
586 other_cfg->restrict_section = restrict_section;
587 inner_ret = GNUNET_CONFIGURATION_parse (other_cfg,
588 inline_path);
589 if (GNUNET_OK != inner_ret)
590 {
591 cf->hint_inaccessible = true;
592 fun_ret = inner_ret;
593 goto cleanup;
594 }
595
596 cs = find_section (other_cfg, restrict_section);
597 if (NULL == cs)
598 {
600 "Configuration file '%s' loaded with @inline-secret@ "
601 "does not contain section '%s'.\n",
602 inline_path,
603 restrict_section);
604 /* Inlined onfiguration is accessible but doesn't contain any values.
605 We treat this as if the inlined section was empty, and do not
606 consider it an error. */
607 fun_ret = GNUNET_OK;
608 goto cleanup;
609 }
610 for (struct ConfigEntry *ce = cs->entries;
611 NULL != ce;
612 ce = ce->next)
614 restrict_section,
615 ce->key,
616 ce->val);
617 fun_ret = GNUNET_OK;
618 }
619 else if (GNUNET_OK !=
621 inline_path))
622 {
623 fun_ret = GNUNET_SYSERR;
624 goto cleanup;
625 }
626 else
627 {
628 fun_ret = GNUNET_OK;
629 }
630cleanup:
631 cfg->current_nest_level = old_nest_level;
632 if (NULL != other_cfg)
634 GNUNET_free (inline_path);
635 if (igc.files_length > 0)
636 {
637 for (size_t i = 0; i < igc.files_length; i++)
638 GNUNET_free (igc.files[i]);
640 }
641 return fun_ret;
642}
static struct ConfigSection * find_section(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
Find a section entry from a configuration.
static int pstrcmp(const void *a, const void *b)
static enum GNUNET_GenericReturnValue collect_files_cb(void *cls, const char *filename)
Function called with a filename.
#define LOG(kind,...)
Definition: configuration.c:30
static void cleanup(void *cls)
Disconnect and shutdown.
Definition: gnunet-did.c:130
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.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create()
Create a new 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:1010
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:490
#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:495
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...

References cfg, cleanup(), collect_files_cb(), GNUNET_CONFIGURATION_Handle::current_nest_level, GNUNET_CONFIGURATION_Handle::diagnostics, ConfigSection::entries, CollectFilesContext::files, CollectFilesContext::files_length, find_section(), GNUNET_array_grow, GNUNET_asprintf(), GNUNET_assert, GNUNET_break, GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_parse(), GNUNET_CONFIGURATION_set_value_string(), GNUNET_CONTAINER_DLL_insert_tail, GNUNET_DISK_file_test_read(), GNUNET_DISK_glob(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_new, GNUNET_OK, GNUNET_strdup, GNUNET_STRINGS_filename_expand(), GNUNET_SYSERR, ConfigFile::hint_inaccessible, ConfigSection::hint_inlined_from_filename, ConfigSection::hint_inlined_from_line, ConfigFile::hint_restrict_section, ConfigSection::hint_secret_filename, ConfigSection::hint_secret_stat, ConfigSection::inaccessible, ConfigFile::level, GNUNET_CONFIGURATION_Handle::loaded_files_head, GNUNET_CONFIGURATION_Handle::loaded_files_tail, LOG, ConfigSection::name, ConfigEntry::next, ConfigSection::next, pstrcmp(), GNUNET_CONFIGURATION_Handle::restrict_section, GNUNET_CONFIGURATION_Handle::sections, and ConfigFile::source_filename.

Referenced by GNUNET_CONFIGURATION_deserialize().

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

◆ 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 654 of file configuration.c.

657{
658 struct ConfigSection *sec;
659 struct ConfigEntry *pos;
660
661 if (NULL == (sec = find_section (cfg, section)))
662 return NULL;
663 if (sec->inaccessible)
664 {
666 "Section '%s' is marked as inaccessible, because the configuration "
667 " file that contains the section can't be read. Attempts to use "
668 "option '%s' will fail.\n",
669 section,
670 key);
671 return NULL;
672 }
673 pos = sec->entries;
674 while ((pos != NULL) && (0 != strcasecmp (key, pos->key)))
675 pos = pos->next;
676 return pos;
677}
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_get_value_choice(), GNUNET_CONFIGURATION_get_value_float(), GNUNET_CONFIGURATION_get_value_number(), GNUNET_CONFIGURATION_get_value_size(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONFIGURATION_get_value_time(), GNUNET_CONFIGURATION_have_value(), GNUNET_CONFIGURATION_set_value_string(), and set_entry_hint().

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 690 of file configuration.c.

695{
696 struct ConfigEntry *e = find_entry (cfg, section, option);
697 if (! cfg->diagnostics)
698 return;
699 if (! e)
700 return;
702 e->hint_lineno = hint_line;
703}
static struct ConfigEntry * find_entry(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *key)
Find an entry from a configuration.
char * hint_filename
Diagnostics information for the filename.
Definition: configuration.c:58
unsigned int hint_lineno
Diagnostics information for the line number.
Definition: configuration.c:63

References cfg, GNUNET_CONFIGURATION_Handle::diagnostics, find_entry(), GNUNET_strdup, ConfigEntry::hint_filename, and ConfigEntry::hint_lineno.

Referenced by GNUNET_CONFIGURATION_deserialize().

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

◆ 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 1107 of file configuration.c.

1109{
1110 if (0 != strcasecmp ("PATHS",
1111 sec))
1112 return false;
1113 return ( (0 == strcasecmp ("DATADIR",
1114 key)) ||
1115 (0 == strcasecmp ("LIBDIR",
1116 key)) ||
1117 (0 == strcasecmp ("BINDIR",
1118 key)) ||
1119 (0 == strcasecmp ("PREFIX",
1120 key)) ||
1121 (0 == strcasecmp ("LOCALEDIR",
1122 key)) ||
1123 (0 == strcasecmp ("ICONDIR",
1124 key)) ||
1125 (0 == strcasecmp ("DOCDIR",
1126 key)) ||
1127 (0 == strcasecmp ("DEFAULTCONFIG",
1128 key)) ||
1129 (0 == strcasecmp ("LIBEXECDIR",
1130 key)) );
1131}

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 1522 of file configuration.c.

1526{
1527 struct GNUNET_CONFIGURATION_Handle *dst = cls;
1528
1530 section,
1531 option,
1532 value);
1533}
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 1561 of file configuration.c.

1565{
1566 struct DiffHandle *dh = cls;
1567 struct ConfigEntry *entNew;
1568
1569 entNew = find_entry (dh->cfg_default, section, option);
1570 if ((NULL != entNew) && (NULL != entNew->val) &&
1571 (0 == strcmp (entNew->val, value)))
1572 return;
1574 section,
1575 option,
1576 value);
1577}
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 1904 of file configuration.c.

1907{
1908 char *prefix;
1909 char *result;
1910 char *start;
1911 const char *post;
1912 const char *env;
1913 char *def;
1914 char *end;
1915 unsigned int lopen;
1916 char erased_char;
1917 char *erased_pos;
1918 size_t len;
1919
1920 if (NULL == orig)
1921 return NULL;
1922 if (depth > 128)
1923 {
1925 "Recursive expansion suspected, aborting $-expansion for term `%s'\n",
1926 orig);
1927 return orig;
1928 }
1930 "Asked to $-expand %s\n",
1931 orig);
1932 if ('$' != orig[0])
1933 {
1935 "Doesn't start with $ - not expanding\n");
1936 return orig;
1937 }
1938 erased_char = 0;
1939 erased_pos = NULL;
1940 if ('{' == orig[1])
1941 {
1942 start = &orig[2];
1943 lopen = 1;
1944 end = &orig[1];
1945 while (lopen > 0)
1946 {
1947 end++;
1948 switch (*end)
1949 {
1950 case '}':
1951 lopen--;
1952 break;
1953
1954 case '{':
1955 lopen++;
1956 break;
1957
1958 case '\0':
1960 "Missing closing `}' in option `%s'\n",
1961 orig);
1962 return orig;
1963
1964 default:
1965 break;
1966 }
1967 }
1968 erased_char = *end;
1969 erased_pos = end;
1970 *end = '\0';
1971 post = end + 1;
1972 def = strchr (orig, ':');
1973 if (NULL != def)
1974 {
1975 *def = '\0';
1976 def++;
1977 if (('-' == *def) || ('=' == *def))
1978 def++;
1979 def = GNUNET_strdup (def);
1980 }
1981 }
1982 else
1983 {
1984 int i;
1985
1986 start = &orig[1];
1987 def = NULL;
1988 i = 0;
1989 while ( (orig[i] != '/') &&
1990 (orig[i] != '\\') &&
1991 (orig[i] != '\0') &&
1992 (orig[i] != ' ') )
1993 i++;
1994 if (orig[i] == '\0')
1995 {
1996 post = "";
1997 }
1998 else
1999 {
2000 erased_char = orig[i];
2001 erased_pos = &orig[i];
2002 orig[i] = '\0';
2003 post = &orig[i + 1];
2004 }
2005 }
2007 "Split into `%s' and `%s' with default %s\n",
2008 start,
2009 post,
2010 def);
2011 if (GNUNET_OK !=
2013 "PATHS",
2014 start,
2015 &prefix))
2016 {
2017 if (NULL == (env = getenv (start)))
2018 {
2019 /* try default */
2020 def = expand_dollar (cfg,
2021 def,
2022 depth + 1);
2023 env = def;
2024 }
2025 if (NULL == env)
2026 {
2028 if (erased_pos)
2029 *erased_pos = erased_char;
2031 "Failed to expand `%s' in `%s' as it is neither found in [PATHS] nor defined as an environmental variable\n",
2032 start,
2033 orig);
2035 return orig;
2036 }
2038 }
2040 prefix);
2041 if ((erased_pos) && ('}' != erased_char))
2042 {
2043 len = strlen (prefix) + 1;
2044 prefix = GNUNET_realloc (prefix, len + 1);
2045 prefix[len - 1] = erased_char;
2046 prefix[len] = '\0';
2047 }
2048 result = GNUNET_malloc (strlen (prefix) + strlen (post) + 1);
2049 strcpy (result, prefix);
2050 strcat (result, post);
2051 GNUNET_free (def);
2053 GNUNET_free (orig);
2054 return result;
2055}
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:38
static int end
Set if we are to shutdown all services (including ARM).
Definition: gnunet-arm.c:33
static int prefix
If printing the value of PREFIX has been requested.
Definition: gnunet-config.c:66
static int result
Global testing status.
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.
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...
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_realloc(ptr, size)
Wrapper around realloc.

References cfg, end, env, expand_dollar(), 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, LOG, prefix, result, and start.

Referenced by expand_dollar(), and 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 2222 of file configuration.c.

2223{
2224 char *escaped;
2225 const char *rpos;
2226 char *wpos;
2227
2228 escaped = GNUNET_malloc (strlen (value) * 2 + 1);
2229 memset (escaped, 0, strlen (value) * 2 + 1);
2230 rpos = value;
2231 wpos = escaped;
2232 while (rpos[0] != '\0')
2233 {
2234 switch (rpos[0])
2235 {
2236 case '\\':
2237 case ' ':
2238 wpos[0] = '\\';
2239 wpos[1] = rpos[0];
2240 wpos += 2;
2241 break;
2242
2243 default:
2244 wpos[0] = rpos[0];
2245 wpos++;
2246 }
2247 rpos++;
2248 }
2249 return escaped;
2250}

References GNUNET_malloc, and value.

Referenced by GNUNET_CONFIGURATION_append_value_filename(), and GNUNET_CONFIGURATION_remove_value_filename().

Here is the caller graph for this function:

◆ 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 2261 of file configuration.c.

2262{
2263 const char *of = cls;
2264
2265 return (0 == strcmp (of, fn))
2267 : GNUNET_OK;
2268}

References GNUNET_OK, and GNUNET_SYSERR.

Referenced by GNUNET_CONFIGURATION_append_value_filename().

Here is the caller graph for this function: