ftpconf.c
/*
* Parses and prints the configuration options for a fictous ftp client
*/
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <locale.h>
#include <confuse.h>
/* valid values for the auto-create-bookmark option */
#define ACB_YES 1
#define ACB_NO 2
#define ACB_ASK 3
/* called on alias() functions in the config file */
int conf_alias(cfg_t *cfg, cfg_opt_t *opt, int argc, const char **argv)
{
if (argc < 2) {
cfg_error(cfg, "function '%s' requires 2 arguments", cfg_opt_name(opt));
return -1;
}
printf("got alias '%s' = '%s'\n", argv[0], argv[1]);
return 0;
}
/* parse values for the auto-create-bookmark option */
int conf_parse_acb(cfg_t *cfg, cfg_opt_t *opt, const char *value, void *result)
{
if (strcmp(value, "yes") == 0)
*(int *)result = ACB_YES;
else if (strcmp(value, "no") == 0)
*(int *)result = ACB_NO;
else if (strcmp(value, "ask") == 0)
*(int *)result = ACB_ASK;
else {
cfg_error(cfg, "invalid value for option '%s': %s", cfg_opt_name(opt), value);
return -1;
}
return 0;
}
/* validates a port option (must be positive) */
int conf_validate_port(cfg_t *cfg, cfg_opt_t *opt)
{
int value = cfg_opt_getnint(opt, 0);
if (value <= 0) {
cfg_error(cfg, "invalid port %d in section '%s'", value, cfg_name(cfg));
return -1;
}
return 0;
}
/* validates a bookmark section (host option required) */
int conf_validate_bookmark(cfg_t *cfg, cfg_opt_t *opt)
{
cfg_t *bookmark = cfg_opt_getnsec(opt, cfg_opt_size(opt) - 1);
if (cfg_size(bookmark, "host") == 0) {
cfg_error(cfg, "missing required option 'host' in bookmark");
return -1;
}
return 0;
}
cfg_t *parse_conf(const char *filename)
{
static cfg_opt_t bookmark_opts[] = {
CFG_STR("host", 0, CFGF_NODEFAULT),
CFG_INT("port", 21, CFGF_NONE),
CFG_STR("login", "anonymous", CFGF_NONE),
CFG_STR("password", "anonymous@", CFGF_NONE),
CFG_STR("directory", 0, CFGF_NONE),
CFG_END()
};
cfg_opt_t opts[] = {
CFG_SEC("bookmark", bookmark_opts, CFGF_MULTI | CFGF_TITLE),
CFG_BOOL("passive-mode", cfg_false, CFGF_NONE),
CFG_BOOL("remote-completion", cfg_true, CFGF_NONE),
CFG_FUNC("alias", conf_alias),
CFG_STR_LIST("xterm-terminals", "{xterm, rxvt}", CFGF_NONE),
CFG_INT_CB("auto-create-bookmark", ACB_YES, CFGF_NONE, conf_parse_acb),
CFG_FUNC("include-file", cfg_include),
CFG_END()
};
cfg_t *cfg = cfg_init(opts, CFGF_NONE);
cfg_set_validate_func(cfg, "bookmark|port", conf_validate_port);
cfg_set_validate_func(cfg, "bookmark", conf_validate_bookmark);
switch (cfg_parse(cfg, filename)) {
case CFG_FILE_ERROR:
printf("warning: configuration file '%s' could not be read: %s\n", filename, strerror(errno));
printf("continuing with default values...\n\n");
case CFG_SUCCESS:
break;
case CFG_PARSE_ERROR:
return 0;
}
return cfg;
}
/* Parse the file ftp.conf and print the parsed configuration options */
int main(int argc, char **argv)
{
cfg_t *cfg;
/* Localize messages & types according to environment, since v2.9 */
#ifdef LC_MESSAGES
setlocale(LC_MESSAGES, "");
setlocale(LC_CTYPE, "");
#endif
cfg = parse_conf(argc > 1 ? argv[1] : "ftp.conf");
if (cfg) {
unsigned int i;
printf("passive-mode = %s\n", cfg_getbool(cfg, "passive-mode") ? "true" : "false");
printf("remote-completion = %s\n", cfg_getbool(cfg, "remote-completion") ? "true" : "false");
printf("number of bookmarks: %d\n", cfg_size(cfg, "bookmark"));
for (i = 0; i < cfg_size(cfg, "bookmark"); i++) {
cfg_t *bookmark = cfg_getnsec(cfg, "bookmark", i);
printf(" bookmark #%d: %s:%s@%s:%ld%s\n", i + 1,
cfg_getstr(bookmark, "login"),
cfg_getstr(bookmark, "password"),
cfg_getstr(bookmark, "host"), cfg_getint(bookmark, "port"), cfg_getstr(bookmark, "directory"));
}
for (i = 0; i < cfg_size(cfg, "xterm-terminals"); i++) {
printf("xterm-terminal #%d: %s\n", i + 1, cfg_getnstr(cfg, "xterm-terminals", i));
}
printf("auto-create-bookmark = %ld\n", cfg_getint(cfg, "auto-create-bookmark"));
cfg_free(cfg);
}
return 0;
}
confuse.h
A configuration file parser library.
CFG_SEC
#define CFG_SEC(name, opts, flags)
Initialize a section.
Definition: confuse.h:527
cfg_parse
DLLIMPORT int __export cfg_parse(cfg_t *cfg, const char *filename)
Parse a configuration file.
Definition: confuse.c:1746
cfg_opt_size
DLLIMPORT unsigned int __export cfg_opt_size(cfg_opt_t *opt)
Return the number of values this option has.
Definition: confuse.c:399
cfg_opt_getnsec
DLLIMPORT cfg_t *__export cfg_opt_getnsec(cfg_opt_t *opt, unsigned int index)
Returns the value of a section option, given a cfg_opt_t pointer.
Definition: confuse.c:549
cfg_getstr
DLLIMPORT char *__export cfg_getstr(cfg_t *cfg, const char *name)
Returns the value of a string option.
Definition: confuse.c:519
CFG_BOOL
#define CFG_BOOL(name, def, flags)
Initialize a boolean option.
Definition: confuse.h:490
cfg_error
DLLIMPORT void __export cfg_error(cfg_t *cfg, const char *fmt,...)
Show a parser error.
Definition: confuse.c:1211
CFGF_TITLE
#define CFGF_TITLE
option has a title (only applies to sections)
Definition: confuse.h:90
CFGF_NONE
#define CFGF_NONE
Flags.
Definition: confuse.h:86
CFG_SUCCESS
#define CFG_SUCCESS
Return codes from cfg_parse(), cfg_parse_boolean(), and cfg_set*() functions.
Definition: confuse.h:105
CFG_END
#define CFG_END()
Terminate list of options.
Definition: confuse.h:574
cfg_opt_name
DLLIMPORT const char *__export cfg_opt_name(cfg_opt_t *opt)
Return the name of an option.
Definition: confuse.c:387
CFG_INT_CB
#define CFG_INT_CB(name, def, flags, cb)
Initialize an integer option with a value parsing callback.
Definition: confuse.h:431
cfg_include
DLLIMPORT int __export cfg_include(cfg_t *cfg, cfg_opt_t *opt, int argc, const char **argv)
Predefined include-function.
Definition: confuse.c:1997
CFGF_MULTI
#define CFGF_MULTI
option may be specified multiple times (only applies to sections)
Definition: confuse.h:87
cfg_set_validate_func
DLLIMPORT cfg_validate_callback_t __export cfg_set_validate_func(cfg_t *cfg, const char *name, cfg_validate_callback_t vf)
Register a validating callback function for an option.
Definition: confuse.c:2637
CFGF_NODEFAULT
#define CFGF_NODEFAULT
option has no default value
Definition: confuse.h:91
CFG_STR
#define CFG_STR(name, def, flags)
Initialize a string option.
Definition: confuse.h:340
cfg_getint
DLLIMPORT long int __export cfg_getint(cfg_t *cfg, const char *name)
Returns the value of an integer option.
Definition: confuse.c:444
cfg_getnstr
DLLIMPORT char *__export cfg_getnstr(cfg_t *cfg, const char *name, unsigned int index)
Indexed version of cfg_getstr(), used for lists.
Definition: confuse.c:514
cfg_free
DLLIMPORT int __export cfg_free(cfg_t *cfg)
Free a cfg_t context.
Definition: confuse.c:1962
cfg_name
DLLIMPORT const char *__export cfg_name(cfg_t *cfg)
Return the name of a section.
Definition: confuse.c:380
CFG_FUNC
#define CFG_FUNC(name, func)
Initialize a function.
Definition: confuse.h:538
cfg_getbool
DLLIMPORT cfg_bool_t __export cfg_getbool(cfg_t *cfg, const char *name)
Returns the value of a boolean option.
Definition: confuse.c:494
cfg_opt_getnint
DLLIMPORT signed long __export cfg_opt_getnint(cfg_opt_t *opt, unsigned int index)
Returns the value of an integer option, given a cfg_opt_t pointer.
Definition: confuse.c:424
CFG_INT
#define CFG_INT(name, def, flags)
Initialize an integer option.
Definition: confuse.h:421
cfg_size
DLLIMPORT unsigned int __export cfg_size(cfg_t *cfg, const char *name)
Return the number of values this option has.
Definition: confuse.c:406
cfg_getnsec
DLLIMPORT cfg_t *__export cfg_getnsec(cfg_t *cfg, const char *name, unsigned int index)
Indexed version of cfg_getsec(), used for sections with the CFGF_MULTI flag set.
Definition: confuse.c:563
CFG_STR_LIST
#define CFG_STR_LIST(name, def, flags)
Initialize a string list option.
Definition: confuse.h:345
cfg_init
DLLIMPORT cfg_t *__export cfg_init(cfg_opt_t *opts, cfg_flag_t flags)
Create and initialize a cfg_t structure.
Definition: confuse.c:1816
cfg_opt_t
Data structure holding information about an option.
Definition: confuse.h:309
cfg_t
Data structure holding information about a "section".
Definition: confuse.h:252