/* This file is part of GNUnet. (C) 2006, 2008, 2009 Christian Grothoff (and other contributing authors) GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNUnet; see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ /** * @file include/gnunet_configuration_lib.h * @brief configuration API * @author Christian Grothoff * @defgroup configuration Configuration management * @{ */ #ifndef GNUNET_CONFIGURATION_LIB_H #define GNUNET_CONFIGURATION_LIB_H #ifdef __cplusplus extern "C" { #if 0 /* keep Emacsens' auto-indent happy */ } #endif #endif #include "gnunet_common.h" #include "gnunet_time_lib.h" /** * A configuration object. */ struct GNUNET_CONFIGURATION_Handle; /** * Create a new configuration object. * @return fresh configuration object */ struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create (void); /** * Duplicate an existing configuration object. * * @param cfg configuration to duplicate * @return duplicate configuration */ struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_dup (const struct GNUNET_CONFIGURATION_Handle *cfg); /** * Destroy configuration object. * * @param cfg configuration to destroy */ void GNUNET_CONFIGURATION_destroy (struct GNUNET_CONFIGURATION_Handle *cfg); /** * Load configuration. This function will first parse the * defaults and then parse the specific configuration file * to overwrite the defaults. * * @param cfg configuration to update * @param filename name of the configuration file, NULL to load defaults * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename); /** * 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); /** * 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); /** * Serializes the given configuration. * * @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 */ char * GNUNET_CONFIGURATION_serialize (const struct GNUNET_CONFIGURATION_Handle *cfg, size_t *size); /** * De-serializes configuration * * @param cfg configuration to update * @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_SYSERR on error */ int GNUNET_CONFIGURATION_deserialize (struct GNUNET_CONFIGURATION_Handle *cfg, const char *mem, const size_t size, int allow_inline); /** * 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); /** * Write only configuration entries that have been changed to configuration file * @param cfgDefault default configuration * @param cfgNew new configuration * @param filename where to write the configuration diff between default and new * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int GNUNET_CONFIGURATION_write_diffs (const struct GNUNET_CONFIGURATION_Handle *cfgDefault, const struct GNUNET_CONFIGURATION_Handle *cfgNew, const char *filename); /** * 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); /** * Test if there are configuration options that were * changed since the last save. * * @param cfg configuration to inspect * @return #GNUNET_NO if clean, #GNUNET_YES if dirty, #GNUNET_SYSERR on error (i.e. last save failed) */ int GNUNET_CONFIGURATION_is_dirty (const struct GNUNET_CONFIGURATION_Handle *cfg); /** * Function to iterate over options. * * @param cls closure * @param section name of the section * @param option name of the option * @param value value of the option */ typedef void (*GNUNET_CONFIGURATION_Iterator) (void *cls, const char *section, const char *option, const char *value); /** * Function to iterate over section. * * @param cls closure * @param section name of the section */ typedef void (*GNUNET_CONFIGURATION_Section_Iterator) (void *cls, const char *section); /** * Iterate over all options in the configuration. * * @param cfg configuration to inspect * @param iter function to call on each option * @param iter_cls closure for iter */ void GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls); /** * Iterate over all sections in the configuration. * * @param cfg configuration to inspect * @param iter function to call on each section * @param iter_cls closure for iter */ void GNUNET_CONFIGURATION_iterate_sections (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CONFIGURATION_Section_Iterator iter, void *iter_cls); /** * Remove the given section and all options in it. * * @param cfg configuration to inspect * @param section name of the section to remove */ void GNUNET_CONFIGURATION_remove_section (struct GNUNET_CONFIGURATION_Handle *cfg, const char *section); /** * Get a configuration value that should be a number. * * @param cfg configuration to inspect * @param section section of interest * @param option option of interest * @param number where to store the numeric value of the option * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int 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 relative time. * * @param cfg configuration to inspect * @param section section of interest * @param option option of interest * @param time set to the time value stored in the configuration * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int 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 size in bytes. * * @param cfg configuration to inspect * @param section section of interest * @param option option of interest * @param size set to the size in bytes as stored in the configuration * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int GNUNET_CONFIGURATION_get_value_size (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *size); /** * Test if we have a value for a particular option * * @param cfg configuration to inspect * @param section section of interest * @param option option of interest * @return #GNUNET_YES if so, #GNUNET_NO if not. */ int GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option); /** * Get a configuration value that should be a string. * * @param cfg configuration to inspect * @param section section of interest * @param option option of interest * @param value will be set to a freshly allocated configuration * value, or NULL if option is not specified * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int 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 the name of a file * or directory. * * @param cfg configuration to inspect * @param section section of interest * @param option option of interest * @param value will be set to a freshly allocated configuration * value, or NULL if option is not specified * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int GNUNET_CONFIGURATION_get_value_filename (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value); /** * Iterate over the set of filenames stored in a configuration value. * * @param cfg configuration to inspect * @param section section of interest * @param option option of interest * @param cb function to call on each filename * @param cb_cls closure for @a cb * @return number of filenames iterated over, -1 on error */ 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 values of a section in the configuration. * * @param cfg configuration to inspect * @param section the section * @param iter function to call on each option * @param iter_cls closure for @a iter */ void GNUNET_CONFIGURATION_iterate_section_values (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls); /** * Get a configuration value that should be in a set of * predefined strings * * @param cfg configuration to inspect * @param section section of interest * @param option option of interest * @param choices NULL-terminated list of legal values * @param value will be set to an entry in the legal list, * or NULL if option is not specified and no default given * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char **choices, const char **value); /** * Get a configuration value that should be in a set of * "YES" or "NO". * * @param cfg configuration to inspect * @param section section of interest * @param option option of interest * @return #GNUNET_YES, #GNUNET_NO or if option has no valid value, #GNUNET_SYSERR */ int GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option); /** * Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR" * where either in the "PATHS" section or the environtment * "FOO" is set to "DIRECTORY". * * @param cfg configuration to use for path expansion * @param orig string to $-expand (will be freed!) * @return $-expanded string */ char * GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cfg, char *orig); /** * Set a configuration value that should be a number. * * @param cfg configuration to update * @param section section of interest * @param option option of interest * @param number value to set */ 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 string. * * @param cfg configuration to update * @param section section of interest * @param option option of interest * @param value value to set */ void GNUNET_CONFIGURATION_set_value_string (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 * * @param cfg configuration to update * @param section section of interest * @param option option of interest * @param value filename to remove * @return #GNUNET_OK on success, * #GNUNET_SYSERR if the filename is not in the list */ int GNUNET_CONFIGURATION_remove_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 * * @param cfg configuration to update * @param section section of interest * @param option option of interest * @param value filename to append * @return #GNUNET_OK on success, * #GNUNET_SYSERR if the filename already in the list */ int GNUNET_CONFIGURATION_append_value_filename (struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value); /** @} */ /* end of group configuration */ #if 0 /* keep Emacsens' auto-indent happy */ { #endif #ifdef __cplusplus } #endif #endif