GNUnet 0.21.2
Functions | Variables
gnunet-config.c File Reference

tool to access and manipulate GNUnet configuration files More...

#include "platform.h"
#include "gnunet_util_lib.h"
Include dependency graph for gnunet-config.c:

Go to the source code of this file.

Functions

int main (int argc, char *const *argv)
 Program to manipulate configuration files. More...
 

Variables

static char * backend_check
 Backend to check if the respective plugin is loadable. More...
 
static int cflags
 If printing the value of CFLAGS has been requested. More...
 
static int is_experimental
 Check if this is an experimental build. More...
 
static int no_defaults
 Do not load default configuration. More...
 
static char * ram_config
 Parse configuration from this memory. More...
 
static int libs
 If printing the value of LIBS has been requested. More...
 
static int prefix
 If printing the value of PREFIX has been requested. More...
 

Detailed Description

tool to access and manipulate GNUnet configuration files

Author
Christian Grothoff

Definition in file gnunet-config.c.

Function Documentation

◆ main()

int main ( int  argc,
char *const *  argv 
)

Program to manipulate configuration files.

Parameters
argcnumber of arguments from the command line
argvcommand line arguments
Returns
0 ok, 1 on error

Definition at line 77 of file gnunet-config.c.

79{
80 struct GNUNET_CONFIGURATION_ConfigSettings cs = {
81 .api_version = GNUNET_UTIL_VERSION,
82 .global_ret = EXIT_SUCCESS
83 };
84 const struct GNUNET_OS_ProjectData *pd
85 = GNUNET_OS_project_data_get ();
86 char *cfgfile = NULL;
87 char *loglev = NULL;
88 char *logfile = NULL;
89 struct GNUNET_GETOPT_CommandLineOption options[] = {
90 GNUNET_GETOPT_option_cfgfile (&cfgfile),
91 GNUNET_GETOPT_option_help ("gnunet-config [OPTIONS]"),
92 GNUNET_GETOPT_option_loglevel (&loglev),
93 GNUNET_GETOPT_option_logfile (&logfile),
94 GNUNET_GETOPT_option_version (pd->version),
95 GNUNET_GETOPT_option_exclusive (
96 GNUNET_GETOPT_option_string (
97 'b',
98 "supported-backend",
99 "BACKEND",
100 gettext_noop (
101 "test if the current installation supports the specified BACKEND"),
102 &backend_check)),
103 GNUNET_GETOPT_option_flag (
104 'C',
105 "cflags",
106 gettext_noop (
107 "Provide an appropriate value for CFLAGS to applications building on top of GNUnet"),
108 &cflags),
109 GNUNET_GETOPT_option_flag (
110 'E',
111 "is-experimental",
112 gettext_noop ("Is this an experimental build of GNUnet"),
113 &is_experimental),
114 GNUNET_GETOPT_option_flag (
115 'j',
116 "libs",
117 gettext_noop (
118 "Provide an appropriate value for LIBS to applications building on top of GNUnet"),
119 &libs),
120 GNUNET_GETOPT_option_flag (
121 'n',
122 "no-defaults",
123 gettext_noop ("Do not parse default configuration files"),
124 &no_defaults),
125 GNUNET_GETOPT_option_flag (
126 'p',
127 "prefix",
128 gettext_noop (
129 "Provide the path under which GNUnet was installed"),
130 &prefix),
131 GNUNET_GETOPT_option_string (
132 'R',
133 "ram-config",
134 "CONFIG_DATA",
135 gettext_noop (
136 "Parse main configuration from this command-line argument and not from disk"),
137 &ram_config),
138 GNUNET_CONFIGURATION_CONFIG_OPTIONS (&cs),
139 GNUNET_GETOPT_OPTION_END
140 };
141 int iret;
142
143 if (GNUNET_OK !=
144 GNUNET_STRINGS_get_utf8_args (argc, argv,
145 &argc, &argv))
146 return EXIT_FAILURE;
147 if ( (NULL != pd->config_file) &&
148 (NULL != pd->user_config_file) )
149 cfgfile = GNUNET_CONFIGURATION_default_filename ();
150 iret = GNUNET_GETOPT_run ("gnunet-config",
151 options,
152 argc,
153 argv);
154 if (GNUNET_SYSERR == iret)
155 {
156 GNUNET_free_nz ((void *) argv);
157 GNUNET_free (cfgfile);
158 GNUNET_free (loglev);
159 GNUNET_free (logfile);
160 return EXIT_INVALIDARGUMENT;
161 }
162 if (GNUNET_OK !=
163 GNUNET_log_setup ("gnunet-config",
164 loglev,
165 logfile))
166 {
167 GNUNET_free_nz ((void *) argv);
168 GNUNET_free (cfgfile);
169 GNUNET_free (loglev);
170 GNUNET_free (logfile);
171 return EXIT_FAILURE;
172 }
173 GNUNET_free (loglev);
174 GNUNET_free (logfile);
175 if (1 == is_experimental)
176 {
177 GNUNET_free_nz ((void *) argv);
178 GNUNET_free (cfgfile);
179#ifdef GNUNET_EXPERIMENTAL
180 return 0;
181#else
182 return 1;
183#endif
184 }
185 if (1 == cflags || 1 == libs || 1 == prefix)
186 {
187 char *prefixdir = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_PREFIX);
188 char *libdir = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LIBDIR);
189
190 if (1 == cflags)
191 {
192 fprintf (stdout, "-I%sinclude\n", prefixdir);
193 }
194 if (1 == libs)
195 {
196 fprintf (stdout, "-L%s -lgnunetutil\n", libdir);
197 }
198 if (1 == prefix)
199 {
200 fprintf (stdout, "%s\n", prefixdir);
201 }
202 GNUNET_free (prefixdir);
203 GNUNET_free (libdir);
204 GNUNET_free (cfgfile);
205 GNUNET_free_nz ((void *) argv);
206 return 0;
207 }
208 if (NULL != backend_check)
209 {
210 char *name;
211
212 GNUNET_asprintf (&name,
213 "libgnunet_plugin_%s",
214 backend_check);
215 iret = (GNUNET_OK ==
216 GNUNET_PLUGIN_test (name)) ? 0 : 77;
217 GNUNET_free (name);
218 GNUNET_free (cfgfile);
219 GNUNET_free_nz ((void *) argv);
220 return iret;
221 }
222
223 {
224 struct GNUNET_CONFIGURATION_Handle *cfg;
225
226 cfg = GNUNET_CONFIGURATION_create ();
227
228 if (NULL != ram_config)
229 {
230 if ( (! no_defaults) &&
231 (GNUNET_SYSERR ==
232 GNUNET_CONFIGURATION_load (cfg,
233 NULL)) )
234 {
235 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
236 _ ("Failed to load default configuration, exiting ...\n"));
237 GNUNET_free_nz ((void *) argv);
238 GNUNET_CONFIGURATION_destroy (cfg);
239 GNUNET_free (cfgfile);
240 return EXIT_FAILURE;
241 }
242 if (GNUNET_OK !=
243 GNUNET_CONFIGURATION_deserialize (cfg,
244 ram_config,
245 strlen (ram_config),
246 NULL))
247 {
248 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
249 _ ("Failed to parse configuration, exiting ...\n"));
250 GNUNET_free_nz ((void *) argv);
251 GNUNET_CONFIGURATION_destroy (cfg);
252 GNUNET_free (cfgfile);
253 return EXIT_FAILURE;
254 }
255 }
256 else
257 {
258 if (GNUNET_YES !=
259 GNUNET_DISK_file_test (cfgfile))
260 {
261 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
262 _ ("Unreadable configuration file `%s', exiting ...\n"),
263 cfgfile);
264 GNUNET_free_nz ((void *) argv);
265 GNUNET_CONFIGURATION_destroy (cfg);
266 GNUNET_free (cfgfile);
267 return EXIT_FAILURE;
268 }
269 if (GNUNET_SYSERR ==
270 (no_defaults
271 ? GNUNET_CONFIGURATION_parse (cfg,
272 cfgfile)
273 : GNUNET_CONFIGURATION_load (cfg,
274 cfgfile)) )
275 {
276 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
277 _ ("Malformed configuration file `%s', exiting ...\n"),
278 cfgfile);
279 GNUNET_free_nz ((void *) argv);
280 GNUNET_CONFIGURATION_destroy (cfg);
281 GNUNET_free (cfgfile);
282 return EXIT_FAILURE;
283 }
284 }
285 GNUNET_CONFIGURATION_config_tool_run (&cs,
286 &argv[iret],
287 cfgfile,
288 cfg);
289 GNUNET_free_nz ((void *) argv);
290 GNUNET_CONFIGURATION_config_settings_free (&cs);
291 GNUNET_CONFIGURATION_destroy (cfg);
292 }
293 GNUNET_free (cfgfile);
294 return cs.global_ret;
295}
GNUNET_GETOPT_OPTION_END
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
options
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
gettext_noop
#define gettext_noop(String)
Definition: gettext.h:74
cfg
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:109
ram_config
static char * ram_config
Parse configuration from this memory.
Definition: gnunet-config.c:56
no_defaults
static int no_defaults
Do not load default configuration.
Definition: gnunet-config.c:51
libs
static int libs
If printing the value of LIBS has been requested.
Definition: gnunet-config.c:61
backend_check
static char * backend_check
Backend to check if the respective plugin is loadable.
Definition: gnunet-config.c:36
cflags
static int cflags
If printing the value of CFLAGS has been requested.
Definition: gnunet-config.c:41
is_experimental
static int is_experimental
Check if this is an experimental build.
Definition: gnunet-config.c:46
prefix
static int prefix
If printing the value of PREFIX has been requested.
Definition: gnunet-config.c:66
name
static char * name
Name (label) of the records to list.
Definition: gnunet-namecache.c:48
GNUNET_CONFIGURATION_CONFIG_OPTIONS
#define GNUNET_CONFIGURATION_CONFIG_OPTIONS(cs)
Macro that expands to a set of GNUNET-getopt directives to initialize a struct GNUNET_CONFIGURATION_C...
Definition: gnunet_configuration_lib.h:728
GNUNET_CONFIGURATION_destroy
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
Definition: configuration.c:307
GNUNET_CONFIGURATION_config_settings_free
void GNUNET_CONFIGURATION_config_settings_free(struct GNUNET_CONFIGURATION_ConfigSettings *cs)
Free resources associated with cs.
Definition: configuration_helper.c:294
GNUNET_CONFIGURATION_config_tool_run
void GNUNET_CONFIGURATION_config_tool_run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
Main task to run to perform operations typical for gnunet-config as per the configuration settings gi...
Definition: configuration_helper.c:108
GNUNET_CONFIGURATION_deserialize
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_deserialize(struct GNUNET_CONFIGURATION_Handle *cfg, const char *mem, size_t size, const char *source_filename)
De-serializes configuration.
Definition: configuration.c:703
GNUNET_CONFIGURATION_default_filename
char * GNUNET_CONFIGURATION_default_filename(void)
Return the filename of the default configuration filename that is used when no explicit configuration...
Definition: configuration.c:2381
GNUNET_CONFIGURATION_create
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
Definition: configuration.c:222
GNUNET_CONFIGURATION_load
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Load configuration.
Definition: configuration.c:2498
GNUNET_CONFIGURATION_parse
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.
Definition: configuration.c:970
GNUNET_DISK_file_test
enum GNUNET_GenericReturnValue GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory).
Definition: disk.c:482
GNUNET_GETOPT_option_cfgfile
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_cfgfile(char **fn)
Allow user to specify configuration file name (-c option)
Definition: getopt_helpers.c:457
GNUNET_GETOPT_option_logfile
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_logfile(char **logfn)
Allow user to specify log file name (-l option)
Definition: getopt_helpers.c:439
GNUNET_GETOPT_run
int GNUNET_GETOPT_run(const char *binaryOptions, const struct GNUNET_GETOPT_CommandLineOption *allOptions, unsigned int argc, char *const *argv)
Parse the command line.
Definition: getopt.c:884
GNUNET_GETOPT_option_exclusive
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_exclusive(struct GNUNET_GETOPT_CommandLineOption opt)
Make the given option mutually exclusive with other options.
Definition: getopt_helpers.c:1010
GNUNET_GETOPT_option_help
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_help(const char *about)
Defining the option to print the command line help text (-h option).
Definition: getopt_helpers.c:192
GNUNET_GETOPT_option_loglevel
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_loglevel(char **level)
Define the '-L' log level option.
Definition: getopt_helpers.c:373
GNUNET_GETOPT_option_flag
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_flag(char shortName, const char *name, const char *description, int *val)
Allow user to specify a flag (which internally means setting an integer to 1/GNUNET_YES/GNUNET_OK.
Definition: getopt_helpers.c:303
GNUNET_GETOPT_option_string
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_string(char shortName, const char *name, const char *argumentHelp, const char *description, char **str)
Allow user to specify a string.
Definition: getopt_helpers.c:352
GNUNET_GETOPT_option_version
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_version(const char *version)
Define the option to print the version of the application (-v option)
Definition: getopt_helpers.c:58
GNUNET_log
#define GNUNET_log(kind,...)
Definition: gnunet_common.h:569
GNUNET_UTIL_VERSION
#define GNUNET_UTIL_VERSION
Version of the API (for entire gnunetutil.so library).
Definition: gnunet_common.h:96
GNUNET_OK
@ GNUNET_OK
Definition: gnunet_common.h:109
GNUNET_YES
@ GNUNET_YES
Definition: gnunet_common.h:111
GNUNET_SYSERR
@ GNUNET_SYSERR
Definition: gnunet_common.h:107
GNUNET_log_setup
enum GNUNET_GenericReturnValue GNUNET_log_setup(const char *comp, const char *loglevel, const char *logfile)
Setup logging.
Definition: common_logging.c:729
GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_ERROR
Definition: gnunet_common.h:435
GNUNET_asprintf
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
GNUNET_free
#define GNUNET_free(ptr)
Wrapper around free.
Definition: gnunet_common.h:1458
GNUNET_free_nz
#define GNUNET_free_nz(ptr)
Wrapper around free.
Definition: gnunet_common.h:1444
GNUNET_OS_installation_get_path
char * GNUNET_OS_installation_get_path(enum GNUNET_OS_InstallationPathKind dirkind)
Get the path to a specific GNUnet installation directory or, with GNUNET_OS_IPK_SELF_PREFIX,...
Definition: os_installation.c:451
GNUNET_OS_project_data_get
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_get(void)
Definition: os_installation.c:105
GNUNET_OS_IPK_LIBDIR
@ GNUNET_OS_IPK_LIBDIR
Return the directory where libraries are installed.
Definition: gnunet_os_lib.h:140
GNUNET_OS_IPK_PREFIX
@ GNUNET_OS_IPK_PREFIX
Return the "PREFIX" directory given to configure.
Definition: gnunet_os_lib.h:130
GNUNET_PLUGIN_test
enum GNUNET_GenericReturnValue GNUNET_PLUGIN_test(const char *library_name)
Test if a plugin exists.
Definition: plugin.c:168
GNUNET_STRINGS_get_utf8_args
enum GNUNET_GenericReturnValue GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1230
_
#define _(String)
GNU gettext support macro.
Definition: platform.h:178
EXIT_INVALIDARGUMENT
#define EXIT_INVALIDARGUMENT
Definition: platform.h:253
GNUNET_CONFIGURATION_ConfigSettings
Closure for GNUNET_CONFIGURATION_config_tool_run() with settings for what should be done with the con...
Definition: gnunet_configuration_lib.h:664
GNUNET_CONFIGURATION_ConfigSettings::global_ret
int global_ret
Return value from the operation, to be returned from 'main'.
Definition: gnunet_configuration_lib.h:716
GNUNET_CONFIGURATION_ConfigSettings::api_version
unsigned int api_version
Must be set to the API version, i.e.
Definition: gnunet_configuration_lib.h:670
GNUNET_CONFIGURATION_Handle
configuration data
Definition: configuration.c:149
GNUNET_GETOPT_CommandLineOption
Definition of a command line option.
Definition: gnunet_getopt_lib.h:110
GNUNET_OS_ProjectData
Project-specific data used to help the OS subsystem find installation paths.
Definition: gnunet_os_lib.h:215
GNUNET_OS_ProjectData::user_config_file
const char * user_config_file
Configuration file name to use (if $XDG_CONFIG_HOME is not set).
Definition: gnunet_os_lib.h:276
GNUNET_OS_ProjectData::config_file
const char * config_file
Configuration file name (in $XDG_CONFIG_HOME) to use.
Definition: gnunet_os_lib.h:271
GNUNET_OS_ProjectData::version
const char * version
String identifying the current project version.
Definition: gnunet_os_lib.h:281

References _, GNUNET_CONFIGURATION_ConfigSettings::api_version, backend_check, cfg, cflags, GNUNET_OS_ProjectData::config_file, EXIT_INVALIDARGUMENT, gettext_noop, GNUNET_CONFIGURATION_ConfigSettings::global_ret, GNUNET_asprintf(), GNUNET_CONFIGURATION_CONFIG_OPTIONS, GNUNET_CONFIGURATION_config_settings_free(), GNUNET_CONFIGURATION_config_tool_run(), GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_default_filename(), GNUNET_CONFIGURATION_deserialize(), GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_load(), GNUNET_CONFIGURATION_parse(), GNUNET_DISK_file_test(), GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_free_nz, GNUNET_GETOPT_option_cfgfile(), GNUNET_GETOPT_OPTION_END, GNUNET_GETOPT_option_exclusive(), GNUNET_GETOPT_option_flag(), GNUNET_GETOPT_option_help(), GNUNET_GETOPT_option_logfile(), GNUNET_GETOPT_option_loglevel(), GNUNET_GETOPT_option_string(), GNUNET_GETOPT_option_version(), GNUNET_GETOPT_run(), GNUNET_log, GNUNET_log_setup(), GNUNET_OK, GNUNET_OS_installation_get_path(), GNUNET_OS_IPK_LIBDIR, GNUNET_OS_IPK_PREFIX, GNUNET_OS_project_data_get(), GNUNET_PLUGIN_test(), GNUNET_STRINGS_get_utf8_args(), GNUNET_SYSERR, GNUNET_UTIL_VERSION, GNUNET_YES, is_experimental, libs, name, no_defaults, options, prefix, ram_config, GNUNET_OS_ProjectData::user_config_file, and GNUNET_OS_ProjectData::version.

Here is the call graph for this function:

Variable Documentation

◆ backend_check

char* backend_check
static

Backend to check if the respective plugin is loadable.

NULL if no check is to be performed. The value is the "basename" of the plugin to load.

Definition at line 36 of file gnunet-config.c.

Referenced by main().

◆ cflags

int cflags
static

If printing the value of CFLAGS has been requested.

Definition at line 41 of file gnunet-config.c.

Referenced by main().

◆ is_experimental

int is_experimental
static

Check if this is an experimental build.

Definition at line 46 of file gnunet-config.c.

Referenced by main().

◆ no_defaults

int no_defaults
static

Do not load default configuration.

Definition at line 51 of file gnunet-config.c.

Referenced by main().

◆ ram_config

char* ram_config
static

Parse configuration from this memory.

Definition at line 56 of file gnunet-config.c.

Referenced by main().

◆ libs

int libs
static

If printing the value of LIBS has been requested.

Definition at line 61 of file gnunet-config.c.

Referenced by main().

◆ prefix

int prefix
static

If printing the value of PREFIX has been requested.

Definition at line 66 of file gnunet-config.c.

Referenced by connect_peers_run(), create_keys(), expand_dollar(), get_connect_value(), gns_string_to_value(), gns_value_to_string(), GNUNET_TESTING_get_address(), GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue(), handle_gns_resolution_result(), handle_intermediate_result(), iterate_address_and_compare_cb(), lookup_communicator(), main(), start_peer_run(), stat_cmd(), store_pi(), store_prefix_file_name(), and suggest_to_connect().