Asterisk - The Open Source Telephony Project GIT-master-27fb039
Loading...
Searching...
No Matches
Data Structures | Functions | Variables
func_config.c File Reference

A function to retrieve variables from an Asterisk configuration file. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/app.h"
Include dependency graph for func_config.c:

Go to the source code of this file.

Data Structures

struct  config_item
 
struct  configs
 

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
struct ast_moduleAST_MODULE_SELF_SYM (void)
 
static int config_function_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 
static int load_module (void)
 
static int unload_module (void)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Asterisk configuration file variable access" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
 
static const struct ast_module_infoast_module_info = &__mod_info
 
static struct ast_custom_function config_function
 
static struct configs configs = AST_RWLIST_HEAD_INIT_VALUE
 

Detailed Description

A function to retrieve variables from an Asterisk configuration file.

Author
Russell Bryant russe.nosp@m.ll@d.nosp@m.igium.nosp@m..com
Tilghman Lesher func_.nosp@m.conf.nosp@m.ig__2.nosp@m.0080.nosp@m.3@the.nosp@m.-til.nosp@m.ghman.nosp@m..com

Definition in file func_config.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 240 of file func_config.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 240 of file func_config.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void  )

Definition at line 240 of file func_config.c.

◆ config_function_read()

static int config_function_read ( struct ast_channel chan,
const char *  cmd,
char *  data,
char *  buf,
size_t  len 
)
static

Definition at line 76 of file func_config.c.

78{
79 struct ast_config *cfg;
80 struct ast_flags cfg_flags = { CONFIG_FLAG_FILEUNCHANGED };
81 char *parse;
82 struct config_item *cur;
83 int index = 0;
84 struct ast_variable *var;
85 struct ast_variable *found = NULL;
86 int ix = 0;
88 AST_APP_ARG(filename);
89 AST_APP_ARG(category);
90 AST_APP_ARG(variable);
91 AST_APP_ARG(index);
92 );
93
94 if (ast_strlen_zero(data)) {
95 ast_log(LOG_ERROR, "AST_CONFIG() requires an argument\n");
96 return -1;
97 }
98
99 parse = ast_strdupa(data);
101
102 if (ast_strlen_zero(args.filename)) {
103 ast_log(LOG_ERROR, "AST_CONFIG() requires a filename\n");
104 return -1;
105 }
106
107 if (ast_strlen_zero(args.category)) {
108 ast_log(LOG_ERROR, "AST_CONFIG() requires a category\n");
109 return -1;
110 }
111
112 if (ast_strlen_zero(args.variable)) {
113 ast_log(LOG_ERROR, "AST_CONFIG() requires a variable\n");
114 return -1;
115 }
116
117 if (!ast_strlen_zero(args.index)) {
118 if (!sscanf(args.index, "%d", &index)) {
119 ast_log(LOG_ERROR, "AST_CONFIG() index must be an integer\n");
120 return -1;
121 }
122 }
123
124 if (!(cfg = ast_config_load(args.filename, cfg_flags)) || cfg == CONFIG_STATUS_FILEINVALID) {
125 return -1;
126 }
127
128 if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
129 /* Retrieve cfg from list */
131 AST_RWLIST_TRAVERSE(&configs, cur, entry) {
132 if (!strcmp(cur->filename, args.filename)) {
133 break;
134 }
135 }
136
137 if (!cur) {
138 /* At worst, we might leak an entry while upgrading locks */
141 if (!(cur = ast_calloc(1, sizeof(*cur) + strlen(args.filename) + 1))) {
143 return -1;
144 }
145
146 strcpy(cur->filename, args.filename);
147
149 if (!(cfg = ast_config_load(args.filename, cfg_flags)) || cfg == CONFIG_STATUS_FILEINVALID) {
150 ast_free(cur);
152 return -1;
153 }
154
155 cur->cfg = cfg;
156 AST_RWLIST_INSERT_TAIL(&configs, cur, entry);
157 }
158
159 cfg = cur->cfg;
160 } else {
161 /* Replace cfg in list */
163 AST_RWLIST_TRAVERSE(&configs, cur, entry) {
164 if (!strcmp(cur->filename, args.filename)) {
165 break;
166 }
167 }
168
169 if (!cur) {
170 if (!(cur = ast_calloc(1, sizeof(*cur) + strlen(args.filename) + 1))) {
172 return -1;
173 }
174
175 strcpy(cur->filename, args.filename);
176 cur->cfg = cfg;
177
178 AST_RWLIST_INSERT_TAIL(&configs, cur, entry);
179 } else {
181 cur->cfg = cfg;
182 }
183 }
184
185 for (var = ast_category_root(cfg, args.category); var; var = var->next) {
186 if (strcasecmp(args.variable, var->name)) {
187 continue;
188 }
189 found = var;
190 if (index == -1) {
191 continue;
192 }
193 if (ix == index) {
194 break;
195 }
196 found = NULL;
197 ix++;
198 }
199
200 if (!found) {
201 ast_debug(1, "'%s' not found at index %d in [%s] of '%s'. Maximum index found: %d\n",
202 args.variable, index, args.category, args.filename, ix);
204 return -1;
205 }
206
207 ast_copy_string(buf, found->value, len);
208
209 /* Unlock down here, so there's no chance the struct goes away while we're using it. */
211
212 return 0;
213}
#define var
Definition ast_expr2f.c:605
#define ast_free(a)
Definition astmm.h:180
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition astmm.h:298
#define ast_calloc(num, len)
A wrapper for calloc()
Definition astmm.h:202
#define ast_log
Definition astobj2.c:42
char buf[BUFSIZE]
Definition eagi_proxy.c:66
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
#define AST_APP_ARG(name)
Define an application argument.
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application's arguments.
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the 'standard' argument separation process for an application.
#define ast_config_load(filename, flags)
Load a config file.
#define CONFIG_STATUS_FILEUNCHANGED
#define CONFIG_STATUS_FILEINVALID
struct ast_variable * ast_category_root(struct ast_config *config, char *cat)
returns the root ast_variable of a config
void ast_config_destroy(struct ast_config *cfg)
Destroys a config.
Definition extconf.c:1287
@ CONFIG_FLAG_FILEUNCHANGED
#define ast_debug(level,...)
Log a DEBUG message.
#define LOG_ERROR
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition linkedlists.h:78
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
#define AST_RWLIST_TRAVERSE
#define AST_RWLIST_INSERT_TAIL
static struct @519 args
#define NULL
Definition resample.c:96
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition strings.h:65
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition strings.h:425
Structure used to handle boolean flags.
Definition utils.h:220
Structure for variables, used for configurations and for channel variables.
struct ast_config * cfg
Definition func_config.c:70
char filename[0]
Definition func_config.c:71
#define ast_clear_flag(p, flag)
Definition utils.h:78

References args, AST_APP_ARG, ast_calloc, ast_category_root(), ast_clear_flag, ast_config_destroy(), ast_config_load, ast_copy_string(), ast_debug, AST_DECLARE_APP_ARGS, ast_free, ast_log, AST_RWLIST_INSERT_TAIL, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), buf, config_item::cfg, CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, config_item::filename, len(), LOG_ERROR, NULL, ast_variable::value, and var.

◆ load_module()

static int load_module ( void  )
static

Definition at line 235 of file func_config.c.

236{
238}
static struct ast_custom_function config_function
#define ast_custom_function_register(acf)
Register a custom function.
Definition pbx.h:1562

References ast_custom_function_register, and config_function.

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 220 of file func_config.c.

221{
222 struct config_item *current;
224
229 }
231
232 return res;
233}
size_t current
#define AST_RWLIST_REMOVE_HEAD
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
struct config_item::@177 entry

References ast_config_destroy(), ast_custom_function_unregister(), ast_free, AST_RWLIST_REMOVE_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, config_function, current, and config_item::entry.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Asterisk configuration file variable access" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static

Definition at line 240 of file func_config.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 240 of file func_config.c.

◆ config_function

struct ast_custom_function config_function
static
Initial value:
= {
.name = "AST_CONFIG",
}
static int config_function_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
Definition func_config.c:76

Definition at line 215 of file func_config.c.

215 {
216 .name = "AST_CONFIG",
217 .read = config_function_read,
218};

Referenced by load_module(), and unload_module().

◆ configs