Config File Parser

Collaboration diagram for Config File Parser:

Data Structures
struct	switch_config
	A simple file handle representing an open configuration file. More...

Typedefs
typedef typedefSWITCH_BEGIN_EXTERN_C struct switch_config	switch_config_t

Functions
int	switch_config_open_file (switch_config_t *cfg, char *file_path)
	Open a configuration file. More...
void	switch_config_close_file (switch_config_t *cfg)
	Close a previously opened configuration file. More...
int	switch_config_next_pair (switch_config_t *cfg, char **var, char **val)
	Retrieve next name/value pair from configuration file. More...

Detailed Description

This module implements a basic interface and file format parser it may be deprecated in favor of database entries or expanded to tie to external handlers in the future as necessary.

EXAMPLE

[category1]
var1 => val1
var2 => val2
# lines that begin with # are comments
#var3 => val3

Typedef Documentation

switch_config_t

typedef typedefSWITCH_BEGIN_EXTERN_C struct switch_config switch_config_t

Definition at line 61 of file switch_config.h.

Function Documentation

switch_config_close_file()

void switch_config_close_file

(

switch_config_t *

cfg

)

Close a previously opened configuration file.

Parameters

cfg	(switch_config_t *) config handle to use

Definition at line 91 of file switch_config.c.

References memset().

Referenced by switch_config_open_file().

{

        if (cfg->file) {
                fclose(cfg->file);
        }

        memset(cfg, 0, sizeof(*cfg));
}

switch_config_next_pair()

int switch_config_next_pair	(	switch_config_t *	cfg,
		char **	var,
		char **	val
	)

Retrieve next name/value pair from configuration file.

Parameters

cfg	(switch_config_t *) config handle to use
var	pointer to aim at the new variable name
val	pointer to aim at the new value

Definition at line 101 of file switch_config.c.

References switch_copy_string().

Referenced by switch_config_open_file().

{
        int ret = 0;
        char *p, *end;

        *var = *val = NULL;

        if ( !cfg->path[0] ){
                return 0;
        }

        for (;;) {
                cfg->lineno++;

                if (!fgets(cfg->buf, sizeof(cfg->buf), cfg->file)) {
                        ret = 0;
                        break;
                }
                *var = cfg->buf;

                if (**var == '[' && (end = strchr(*var, ']')) != 0) {
                        *end = '\0';
                        (*var)++;
                        if (**var == '+') {
                                (*var)++;
                                switch_copy_string(cfg->section, *var, sizeof(cfg->section));
                                cfg->sectno++;

                                if (cfg->lockto > -1 && cfg->sectno != cfg->lockto) {
                                        break;
                                }
                                cfg->catno = 0;
                                cfg->lineno = 0;
                                *var = "";
                                *val = "";
                                return 1;
                        } else {
                                switch_copy_string(cfg->category, *var, sizeof(cfg->category));
                                cfg->catno++;
                        }
                        continue;
                }

                if (**var == '#' || **var == ';' || **var == '\n' || **var == '\r') {
                        continue;
                }

                if (!strncmp(*var, "__END__", 7)) {
                        break;
                }

                if ((end = strchr(*var, '#')) != 0 || (end = strchr(*var, ';')) != 0) {
                        *end = '\0';
                        end--;
                } else if ((end = strchr(*var, '\n')) != 0) {
                        if (*(end - 1) == '\r') {
                                end--;
                        }
                        *end = '\0';
                }

                p = *var;
                while ((*p == ' ' || *p == '\t') && p != end) {
                        *p = '\0';
                        p++;
                }
                *var = p;

                if ((*val = strchr(*var, '=')) == 0) {
                        ret = -1;
                        /* log_printf(0, server.log, "Invalid syntax on %s: line %d\n", cfg->path, cfg->lineno); */
                        continue;
                } else {
                        p = *val - 1;
                        *(*val) = '\0';
                        (*val)++;
                        if (*(*val) == '>') {
                                *(*val) = '\0';
                                (*val)++;
                        }

                        while ((*p == ' ' || *p == '\t') && p != *var) {
                                *p = '\0';
                                p--;
                        }

                        p = *val;
                        while ((*p == ' ' || *p == '\t') && p != end) {
                                *p = '\0';
                                p++;
                        }
                        *val = p;
                        ret = 1;
                        break;
                }
        }

        return ret;
}

switch_config_open_file()

int switch_config_open_file	(	switch_config_t *	cfg,
		char *	file_path
	)

Open a configuration file.

Parameters

cfg	(switch_config_t *) config handle to use
file_path	path to the file

Returns

1 (true) on success 0 (false) on failure

Definition at line 36 of file switch_config.c.

References switch_directories::conf_dir, memset(), path, switch_config_close_file(), switch_config_next_pair(), SWITCH_GLOBAL_dirs, switch_is_file_path(), SWITCH_PATH_SEPARATOR, switch_set_string, and switch_snprintf().

{
        FILE *f;
        char *path = NULL;
        char path_buf[1024];

        if (!file_path) {
                return 0;
        }

        if (switch_is_file_path(file_path)) {
                path = file_path;
        } else {
                switch_snprintf(path_buf, sizeof(path_buf), "%s%s%s", SWITCH_GLOBAL_dirs.conf_dir, SWITCH_PATH_SEPARATOR, file_path);
                path = path_buf;
        }

        memset(cfg, 0, sizeof(*cfg));
        cfg->lockto = -1;

        if (!(f = fopen(path, "r"))) {
                if (!switch_is_file_path(file_path)) {
                        int last = -1;
                        char *var, *val;

                        switch_snprintf(path_buf, sizeof(path_buf), "%s%sfreeswitch.conf", SWITCH_GLOBAL_dirs.conf_dir, SWITCH_PATH_SEPARATOR);
                        path = path_buf;

                        if ((f = fopen(path, "r")) == 0) {
                                return 0;
                        }

                        cfg->file = f;
                        switch_set_string(cfg->path, path);

                        while (switch_config_next_pair(cfg, &var, &val)) {
                                if ((cfg->sectno != last) && !strcmp(cfg->section, file_path)) {
                                        cfg->lockto = cfg->sectno;
                                        return 1;
                                }
                        }

                        switch_config_close_file(cfg);
                        memset(cfg, 0, sizeof(*cfg));
                        return 0;
                }

                return 0;
        } else {
                cfg->file = f;
                switch_set_string(cfg->path, path);
                return 1;
        }
}