Data retrieval API. More...
#include "asterisk/frame.h"
Go to the source code of this file.
Data Structures | |
struct | ast_data_entry |
This entries are for multiple registers. More... | |
struct | ast_data_handler |
The structure of the node handler. More... | |
struct | ast_data_mapping_structure |
Map the members of a structure. More... | |
struct | ast_data_query |
A query to the data API is specified in this structure. More... | |
struct | ast_data_retrieve |
structure retrieved from a node, with the nodes content. More... | |
Defines | |
#define | __AST_DATA_MAPPING_FUNCTION(__structure, __member, __type) __AST_DATA_MAPPING_FUNCTION_##__type(__structure, __member) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_BOOLEAN(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_BOOLEAN, unsigned int) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_CHARACTER(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_CHARACTER, char) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_CONTAINER(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_CONTAINER, void *) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_DOUBLE(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_DBL, double) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_INTEGER(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_IPADDR(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_IPADDR, struct in_addr) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_MILLISECONDS(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_PASSWORD(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_PASSWORD, char *) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_POINTER(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_POINTER, void *) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_SECONDS(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_STRING(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_STRING, char *) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_TIMESTAMP(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int) |
#define | __AST_DATA_MAPPING_FUNCTION_AST_DATA_UNSIGNED_INTEGER(__structure, __member) __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_UNSIGNED_INTEGER, unsigned int) |
#define | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, __type, __real_type) |
#define | __AST_DATA_MAPPING_STRUCTURE(__structure, __member, __type) |
#define | ast_data_add_structure(structure_name, root, structure) |
#define | AST_DATA_ENTRY(__path, __handler) { .path = __path, .handler = __handler } |
#define | AST_DATA_HANDLER_VERSION 1 |
The Data API structures version. | |
#define | AST_DATA_QUERY_VERSION 1 |
#define | ast_data_register(path, handler) __ast_data_register(path, handler, __FILE__, ast_module_info->self) |
#define | ast_data_register_core(path, handler) __ast_data_register(path, handler, __FILE__, NULL) |
#define | ast_data_register_multiple(data_entries, entries) __ast_data_register_multiple(data_entries, entries, __FILE__, ast_module_info->self) |
#define | ast_data_register_multiple_core(data_entries, entries) __ast_data_register_multiple(data_entries, entries, __FILE__, NULL) |
#define | ast_data_search_cmp_structure(search, structure_name, structure, structure_name_cmp) |
#define | AST_DATA_STRUCTURE(__struct, __name) |
#define | ast_data_unregister(path) __ast_data_unregister(path, __FILE__) |
Typedefs | |
typedef int(* | ast_data_get_cb )(const struct ast_data_search *search, struct ast_data *root) |
The get callback definition. | |
Enumerations | |
enum | ast_data_type { AST_DATA_CONTAINER, AST_DATA_INTEGER, AST_DATA_UNSIGNED_INTEGER, AST_DATA_DOUBLE, AST_DATA_BOOLEAN, AST_DATA_STRING, AST_DATA_CHARACTER, AST_DATA_PASSWORD, AST_DATA_IPADDR, AST_DATA_TIMESTAMP, AST_DATA_SECONDS, AST_DATA_MILLISECONDS, AST_DATA_POINTER } |
The data type of the data node. More... | |
Functions | |
int | __ast_data_add_structure (struct ast_data *root, const struct ast_data_mapping_structure *mapping, size_t mapping_len, void *structure) |
Add a complete structure to a node. | |
int | __ast_data_register (const char *path, const struct ast_data_handler *handler, const char *registrar, struct ast_module *mod) |
Register a data provider. | |
int | __ast_data_register_multiple (const struct ast_data_entry *data_entries, size_t entries, const char *registrar, struct ast_module *mod) |
Register multiple data providers at once. | |
int | __ast_data_search_cmp_structure (const struct ast_data_search *search, const struct ast_data_mapping_structure *mapping, size_t mapping_len, void *structure, const char *structure_name) |
Based on a search tree, evaluate every member of a structure against it. | |
int | __ast_data_unregister (const char *path, const char *registrar) |
Unregister a data provider. | |
struct ast_data * | ast_data_add_bool (struct ast_data *root, const char *childname, unsigned int boolean) |
Add a boolean node type. | |
struct ast_data * | ast_data_add_char (struct ast_data *root, const char *childname, char value) |
Add a char node type. | |
int | ast_data_add_codecs (struct ast_data *root, const char *node_name, format_t capability) |
Add the list of codecs in the root node based on the capability parameter. | |
struct ast_data * | ast_data_add_dbl (struct ast_data *root, const char *childname, double dbl) |
Add a floating point node type. | |
struct ast_data * | ast_data_add_int (struct ast_data *root, const char *childname, int value) |
Add an integer node type. | |
struct ast_data * | ast_data_add_ipaddr (struct ast_data *root, const char *childname, struct in_addr addr) |
Add a ipv4 address type. | |
struct ast_data * | ast_data_add_milliseconds (struct ast_data *root, const char *childname, unsigned int milliseconds) |
Add a milliseconds node type. | |
struct ast_data * | ast_data_add_node (struct ast_data *root, const char *childname) |
Add a container child. | |
struct ast_data * | ast_data_add_password (struct ast_data *root, const char *childname, const char *string) |
Add a password node type. | |
struct ast_data * | ast_data_add_ptr (struct ast_data *root, const char *childname, void *ptr) |
Add a ptr node type. | |
struct ast_data * | ast_data_add_seconds (struct ast_data *root, const char *childname, unsigned int seconds) |
Add a seconds node type. | |
struct ast_data * | ast_data_add_str (struct ast_data *root, const char *childname, const char *string) |
Add a string node type. | |
struct ast_data * | ast_data_add_timestamp (struct ast_data *root, const char *childname, unsigned int timestamp) |
Add a timestamp node type. | |
struct ast_data * | ast_data_add_uint (struct ast_data *root, const char *childname, unsigned int value) |
Add an unsigned integer node type. | |
void | ast_data_free (struct ast_data *root) |
Release the allocated memory of a tree. | |
struct ast_data * | ast_data_get (const struct ast_data_query *query) |
Retrieve a subtree from the asterisk data API. | |
struct ast_xml_doc * | ast_data_get_xml (const struct ast_data_query *query) |
Retrieve a subtree from the asterisk data API in XML format.. | |
void | ast_data_iterator_end (struct ast_data_iterator *iterator) |
Release (stop using) an iterator. | |
struct ast_data_iterator * | ast_data_iterator_init (struct ast_data *tree, const char *elements) |
Initialize an iterator. | |
struct ast_data * | ast_data_iterator_next (struct ast_data_iterator *iterator) |
Get the next node of the tree. | |
void | ast_data_remove_node (struct ast_data *root, struct ast_data *child) |
Remove a node that was added using ast_data_add_. | |
int | ast_data_retrieve (struct ast_data *tree, const char *path, struct ast_data_retrieve *content) |
Retrieve a value from a node in the tree. | |
static unsigned int | ast_data_retrieve_bool (struct ast_data *tree, const char *path) |
Retrieve the boolean value of a node. | |
static char | ast_data_retrieve_char (struct ast_data *tree, const char *path) |
Retrieve the character value of a node. | |
static double | ast_data_retrieve_dbl (struct ast_data *tree, const char *path) |
Retrieve the double value of a node. | |
static int | ast_data_retrieve_int (struct ast_data *tree, const char *path) |
Retrieve the integer value of a node. | |
static struct in_addr | ast_data_retrieve_ipaddr (struct ast_data *tree, const char *path) |
Retrieve the ipv4 address value of a node. | |
char * | ast_data_retrieve_name (struct ast_data *node) |
Get the node name. | |
static const char * | ast_data_retrieve_password (struct ast_data *tree, const char *path) |
Retrieve the password value of a node. | |
static void * | ast_data_retrieve_ptr (struct ast_data *tree, const char *path) |
Retrieve the ptr value of a node. | |
static const char * | ast_data_retrieve_string (struct ast_data *tree, const char *path) |
Retrieve the string value of a node. | |
enum ast_data_type | ast_data_retrieve_type (struct ast_data *res, const char *path) |
Get a node type. | |
static unsigned int | ast_data_retrieve_uint (struct ast_data *tree, const char *path) |
Retrieve the unsigned integer value of a node. | |
int | ast_data_search_match (const struct ast_data_search *search, struct ast_data *data) |
Check the current generated node to know if it matches the search condition. |
Data retrieval API.
Definition in file data.h.
#define __AST_DATA_MAPPING_FUNCTION | ( | __structure, | |||
__member, | |||||
__type | ) | __AST_DATA_MAPPING_FUNCTION_##__type(__structure, __member) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_BOOLEAN | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_BOOLEAN, unsigned int) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_CHARACTER | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_CHARACTER, char) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_CONTAINER | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_CONTAINER, void *) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_DOUBLE | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_DBL, double) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_INTEGER | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_IPADDR | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_IPADDR, struct in_addr) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_MILLISECONDS | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_PASSWORD | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_PASSWORD, char *) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_POINTER | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_POINTER, void *) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_SECONDS | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_STRING | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_STRING, char *) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_TIMESTAMP | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int) |
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_UNSIGNED_INTEGER | ( | __structure, | |||
__member | ) | __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_UNSIGNED_INTEGER, unsigned int) |
#define __AST_DATA_MAPPING_FUNCTION_TYPE | ( | __structure, | |||
__member, | |||||
__type, | |||||
__real_type | ) |
#define __AST_DATA_MAPPING_STRUCTURE | ( | __structure, | |||
__member, | |||||
__type | ) |
#define ast_data_add_structure | ( | structure_name, | |||
root, | |||||
structure | ) |
__ast_data_add_structure(root, __data_mapping_structure_##structure_name, \ ARRAY_LEN(__data_mapping_structure_##structure_name), structure)
Definition at line 620 of file data.h.
Referenced by agents_data_provider_get(), ast_channel_data_add_structure(), ast_tone_zone_data_add_structure(), dahdi_channels_data_provider_get(), data_odbc_provider_handler(), meetme_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), user_add_provider_cb(), users_data_provider_get(), and vm_users_data_provider_get_helper().
#define AST_DATA_ENTRY | ( | __path, | |||
__handler | ) | { .path = __path, .handler = __handler } |
#define AST_DATA_HANDLER_VERSION 1 |
#define AST_DATA_QUERY_VERSION 1 |
Definition at line 205 of file data.h.
Referenced by handle_cli_data_get(), and manager_data_get().
#define ast_data_register | ( | path, | |||
handler | ) | __ast_data_register(path, handler, __FILE__, ast_module_info->self) |
#define ast_data_register_core | ( | path, | |||
handler | ) | __ast_data_register(path, handler, __FILE__, NULL) |
#define ast_data_register_multiple | ( | data_entries, | |||
entries | ) | __ast_data_register_multiple(data_entries, entries, __FILE__, ast_module_info->self) |
Definition at line 377 of file data.h.
Referenced by load_module().
#define ast_data_register_multiple_core | ( | data_entries, | |||
entries | ) | __ast_data_register_multiple(data_entries, entries, __FILE__, NULL) |
Definition at line 379 of file data.h.
Referenced by ast_channels_init(), and load_pbx().
#define ast_data_search_cmp_structure | ( | search, | |||
structure_name, | |||||
structure, | |||||
structure_name_cmp | ) |
__ast_data_search_cmp_structure(search, __data_mapping_structure_##structure_name, \ ARRAY_LEN(__data_mapping_structure_##structure_name), structure, structure_name_cmp)
Definition at line 420 of file data.h.
Referenced by ast_channel_data_cmp_structure().
#define AST_DATA_STRUCTURE | ( | __struct, | |||
__name | ) |
__name(__AST_DATA_MAPPING_FUNCTION); \ static const struct ast_data_mapping_structure __data_mapping_structure_##__struct[] = { \ __name(__AST_DATA_MAPPING_STRUCTURE) \ }
#define ast_data_unregister | ( | path | ) | __ast_data_unregister(path, __FILE__) |
Definition at line 394 of file data.h.
Referenced by __unload_module(), channels_shutdown(), unload_module(), and unload_pbx().
typedef int(* ast_data_get_cb)(const struct ast_data_search *search, struct ast_data *root) |
enum ast_data_type |
The data type of the data node.
Definition at line 187 of file data.h.
00187 { 00188 AST_DATA_CONTAINER, 00189 AST_DATA_INTEGER, 00190 AST_DATA_UNSIGNED_INTEGER, 00191 AST_DATA_DOUBLE, 00192 AST_DATA_BOOLEAN, 00193 AST_DATA_STRING, 00194 AST_DATA_CHARACTER, 00195 AST_DATA_PASSWORD, 00196 AST_DATA_IPADDR, 00197 AST_DATA_TIMESTAMP, 00198 AST_DATA_SECONDS, 00199 AST_DATA_MILLISECONDS, 00200 AST_DATA_POINTER 00201 };
int __ast_data_add_structure | ( | struct ast_data * | root, | |
const struct ast_data_mapping_structure * | mapping, | |||
size_t | mapping_len, | |||
void * | structure | |||
) |
Add a complete structure to a node.
[in] | root | Where to add the structure. |
[in] | mapping | The structure mapping array. |
[in] | mapping_len | The lenght of the mapping array. |
[in] | structure | The structure pointer. |
0 | on success. | |
1 | on error. |
Definition at line 2422 of file data.c.
References ast_data_add_bool(), ast_data_add_char(), ast_data_add_dbl(), ast_data_add_int(), ast_data_add_ipaddr(), ast_data_add_milliseconds(), ast_data_add_password(), ast_data_add_ptr(), ast_data_add_seconds(), ast_data_add_str(), ast_data_add_timestamp(), ast_data_add_uint(), AST_DATA_BOOLEAN, AST_DATA_CHARACTER, AST_DATA_CONTAINER, AST_DATA_DOUBLE, AST_DATA_INTEGER, AST_DATA_IPADDR, AST_DATA_MILLISECONDS, AST_DATA_PASSWORD, AST_DATA_POINTER, AST_DATA_SECONDS, AST_DATA_STRING, AST_DATA_TIMESTAMP, AST_DATA_UNSIGNED_INTEGER, data_filter::name, and type.
02425 { 02426 int i; 02427 02428 for (i = 0; i < mapping_len; i++) { 02429 switch (mapping[i].type) { 02430 case AST_DATA_INTEGER: 02431 ast_data_add_int(root, mapping[i].name, 02432 mapping[i].get.AST_DATA_INTEGER(structure)); 02433 break; 02434 case AST_DATA_UNSIGNED_INTEGER: 02435 ast_data_add_uint(root, mapping[i].name, 02436 mapping[i].get.AST_DATA_UNSIGNED_INTEGER(structure)); 02437 break; 02438 case AST_DATA_DOUBLE: 02439 ast_data_add_dbl(root, mapping[i].name, 02440 mapping[i].get.AST_DATA_DOUBLE(structure)); 02441 break; 02442 case AST_DATA_BOOLEAN: 02443 ast_data_add_bool(root, mapping[i].name, 02444 mapping[i].get.AST_DATA_BOOLEAN(structure)); 02445 break; 02446 case AST_DATA_PASSWORD: 02447 ast_data_add_password(root, mapping[i].name, 02448 mapping[i].get.AST_DATA_PASSWORD(structure)); 02449 break; 02450 case AST_DATA_TIMESTAMP: 02451 ast_data_add_timestamp(root, mapping[i].name, 02452 mapping[i].get.AST_DATA_TIMESTAMP(structure)); 02453 break; 02454 case AST_DATA_SECONDS: 02455 ast_data_add_seconds(root, mapping[i].name, 02456 mapping[i].get.AST_DATA_SECONDS(structure)); 02457 break; 02458 case AST_DATA_MILLISECONDS: 02459 ast_data_add_milliseconds(root, mapping[i].name, 02460 mapping[i].get.AST_DATA_MILLISECONDS(structure)); 02461 break; 02462 case AST_DATA_STRING: 02463 ast_data_add_str(root, mapping[i].name, 02464 mapping[i].get.AST_DATA_STRING(structure)); 02465 break; 02466 case AST_DATA_CHARACTER: 02467 ast_data_add_char(root, mapping[i].name, 02468 mapping[i].get.AST_DATA_CHARACTER(structure)); 02469 break; 02470 case AST_DATA_CONTAINER: 02471 break; 02472 case AST_DATA_IPADDR: 02473 ast_data_add_ipaddr(root, mapping[i].name, 02474 mapping[i].get.AST_DATA_IPADDR(structure)); 02475 break; 02476 case AST_DATA_POINTER: 02477 ast_data_add_ptr(root, mapping[i].name, 02478 mapping[i].get.AST_DATA_POINTER(structure)); 02479 break; 02480 } 02481 } 02482 02483 return 0; 02484 }
int __ast_data_register | ( | const char * | path, | |
const struct ast_data_handler * | handler, | |||
const char * | registrar, | |||
struct ast_module * | mod | |||
) |
Register a data provider.
[in] | path | The path of the node to register. |
[in] | handler | The structure defining this node handler. |
[in] | registrar | Who is registering this node. |
[in] | mod | The module registering this handler. |
<0 | on error. | |
0 | on success. |
Definition at line 518 of file data.c.
References ao2_container_count(), ao2_ref, ast_log(), data_provider::children, data_provider_create(), data_structure_compatible(), data_unlock, data_write_lock, data_provider::handler, LOG_ERROR, data_provider::module, data_provider::name, root_data, and ast_data_handler::version.
Referenced by __ast_data_register_multiple().
00520 { 00521 struct data_provider *node; 00522 00523 if (!path) { 00524 return -1; 00525 } 00526 00527 /* check if the handler structure is compatible. */ 00528 if (!data_structure_compatible(handler->version, 00529 latest_handler_compatible_version, 00530 current_handler_version)) { 00531 return -1; 00532 } 00533 00534 /* create the node structure for the registered handler. */ 00535 data_write_lock(); 00536 00537 node = data_provider_create(root_data.container, path, registrar); 00538 if (!node) { 00539 ast_log(LOG_ERROR, "Unable to create the specified path (%s) " 00540 "for '%s'.\n", path, registrar); 00541 data_unlock(); 00542 return -1; 00543 } 00544 00545 if (ao2_container_count(node->children) || node->handler) { 00546 ast_log(LOG_ERROR, "The node '%s' was already registered. " 00547 "We were unable to register '%s' for registrar '%s'.\n", 00548 node->name, path, registrar); 00549 ao2_ref(node, -1); 00550 data_unlock(); 00551 return -1; 00552 } 00553 00554 /* add handler to that node. */ 00555 node->handler = handler; 00556 node->module = mod; 00557 00558 ao2_ref(node, -1); 00559 00560 data_unlock(); 00561 00562 return 0; 00563 }
int __ast_data_register_multiple | ( | const struct ast_data_entry * | data_entries, | |
size_t | entries, | |||
const char * | registrar, | |||
struct ast_module * | mod | |||
) |
Register multiple data providers at once.
[in] | data_entries | An array of data_entries structures. |
[in] | entries | The number of entries in the data_entries array. |
[in] | registrar | Who is registering this nodes. |
[in] | mod | The module registering this handlers. |
<0 | on error (none of the nodes are being registered on error). | |
0 | on success. |
Definition at line 565 of file data.c.
References __ast_data_register(), __ast_data_unregister(), and data_provider::handler.
00567 { 00568 int i, res; 00569 00570 for (i = 0; i < entries; i++) { 00571 res = __ast_data_register(data_entries[i].path, data_entries[i].handler, 00572 registrar, mod); 00573 if (res) { 00574 /* unregister all the already registered nodes, and make 00575 * this an atomic action. */ 00576 while ((--i) >= 0) { 00577 __ast_data_unregister(data_entries[i].path, registrar); 00578 } 00579 return -1; 00580 } 00581 } 00582 00583 return 0; 00584 }
int __ast_data_search_cmp_structure | ( | const struct ast_data_search * | search, | |
const struct ast_data_mapping_structure * | mapping, | |||
size_t | mapping_len, | |||
void * | structure, | |||
const char * | structure_name | |||
) |
Based on a search tree, evaluate every member of a structure against it.
[in] | search | The search tree. |
[in] | mapping | The structure mapping. |
[in] | mapping_len | The lenght of the structure mapping. |
[in] | structure | The structure pointer. |
[in] | structure_name | The name of the structure to compare. |
0 | If the structure matches. | |
1 | If the structure doesn't match. |
Definition at line 1272 of file data.c.
References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_data_mapping_structure::AST_DATA_BOOLEAN, AST_DATA_BOOLEAN, ast_data_mapping_structure::AST_DATA_CHARACTER, AST_DATA_CHARACTER, AST_DATA_CONTAINER, ast_data_mapping_structure::AST_DATA_DOUBLE, AST_DATA_DOUBLE, ast_data_mapping_structure::AST_DATA_INTEGER, AST_DATA_INTEGER, ast_data_mapping_structure::AST_DATA_IPADDR, AST_DATA_IPADDR, ast_data_mapping_structure::AST_DATA_MILLISECONDS, AST_DATA_MILLISECONDS, ast_data_mapping_structure::AST_DATA_PASSWORD, AST_DATA_PASSWORD, ast_data_mapping_structure::AST_DATA_POINTER, AST_DATA_POINTER, ast_data_mapping_structure::AST_DATA_SECONDS, AST_DATA_SECONDS, ast_data_mapping_structure::AST_DATA_STRING, AST_DATA_STRING, ast_data_mapping_structure::AST_DATA_TIMESTAMP, AST_DATA_TIMESTAMP, ast_data_mapping_structure::AST_DATA_UNSIGNED_INTEGER, AST_DATA_UNSIGNED_INTEGER, ast_data_search::children, data_search_cmp_bool(), data_search_cmp_char(), data_search_cmp_dbl(), data_search_cmp_int(), data_search_cmp_ipaddr(), data_search_cmp_ptr(), data_search_cmp_string(), data_search_cmp_uint(), data_search_get_node(), data_search_mapping_find(), ast_data_mapping_structure::get, ast_data_search::name, and type.
01275 { 01276 struct ao2_iterator i; 01277 struct ast_data_search *node, *struct_children; 01278 int member, notmatch = 0; 01279 01280 if (!search) { 01281 return 0; 01282 } 01283 01284 struct_children = data_search_get_node(search, structure_name); 01285 if (!struct_children) { 01286 return 0; 01287 } 01288 01289 i = ao2_iterator_init(struct_children->children, 0); 01290 while ((node = ao2_iterator_next(&i))) { 01291 member = data_search_mapping_find(mapping, mapping_len, node->name); 01292 if (member < 0) { 01293 /* the structure member name doesn't match! */ 01294 ao2_ref(node, -1); 01295 ao2_ref(struct_children, -1); 01296 ao2_iterator_destroy(&i); 01297 return 0; 01298 } 01299 01300 notmatch = 0; 01301 switch (mapping[member].type) { 01302 case AST_DATA_PASSWORD: 01303 notmatch = data_search_cmp_string(struct_children, 01304 node->name, 01305 mapping[member].get.AST_DATA_PASSWORD(structure)); 01306 break; 01307 case AST_DATA_TIMESTAMP: 01308 notmatch = data_search_cmp_uint(struct_children, 01309 node->name, 01310 mapping[member].get.AST_DATA_TIMESTAMP(structure)); 01311 break; 01312 case AST_DATA_SECONDS: 01313 notmatch = data_search_cmp_uint(struct_children, 01314 node->name, 01315 mapping[member].get.AST_DATA_SECONDS(structure)); 01316 break; 01317 case AST_DATA_MILLISECONDS: 01318 notmatch = data_search_cmp_uint(struct_children, 01319 node->name, 01320 mapping[member].get.AST_DATA_MILLISECONDS(structure)); 01321 break; 01322 case AST_DATA_STRING: 01323 notmatch = data_search_cmp_string(struct_children, 01324 node->name, 01325 mapping[member].get.AST_DATA_STRING(structure)); 01326 break; 01327 case AST_DATA_CHARACTER: 01328 notmatch = data_search_cmp_char(struct_children, 01329 node->name, 01330 mapping[member].get.AST_DATA_CHARACTER(structure)); 01331 break; 01332 case AST_DATA_INTEGER: 01333 notmatch = data_search_cmp_int(struct_children, 01334 node->name, 01335 mapping[member].get.AST_DATA_INTEGER(structure)); 01336 break; 01337 case AST_DATA_BOOLEAN: 01338 notmatch = data_search_cmp_bool(struct_children, 01339 node->name, 01340 mapping[member].get.AST_DATA_BOOLEAN(structure)); 01341 break; 01342 case AST_DATA_UNSIGNED_INTEGER: 01343 notmatch = data_search_cmp_uint(struct_children, 01344 node->name, 01345 mapping[member].get.AST_DATA_UNSIGNED_INTEGER(structure)); 01346 break; 01347 case AST_DATA_DOUBLE: 01348 notmatch = data_search_cmp_dbl(struct_children, 01349 node->name, 01350 mapping[member].get.AST_DATA_DOUBLE(structure)); 01351 break; 01352 case AST_DATA_IPADDR: 01353 notmatch = data_search_cmp_ipaddr(struct_children, 01354 node->name, 01355 mapping[member].get.AST_DATA_IPADDR(structure)); 01356 break; 01357 case AST_DATA_POINTER: 01358 notmatch = data_search_cmp_ptr(struct_children, 01359 node->name, 01360 mapping[member].get.AST_DATA_POINTER(structure)); 01361 break; 01362 case AST_DATA_CONTAINER: 01363 break; 01364 } 01365 01366 ao2_ref(node, -1); 01367 } 01368 ao2_iterator_destroy(&i); 01369 01370 ao2_ref(struct_children, -1); 01371 01372 return notmatch; 01373 }
int __ast_data_unregister | ( | const char * | path, | |
const char * | registrar | |||
) |
Unregister a data provider.
[in] | path | Which node to unregister, if path is NULL unregister every node registered by the passed 'registrar'. |
[in] | registrar | Who is trying to unregister this node, only the owner (the one who registered the node) will be able to unregister it. |
<0 | on error. | |
0 | on success. |
Definition at line 586 of file data.c.
References ast_log(), data_provider_release(), data_provider_release_all(), data_unlock, data_write_lock, LOG_ERROR, and root_data.
Referenced by __ast_data_register_multiple().
00587 { 00588 int ret = 0; 00589 00590 data_write_lock(); 00591 if (path) { 00592 ret = data_provider_release(root_data.container, path, registrar); 00593 } else { 00594 data_provider_release_all(root_data.container, registrar); 00595 } 00596 data_unlock(); 00597 00598 if (path && ret) { 00599 ast_log(LOG_ERROR, "Unable to unregister '%s' for '%s'\n", 00600 path, registrar); 00601 } 00602 00603 return ret; 00604 }
struct ast_data* ast_data_add_bool | ( | struct ast_data * | root, | |
const char * | childname, | |||
unsigned int | boolean | |||
) | [read] |
Add a boolean node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | boolean | The value for the new node. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2344 of file data.c.
References __ast_data_add(), and AST_DATA_BOOLEAN.
Referenced by __ast_data_add_structure(), agents_data_provider_get(), ast_channel_data_add_structure(), channel_data_add_flags(), dahdi_status_data_provider_get(), data_channeltypes_provider_handler(), data_odbc_provider_handler(), peers_data_provider_get(), and users_data_provider_get().
02346 { 02347 return __ast_data_add(root, childname, AST_DATA_BOOLEAN, &boolean); 02348 }
struct ast_data* ast_data_add_char | ( | struct ast_data * | root, | |
const char * | childname, | |||
char | value | |||
) | [read] |
Add a char node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | value | The value for the new node. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2327 of file data.c.
References __ast_data_add(), and AST_DATA_CHARACTER.
Referenced by __ast_data_add_structure().
02328 { 02329 return __ast_data_add(root, name, AST_DATA_CHARACTER, &value); 02330 }
Add the list of codecs in the root node based on the capability parameter.
[in] | root | The astdata root node where to add the codecs node. |
[in] | node_name | The name of the node where we are going to add the list of codecs. |
[in] | capability | The codecs allowed. |
Definition at line 3112 of file data.c.
References ast_data_add_int(), ast_data_add_node(), ast_data_add_str(), ast_get_format_list(), ast_format_list::bits, desc, ast_format_list::fr_len, data_filter::name, and ast_format_list::samplespersecond.
Referenced by ast_channel_data_add_structure(), data_channeltypes_provider_handler(), peers_data_provider_get(), and users_data_provider_get().
03113 { 03114 struct ast_data *codecs, *codec; 03115 size_t fmlist_size; 03116 const struct ast_format_list *fmlist; 03117 int x; 03118 03119 codecs = ast_data_add_node(root, node_name); 03120 if (!codecs) { 03121 return -1; 03122 } 03123 fmlist = ast_get_format_list(&fmlist_size); 03124 for (x = 0; x < fmlist_size; x++) { 03125 if (fmlist[x].bits & capability) { 03126 codec = ast_data_add_node(codecs, "codec"); 03127 if (!codec) { 03128 return -1; 03129 } 03130 ast_data_add_str(codec, "name", fmlist[x].name); 03131 ast_data_add_int(codec, "samplespersecond", fmlist[x].samplespersecond); 03132 ast_data_add_str(codec, "description", fmlist[x].desc); 03133 ast_data_add_int(codec, "frame_length", fmlist[x].fr_len); 03134 } 03135 } 03136 03137 return 0; 03138 }
struct ast_data* ast_data_add_dbl | ( | struct ast_data * | root, | |
const char * | childname, | |||
double | dbl | |||
) | [read] |
Add a floating point node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | dbl | The value for the new node. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2338 of file data.c.
References __ast_data_add(), and AST_DATA_DOUBLE.
Referenced by __ast_data_add_structure().
02340 { 02341 return __ast_data_add(root, childname, AST_DATA_DOUBLE, &dbl); 02342 }
struct ast_data* ast_data_add_int | ( | struct ast_data * | root, | |
const char * | childname, | |||
int | value | |||
) | [read] |
Add an integer node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | value | The value for the new node. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2322 of file data.c.
References __ast_data_add(), and AST_DATA_INTEGER.
Referenced by __ast_data_add_structure(), ast_cdr_data_add_structure(), ast_channel_data_add_structure(), ast_data_add_codecs(), dahdi_status_data_provider_get(), data_odbc_provider_handler(), hints_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), user_add_provider_cb(), users_data_provider_get(), and vm_users_data_provider_get_helper().
02323 { 02324 return __ast_data_add(root, name, AST_DATA_INTEGER, &value); 02325 }
struct ast_data* ast_data_add_ipaddr | ( | struct ast_data * | root, | |
const char * | childname, | |||
struct in_addr | addr | |||
) | [read] |
Add a ipv4 address type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | addr | The ipv4 address value. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2350 of file data.c.
References __ast_data_add(), and AST_DATA_IPADDR.
Referenced by __ast_data_add_structure().
02352 { 02353 return __ast_data_add(root, childname, AST_DATA_IPADDR, &addr); 02354 }
struct ast_data* ast_data_add_milliseconds | ( | struct ast_data * | root, | |
const char * | childname, | |||
unsigned int | milliseconds | |||
) | [read] |
Add a milliseconds node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | milliseconds | The value for the new node. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2374 of file data.c.
References __ast_data_add(), and AST_DATA_MILLISECONDS.
Referenced by __ast_data_add_structure().
02376 { 02377 return __ast_data_add(root, childname, AST_DATA_MILLISECONDS, &milliseconds); 02378 }
Add a container child.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2317 of file data.c.
References __ast_data_add(), and AST_DATA_CONTAINER.
Referenced by agents_data_provider_get(), ast_cdr_data_add_structure(), ast_channel_data_add_structure(), ast_data_add_codecs(), ast_tone_zone_data_add_structure(), dahdi_channels_data_provider_get(), dahdi_status_data_provider_get(), data_channels_provider_handler(), data_channeltypes_provider_handler(), data_odbc_provider_handler(), hints_data_provider_get(), meetme_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), user_add_provider_cb(), users_data_provider_get(), and vm_users_data_provider_get_helper().
02318 { 02319 return __ast_data_add(root, name, AST_DATA_CONTAINER, NULL); 02320 }
struct ast_data* ast_data_add_password | ( | struct ast_data * | root, | |
const char * | childname, | |||
const char * | string | |||
) | [read] |
Add a password node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | string | The value for the new node. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2380 of file data.c.
References __ast_data_add(), AST_DATA_PASSWORD, ast_free, ast_malloc, ast_strlen_zero(), and data_filter::name.
Referenced by __ast_data_add_structure(), and users_data_provider_get().
02382 { 02383 char *name; 02384 size_t namelen = 1 + (ast_strlen_zero(value) ? 0 : strlen(value)); 02385 struct ast_data *res; 02386 02387 if (!(name = ast_malloc(namelen))) { 02388 return NULL; 02389 } 02390 02391 strcpy(name, (ast_strlen_zero(value) ? "" : value)); 02392 02393 res = __ast_data_add(root, childname, AST_DATA_PASSWORD, name); 02394 if (!res) { 02395 ast_free(name); 02396 } 02397 02398 return res; 02399 }
struct ast_data* ast_data_add_ptr | ( | struct ast_data * | root, | |
const char * | childname, | |||
void * | ptr | |||
) | [read] |
Add a ptr node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | ptr | The pointer value to add. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2356 of file data.c.
References __ast_data_add(), and AST_DATA_POINTER.
Referenced by __ast_data_add_structure().
02358 { 02359 return __ast_data_add(root, childname, AST_DATA_POINTER, ptr); 02360 }
struct ast_data* ast_data_add_seconds | ( | struct ast_data * | root, | |
const char * | childname, | |||
unsigned int | seconds | |||
) | [read] |
Add a seconds node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | seconds | The value for the new node. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2368 of file data.c.
References __ast_data_add(), and AST_DATA_SECONDS.
Referenced by __ast_data_add_structure().
02370 { 02371 return __ast_data_add(root, childname, AST_DATA_SECONDS, &seconds); 02372 }
struct ast_data* ast_data_add_str | ( | struct ast_data * | root, | |
const char * | childname, | |||
const char * | string | |||
) | [read] |
Add a string node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | string | The value for the new node. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2401 of file data.c.
References __ast_data_add(), AST_DATA_STRING, ast_free, ast_malloc, ast_strlen_zero(), and data_filter::name.
Referenced by __ast_data_add_structure(), agents_data_provider_get(), ast_cdr_data_add_structure(), ast_channel_data_add_structure(), ast_data_add_codecs(), dahdi_status_data_provider_get(), dahdi_version_data_provider_get(), data_channeltypes_provider_handler(), data_odbc_provider_handler(), hints_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), and users_data_provider_get().
02403 { 02404 char *name; 02405 size_t namelen = 1 + (ast_strlen_zero(value) ? 0 : strlen(value)); 02406 struct ast_data *res; 02407 02408 if (!(name = ast_malloc(namelen))) { 02409 return NULL; 02410 } 02411 02412 strcpy(name, (ast_strlen_zero(value) ? "" : value)); 02413 02414 res = __ast_data_add(root, childname, AST_DATA_STRING, name); 02415 if (!res) { 02416 ast_free(name); 02417 } 02418 02419 return res; 02420 }
struct ast_data* ast_data_add_timestamp | ( | struct ast_data * | root, | |
const char * | childname, | |||
unsigned int | timestamp | |||
) | [read] |
Add a timestamp node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | timestamp | The value for the new node. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2362 of file data.c.
References __ast_data_add(), and AST_DATA_TIMESTAMP.
Referenced by __ast_data_add_structure().
02364 { 02365 return __ast_data_add(root, childname, AST_DATA_TIMESTAMP, ×tamp); 02366 }
struct ast_data* ast_data_add_uint | ( | struct ast_data * | root, | |
const char * | childname, | |||
unsigned int | value | |||
) | [read] |
Add an unsigned integer node type.
[in] | root | The root of the ast_data to insert into. |
[in] | childname | The name of the child element to be added. |
[in] | value | The value for the new node. |
NULL | on error (memory exhaustion only). | |
non-NULL | a newly allocated node. |
Definition at line 2332 of file data.c.
References __ast_data_add(), and AST_DATA_UNSIGNED_INTEGER.
Referenced by __ast_data_add_structure(), and ast_channel_data_add_structure().
02334 { 02335 return __ast_data_add(root, name, AST_DATA_UNSIGNED_INTEGER, &value); 02336 }
void ast_data_free | ( | struct ast_data * | root | ) |
Release the allocated memory of a tree.
[in] | root | The sub-tree pointer returned by a call to ast_data_get. |
Definition at line 2491 of file data.c.
References ao2_ref.
Referenced by ast_data_get_xml(), handle_cli_data_get(), and manager_data_get().
02492 { 02493 /* destroy it, this will destroy all the internal nodes. */ 02494 ao2_ref(root, -1); 02495 }
struct ast_data* ast_data_get | ( | const struct ast_data_query * | query | ) | [read] |
Retrieve a subtree from the asterisk data API.
[in] | query | The query structure specifying what nodes to retrieve. |
NULL | on error. | |
non-NULL | The dynamically allocated requested sub-tree (it needs to be released using ast_data_free. |
Definition at line 2065 of file data.c.
References ast_log(), data_read_lock, data_result_generate(), data_structure_compatible(), data_unlock, LOG_ERROR, ast_data_query::path, and ast_data_query::version.
Referenced by ast_data_get_xml(), handle_cli_data_get(), and manager_data_get().
02066 { 02067 struct ast_data *res; 02068 02069 /* check compatibility */ 02070 if (!data_structure_compatible(query->version, latest_query_compatible_version, 02071 current_query_version)) { 02072 return NULL; 02073 } 02074 02075 data_read_lock(); 02076 res = data_result_generate(query, query->path); 02077 data_unlock(); 02078 02079 if (!res) { 02080 ast_log(LOG_ERROR, "Unable to get data from %s\n", query->path); 02081 return NULL; 02082 } 02083 02084 return res; 02085 }
struct ast_xml_doc* ast_data_get_xml | ( | const struct ast_data_query * | query | ) | [read] |
Retrieve a subtree from the asterisk data API in XML format..
[in] | query | The query structure specifying what nodes to retrieve. |
NULL | on error. | |
non-NULL | The dynamically allocated requested sub-tree (it needs to be released using ast_data_free. |
Definition at line 2181 of file data.c.
References ast_data_free(), ast_data_get(), ast_xml_close(), ast_xml_new(), ast_xml_new_node(), ast_xml_set_root(), data_get_xml_add_child(), and ast_data::name.
02182 { 02183 struct ast_xml_doc *doc; 02184 struct ast_xml_node *root; 02185 struct ast_data *res; 02186 02187 res = ast_data_get(query); 02188 if (!res) { 02189 return NULL; 02190 } 02191 02192 doc = ast_xml_new(); 02193 if (!doc) { 02194 ast_data_free(res); 02195 return NULL; 02196 } 02197 02198 root = ast_xml_new_node(res->name); 02199 if (!root) { 02200 ast_xml_close(doc); 02201 } 02202 02203 ast_xml_set_root(doc, root); 02204 02205 data_get_xml_add_child(res, root); 02206 02207 ast_data_free(res); 02208 02209 return doc; 02210 }
void ast_data_iterator_end | ( | struct ast_data_iterator * | iterator | ) |
Release (stop using) an iterator.
[in] | iterator | The iterator created by ast_data_iterator_start. |
Definition at line 2542 of file data.c.
References ao2_iterator_destroy(), ao2_ref, ast_free, ast_data_iterator::internal_iterator, ast_data_iterator::is_pattern, ast_data_iterator::last, and ast_data_iterator::regex_pattern.
02543 { 02544 /* decrement the reference counter. */ 02545 if (iterator->last) { 02546 ao2_ref(iterator->last, -1); 02547 } 02548 02549 /* release the generated pattern. */ 02550 if (iterator->is_pattern) { 02551 regfree(&(iterator->regex_pattern)); 02552 } 02553 02554 ao2_iterator_destroy(&(iterator->internal_iterator)); 02555 02556 ast_free(iterator); 02557 iterator = NULL; 02558 }
struct ast_data_iterator* ast_data_iterator_init | ( | struct ast_data * | tree, | |
const char * | elements | |||
) | [read] |
Initialize an iterator.
[in] | tree | The returned tree by a call to ast_data_get. |
[in] | elements | Which elements to iterate through. |
NULL | on error. | |
non-NULL | A dinamically allocated iterator structure. |
Definition at line 2497 of file data.c.
References ao2_iterator_init(), ast_calloc, ast_strdupa, data_result_get_node(), ast_data_iterator::internal_iterator, ast_data_iterator::is_pattern, ast_data_iterator::pattern, ast_data::ptr, and ast_data_iterator::regex_pattern.
02499 { 02500 struct ast_data_iterator *iterator; 02501 struct ao2_iterator i; 02502 struct ast_data *internal = tree; 02503 char *path, *ptr = NULL; 02504 02505 if (!elements) { 02506 return NULL; 02507 } 02508 02509 /* tree is the node we want to use to iterate? or we are going 02510 * to iterate thow an internal node? */ 02511 path = ast_strdupa(elements); 02512 02513 ptr = strrchr(path, '/'); 02514 if (ptr) { 02515 *ptr = '\0'; 02516 internal = data_result_get_node(tree, path); 02517 if (!internal) { 02518 return NULL; 02519 } 02520 } 02521 02522 iterator = ast_calloc(1, sizeof(*iterator)); 02523 if (!iterator) { 02524 return NULL; 02525 } 02526 02527 i = ao2_iterator_init(internal->children, 0); 02528 02529 iterator->pattern = (ptr ? strrchr(elements, '/') + 1 : elements); 02530 02531 /* is the last node a regular expression?, compile it! */ 02532 if (!regcomp(&(iterator->regex_pattern), iterator->pattern, 02533 REG_EXTENDED | REG_NOSUB | REG_ICASE)) { 02534 iterator->is_pattern = 1; 02535 } 02536 02537 iterator->internal_iterator = i; 02538 02539 return iterator; 02540 }
struct ast_data* ast_data_iterator_next | ( | struct ast_data_iterator * | iterator | ) | [read] |
Get the next node of the tree.
[in] | iterator | The iterator structure returned by ast_data_iterator_start. |
NULL | when no more nodes to return. | |
non-NULL | A node of the ast_data tree. |
Definition at line 2560 of file data.c.
References ao2_iterator_next, ao2_ref, ast_data_iterator::internal_iterator, ast_data_iterator::is_pattern, ast_data_iterator::last, ast_data::name, ast_data_iterator::pattern, and ast_data_iterator::regex_pattern.
02561 { 02562 struct ast_data *res; 02563 02564 if (iterator->last) { 02565 /* release the last retrieved node reference. */ 02566 ao2_ref(iterator->last, -1); 02567 } 02568 02569 while ((res = ao2_iterator_next(&iterator->internal_iterator))) { 02570 /* if there is no node name pattern specified, return 02571 * the next node. */ 02572 if (!iterator->pattern) { 02573 break; 02574 } 02575 02576 /* if the pattern is a regular expression, check if this node 02577 * matches. */ 02578 if (iterator->is_pattern && !regexec(&(iterator->regex_pattern), 02579 res->name, 0, NULL, 0)) { 02580 break; 02581 } 02582 02583 /* if there is a pattern specified, check if this node matches 02584 * the wanted node names. */ 02585 if (!iterator->is_pattern && (iterator->pattern && 02586 !strcasecmp(res->name, iterator->pattern))) { 02587 break; 02588 } 02589 02590 ao2_ref(res, -1); 02591 } 02592 02593 iterator->last = res; 02594 02595 return res; 02596 }
Remove a node that was added using ast_data_add_.
[in] | root | The root node of the node to be removed. |
[in] | child | The node pointer to remove. |
Definition at line 2486 of file data.c.
References ao2_unlink, and ast_data::children.
Referenced by agents_data_provider_get(), dahdi_channels_data_provider_get(), dahdi_status_data_provider_get(), data_channels_provider_handler(), data_channeltypes_provider_handler(), data_odbc_provider_handler(), hints_data_provider_get(), meetme_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), users_data_provider_get(), and vm_users_data_provider_get_helper().
02487 { 02488 ao2_unlink(root->children, child); 02489 }
int ast_data_retrieve | ( | struct ast_data * | tree, | |
const char * | path, | |||
struct ast_data_retrieve * | content | |||
) |
Retrieve a value from a node in the tree.
[in] | tree | The structure returned by a call to ast_data_get. |
[in] | path | The path to the node. |
[out] | content | The node content. |
0 | on success. | |
<0 | on error. |
Definition at line 2598 of file data.c.
References ast_data_retrieve::AST_DATA_BOOLEAN, AST_DATA_BOOLEAN, ast_data_retrieve::AST_DATA_CHARACTER, AST_DATA_CHARACTER, AST_DATA_CONTAINER, ast_data_retrieve::AST_DATA_DOUBLE, AST_DATA_DOUBLE, ast_data_retrieve::AST_DATA_INTEGER, AST_DATA_INTEGER, ast_data_retrieve::AST_DATA_IPADDR, AST_DATA_IPADDR, ast_data_retrieve::AST_DATA_MILLISECONDS, AST_DATA_MILLISECONDS, ast_data_retrieve::AST_DATA_PASSWORD, AST_DATA_PASSWORD, ast_data_retrieve::AST_DATA_POINTER, AST_DATA_POINTER, ast_data_retrieve::AST_DATA_SECONDS, AST_DATA_SECONDS, ast_data_retrieve::AST_DATA_STRING, AST_DATA_STRING, ast_data_retrieve::AST_DATA_TIMESTAMP, AST_DATA_TIMESTAMP, ast_data_retrieve::AST_DATA_UNSIGNED_INTEGER, AST_DATA_UNSIGNED_INTEGER, ast_log(), ast_data::boolean, ast_data::character, data_result_get_node(), ast_data::dbl, ast_data::ipaddr, LOG_ERROR, ast_data::payload, ast_data::ptr, ast_data::sint, ast_data::str, ast_data::type, ast_data_retrieve::type, ast_data::uint, and ast_data_retrieve::value.
Referenced by ast_data_retrieve_bool(), ast_data_retrieve_char(), ast_data_retrieve_dbl(), ast_data_retrieve_int(), ast_data_retrieve_ipaddr(), ast_data_retrieve_password(), ast_data_retrieve_ptr(), ast_data_retrieve_string(), and ast_data_retrieve_uint().
02600 { 02601 struct ast_data *node; 02602 02603 if (!content) { 02604 return -1; 02605 } 02606 02607 node = data_result_get_node(tree, path); 02608 if (!node) { 02609 ast_log(LOG_ERROR, "Invalid internal node %s\n", path); 02610 return -1; 02611 } 02612 02613 content->type = node->type; 02614 switch (node->type) { 02615 case AST_DATA_STRING: 02616 content->value.AST_DATA_STRING = node->payload.str; 02617 break; 02618 case AST_DATA_PASSWORD: 02619 content->value.AST_DATA_PASSWORD = node->payload.str; 02620 break; 02621 case AST_DATA_TIMESTAMP: 02622 content->value.AST_DATA_TIMESTAMP = node->payload.uint; 02623 break; 02624 case AST_DATA_SECONDS: 02625 content->value.AST_DATA_SECONDS = node->payload.uint; 02626 break; 02627 case AST_DATA_MILLISECONDS: 02628 content->value.AST_DATA_MILLISECONDS = node->payload.uint; 02629 break; 02630 case AST_DATA_CHARACTER: 02631 content->value.AST_DATA_CHARACTER = node->payload.character; 02632 break; 02633 case AST_DATA_INTEGER: 02634 content->value.AST_DATA_INTEGER = node->payload.sint; 02635 break; 02636 case AST_DATA_UNSIGNED_INTEGER: 02637 content->value.AST_DATA_UNSIGNED_INTEGER = node->payload.uint; 02638 break; 02639 case AST_DATA_BOOLEAN: 02640 content->value.AST_DATA_BOOLEAN = node->payload.boolean; 02641 break; 02642 case AST_DATA_IPADDR: 02643 content->value.AST_DATA_IPADDR = node->payload.ipaddr; 02644 break; 02645 case AST_DATA_DOUBLE: 02646 content->value.AST_DATA_DOUBLE = node->payload.dbl; 02647 break; 02648 case AST_DATA_CONTAINER: 02649 break; 02650 case AST_DATA_POINTER: 02651 content->value.AST_DATA_POINTER = node->payload.ptr; 02652 break; 02653 } 02654 02655 return 0; 02656 }
static unsigned int ast_data_retrieve_bool | ( | struct ast_data * | tree, | |
const char * | path | |||
) | [inline, static] |
Retrieve the boolean value of a node.
[in] | tree | The tree from where to get the value. |
[in] | path | The node name or path. |
Definition at line 703 of file data.h.
References ast_data_retrieve::AST_DATA_BOOLEAN, ast_data_retrieve(), and ast_data_retrieve::value.
00704 { 00705 struct ast_data_retrieve ret; 00706 00707 ast_data_retrieve(tree, path, &ret); 00708 00709 return ret.value.AST_DATA_BOOLEAN; 00710 }
static char ast_data_retrieve_char | ( | struct ast_data * | tree, | |
const char * | path | |||
) | [inline, static] |
Retrieve the character value of a node.
[in] | tree | The tree from where to get the value. |
[in] | path | The node name or path. |
Definition at line 688 of file data.h.
References ast_data_retrieve::AST_DATA_CHARACTER, ast_data_retrieve(), and ast_data_retrieve::value.
00689 { 00690 struct ast_data_retrieve ret; 00691 00692 ast_data_retrieve(tree, path, &ret); 00693 00694 return ret.value.AST_DATA_CHARACTER; 00695 }
static double ast_data_retrieve_dbl | ( | struct ast_data * | tree, | |
const char * | path | |||
) | [inline, static] |
Retrieve the double value of a node.
[in] | tree | The tree from where to get the value. |
[in] | path | The node name or path. |
Definition at line 778 of file data.h.
References ast_data_retrieve::AST_DATA_DOUBLE, ast_data_retrieve(), and ast_data_retrieve::value.
00779 { 00780 struct ast_data_retrieve ret; 00781 00782 ast_data_retrieve(tree, path, &ret); 00783 00784 return ret.value.AST_DATA_DOUBLE; 00785 }
static int ast_data_retrieve_int | ( | struct ast_data * | tree, | |
const char * | path | |||
) | [inline, static] |
Retrieve the integer value of a node.
[in] | tree | The tree from where to get the value. |
[in] | path | The node name or path. |
Definition at line 673 of file data.h.
References ast_data_retrieve::AST_DATA_INTEGER, ast_data_retrieve(), and ast_data_retrieve::value.
00674 { 00675 struct ast_data_retrieve ret; 00676 00677 ast_data_retrieve(tree, path, &ret); 00678 00679 return ret.value.AST_DATA_INTEGER; 00680 }
static struct in_addr ast_data_retrieve_ipaddr | ( | struct ast_data * | tree, | |
const char * | path | |||
) | [static, read] |
Retrieve the ipv4 address value of a node.
[in] | tree | The tree from where to get the value. |
[in] | path | The node name or path. |
Definition at line 793 of file data.h.
References ast_data_retrieve::AST_DATA_IPADDR, ast_data_retrieve(), and ast_data_retrieve::value.
00794 { 00795 struct ast_data_retrieve ret; 00796 00797 ast_data_retrieve(tree, path, &ret); 00798 00799 return ret.value.AST_DATA_IPADDR; 00800 }
char* ast_data_retrieve_name | ( | struct ast_data * | node | ) |
Get the node name.
[in] | node | The node pointer. |
Definition at line 2225 of file data.c.
References ast_data::name.
02226 { 02227 return node->name; 02228 }
static const char* ast_data_retrieve_password | ( | struct ast_data * | tree, | |
const char * | path | |||
) | [inline, static] |
Retrieve the password value of a node.
[in] | tree | The tree from where to get the value. |
[in] | path | The node name or path. |
Definition at line 733 of file data.h.
References ast_data_retrieve::AST_DATA_PASSWORD, ast_data_retrieve(), and ast_data_retrieve::value.
00734 { 00735 struct ast_data_retrieve ret; 00736 00737 ast_data_retrieve(tree, path, &ret); 00738 00739 return ret.value.AST_DATA_PASSWORD; 00740 }
static void* ast_data_retrieve_ptr | ( | struct ast_data * | tree, | |
const char * | path | |||
) | [inline, static] |
Retrieve the ptr value of a node.
[in] | tree | The tree from where to get the value. |
[in] | path | The node name or path. |
Definition at line 763 of file data.h.
References ast_data_retrieve::AST_DATA_POINTER, ast_data_retrieve(), and ast_data_retrieve::value.
00764 { 00765 struct ast_data_retrieve ret; 00766 00767 ast_data_retrieve(tree, path, &ret); 00768 00769 return ret.value.AST_DATA_POINTER; 00770 }
static const char* ast_data_retrieve_string | ( | struct ast_data * | tree, | |
const char * | path | |||
) | [inline, static] |
Retrieve the string value of a node.
[in] | tree | The tree from where to get the value. |
[in] | path | The node name or path. |
Definition at line 748 of file data.h.
References ast_data_retrieve(), ast_data_retrieve::AST_DATA_STRING, and ast_data_retrieve::value.
00749 { 00750 struct ast_data_retrieve ret; 00751 00752 ast_data_retrieve(tree, path, &ret); 00753 00754 return ret.value.AST_DATA_STRING; 00755 }
enum ast_data_type ast_data_retrieve_type | ( | struct ast_data * | res, | |
const char * | path | |||
) |
Get a node type.
[in] | res | A pointer to the ast_data result set. |
[in] | path | A path to the node to get the type. |
Definition at line 2213 of file data.c.
References data_result_get_node().
02214 { 02215 struct ast_data *internal; 02216 02217 internal = data_result_get_node(node, path); 02218 if (!internal) { 02219 return -1; 02220 } 02221 02222 return internal->type; 02223 }
static unsigned int ast_data_retrieve_uint | ( | struct ast_data * | tree, | |
const char * | path | |||
) | [inline, static] |
Retrieve the unsigned integer value of a node.
[in] | tree | The tree from where to get the value. |
[in] | path | The node name or path. |
Definition at line 718 of file data.h.
References ast_data_retrieve(), ast_data_retrieve::AST_DATA_UNSIGNED_INTEGER, and ast_data_retrieve::value.
00719 { 00720 struct ast_data_retrieve ret; 00721 00722 ast_data_retrieve(tree, path, &ret); 00723 00724 return ret.value.AST_DATA_UNSIGNED_INTEGER; 00725 }
int ast_data_search_match | ( | const struct ast_data_search * | search, | |
struct ast_data * | data | |||
) |
Check the current generated node to know if it matches the search condition.
[in] | search | The search condition. |
[in] | data | The AstData node generated. |
Definition at line 1458 of file data.c.
References ao2_container_count(), ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, AST_DATA_BOOLEAN, AST_DATA_CHARACTER, AST_DATA_CONTAINER, AST_DATA_DOUBLE, AST_DATA_INTEGER, AST_DATA_IPADDR, AST_DATA_MILLISECONDS, AST_DATA_PASSWORD, AST_DATA_POINTER, ast_data_search_match(), AST_DATA_SECONDS, AST_DATA_STRING, AST_DATA_TIMESTAMP, AST_DATA_UNSIGNED_INTEGER, ast_data::boolean, ast_data::character, ast_data::children, ast_data_search::children, data_result_find_child(), data_search_cmp_bool(), data_search_cmp_char(), data_search_cmp_int(), data_search_cmp_ipaddr(), data_search_cmp_ptr(), data_search_cmp_string(), data_search_cmp_uint(), data_search_find(), ast_data::dbl, ast_data::ipaddr, ast_data_search::name, ast_data::name, ast_data::payload, ast_data::ptr, ast_data::sint, ast_data::str, ast_data::type, and ast_data::uint.
Referenced by agents_data_provider_get(), ast_data_search_match(), dahdi_channels_data_provider_get(), dahdi_status_data_provider_get(), data_channels_provider_handler(), data_channeltypes_provider_handler(), data_odbc_provider_handler(), hints_data_provider_get(), meetme_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), users_data_provider_get(), and vm_users_data_provider_get_helper().
01459 { 01460 struct ao2_iterator i, ii; 01461 struct ast_data_search *s, *s_child; 01462 struct ast_data *d_child; 01463 int notmatch = 1; 01464 01465 if (!search) { 01466 return 1; 01467 } 01468 01469 s_child = data_search_find(search->children, data->name); 01470 if (!s_child) { 01471 /* nothing to compare */ 01472 ao2_ref(s_child, -1); 01473 return 1; 01474 } 01475 01476 i = ao2_iterator_init(s_child->children, 0); 01477 while ((s = ao2_iterator_next(&i))) { 01478 if (!ao2_container_count(s->children)) { 01479 /* compare this search node with every data node */ 01480 d_child = data_result_find_child(data, s->name); 01481 if (!d_child) { 01482 ao2_ref(s, -1); 01483 notmatch = 1; 01484 continue; 01485 } 01486 01487 switch (d_child->type) { 01488 case AST_DATA_PASSWORD: 01489 case AST_DATA_STRING: 01490 notmatch = data_search_cmp_string(s_child, d_child->name, 01491 d_child->payload.str); 01492 break; 01493 case AST_DATA_CHARACTER: 01494 notmatch = data_search_cmp_char(s_child, d_child->name, 01495 d_child->payload.character); 01496 break; 01497 case AST_DATA_INTEGER: 01498 notmatch = data_search_cmp_int(s_child, d_child->name, 01499 d_child->payload.sint); 01500 break; 01501 case AST_DATA_BOOLEAN: 01502 notmatch = data_search_cmp_bool(s_child, d_child->name, 01503 d_child->payload.boolean); 01504 break; 01505 case AST_DATA_UNSIGNED_INTEGER: 01506 notmatch = data_search_cmp_uint(s_child, d_child->name, 01507 d_child->payload.uint); 01508 break; 01509 case AST_DATA_TIMESTAMP: 01510 case AST_DATA_SECONDS: 01511 case AST_DATA_MILLISECONDS: 01512 case AST_DATA_DOUBLE: 01513 notmatch = data_search_cmp_uint(s_child, d_child->name, 01514 d_child->payload.dbl); 01515 break; 01516 case AST_DATA_IPADDR: 01517 notmatch = data_search_cmp_ipaddr(s_child, d_child->name, 01518 d_child->payload.ipaddr); 01519 break; 01520 case AST_DATA_POINTER: 01521 notmatch = data_search_cmp_ptr(s_child, d_child->name, 01522 d_child->payload.ptr); 01523 break; 01524 case AST_DATA_CONTAINER: 01525 break; 01526 } 01527 ao2_ref(d_child, -1); 01528 } else { 01529 ii = ao2_iterator_init(data->children, 0); 01530 while ((d_child = ao2_iterator_next(&ii))) { 01531 if (strcmp(d_child->name, s->name)) { 01532 ao2_ref(d_child, -1); 01533 continue; 01534 } 01535 if (!(notmatch = !ast_data_search_match(s_child, d_child))) { 01536 /* do not continue if we have a match. */ 01537 ao2_ref(d_child, -1); 01538 break; 01539 } 01540 ao2_ref(d_child, -1); 01541 } 01542 ao2_iterator_destroy(&ii); 01543 } 01544 ao2_ref(s, -1); 01545 if (notmatch) { 01546 /* do not continue if we don't have a match. */ 01547 break; 01548 } 01549 } 01550 ao2_iterator_destroy(&i); 01551 01552 ao2_ref(s_child, -1); 01553 01554 return !notmatch; 01555 }