summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDmitri Pal <dpal@dpal.csb>2009-02-23 10:38:06 -0500
committerDmitri Pal <dpal@dpal.csb>2009-02-23 10:38:06 -0500
commitd986aeb99fa33967374290bf7ce75eab76c6d446 (patch)
treee85af838cd95b43c4f1be5bc2203a1a3474ba589
downloadelapi_draft-d986aeb99fa33967374290bf7ce75eab76c6d446.tar.gz
elapi_draft-d986aeb99fa33967374290bf7ce75eab76c6d446.tar.xz
elapi_draft-d986aeb99fa33967374290bf7ce75eab76c6d446.zip
Initial commit.
-rw-r--r--Makefile.am2
-rwxr-xr-xbuild.sh55
-rw-r--r--collection/Makefile.am6
-rw-r--r--collection/elapi_collection.c1590
-rw-r--r--collection/elapi_collection.h196
-rw-r--r--collection/elapi_collection_ut.c522
-rw-r--r--collection/elapi_util.c499
-rw-r--r--collection/elapi_util.h76
-rw-r--r--configure.ac13
-rw-r--r--dispatcher/elapi_dispatcher.c688
-rw-r--r--dispatcher/elapi_dispatcher.h68
-rw-r--r--dispatcher/elapi_dispatcher_ut.c201
-rw-r--r--etc/syslog_defaults.conf0
-rw-r--r--ini/elapi.conf41
-rw-r--r--ini/elapi.d/test.conf41
-rw-r--r--ini/elapi_ini.c626
-rw-r--r--ini/elapi_ini.h30
-rwxr-xr-xini/elapi_ini_utbin0 -> 7392 bytes
-rw-r--r--ini/elapi_ini_ut.c23
-rw-r--r--sinks/Makefile.am1
-rw-r--r--sinks/elapi_sink.h56
-rw-r--r--sinks/file/elapi_sink_file.c268
-rw-r--r--sinks/stderr/elapi_sink_stderr.c135
-rw-r--r--sinks/syslog/elapi_sink_syslog.c287
-rw-r--r--tools/Makefile.am3
-rw-r--r--tools/elapi_tools.c192
-rw-r--r--tools/elapi_tools.h27
-rw-r--r--util/elapi_debug.h35
28 files changed, 5681 insertions, 0 deletions
diff --git a/Makefile.am b/Makefile.am
new file mode 100644
index 0000000..3d99c97
--- /dev/null
+++ b/Makefile.am
@@ -0,0 +1,2 @@
+#SUBDIRS = collection dispatcher ini tools sinks
+SUBDIRS = tools collection
diff --git a/build.sh b/build.sh
new file mode 100755
index 0000000..cabd7d6
--- /dev/null
+++ b/build.sh
@@ -0,0 +1,55 @@
+#!/bin/sh -x
+
+cd ~/IPA/Code/elapi
+
+cd tools
+make -f elapi_tools.mak clean
+make -f elapi_tools.mak
+ret="$?"
+echo $ret
+if [ "$ret" != "0" ]; then echo "Exiting"; exit 1; fi
+cd ..
+
+
+cd collection
+make -f elapi_collection.mak clean
+make -f elapi_collection.mak
+ret="$?"
+echo $ret
+if [ "$ret" != "0" ]; then echo "Exiting"; exit 1; fi
+cd ..
+
+
+cd sinks
+cd stderr
+make -f elapi_sink_stderr.mak clean
+make -f elapi_sink_stderr.mak
+ret="$?"
+echo $ret
+if [ "$ret" != "0" ]; then echo "Exiting"; exit 1; fi
+cd ..
+cd syslog
+make -f elapi_sink_syslog.mak clean
+make -f elapi_sink_syslog.mak
+ret="$?"
+echo $ret
+if [ "$ret" != "0" ]; then echo "Exiting"; exit 1; fi
+cd ..
+cd ..
+
+cd dispatcher
+make -f elapi_dispatcher.mak clean
+make -f elapi_dispatcher.mak
+ret="$?"
+echo $ret
+if [ "$ret" != "0" ]; then echo "Exiting"; exit 1; fi
+cd ..
+
+
+cd ini
+make -f elapi_ini.mak clean
+make -f elapi_ini.mak
+ret="$?"
+echo $ret
+if [ "$ret" != "0" ]; then echo "Exiting"; exit 1; fi
+cd ..
diff --git a/collection/Makefile.am b/collection/Makefile.am
new file mode 100644
index 0000000..6c33534
--- /dev/null
+++ b/collection/Makefile.am
@@ -0,0 +1,6 @@
+lib_LIBRARIES = libelapi_collection.a
+libelapi_collection_a_SOURCES = elapi_collection.c elapi_util.c
+
+noinst_PROGRAMS = elapi_collection_ut
+elapi_collection_ut_SOURCES = elapi_collection_ut.c
+elapi_collection_ut_LDADD = libelapi_collection.a -lm -lz -lxml2 libelapi_tools.a
diff --git a/collection/elapi_collection.c b/collection/elapi_collection.c
new file mode 100644
index 0000000..2654edd
--- /dev/null
+++ b/collection/elapi_collection.c
@@ -0,0 +1,1590 @@
+/* Copyright */
+
+#define _GNU_SOURCE
+#include <string.h>
+#include <stdlib.h>
+#include <errno.h>
+#include <ctype.h>
+#include "elapi_collection.h"
+#include "elapi_debug.h"
+
+/* Internal constants defined to denote actions that can be performed by find handler */
+#define ELAPI_ACTION_FIND 1
+#define ELAPI_ACTION_DEL 2
+#define ELAPI_ACTION_UPDATE 3
+
+
+/* Special internal error code to indicate that collection search was interrupted */
+#define EINTR_INTERNAL 10000
+
+/* Struct used for passing parameter for update operation */
+struct update_property {
+ int type;
+ void *data;
+ int length;
+ int found;
+};
+
+
+/******************** FUNCTION DECLARATIONS ****************************/
+
+/* Have to declare those due to function cross referencing */
+static int find_item_and_do(struct collection_item *ci,
+ char *property_to_find,
+ int type,
+ int mode_flags,
+ item_fn item_handler,
+ void *custom_data,
+ int action);
+
+/* Traverse callback for find & delete function */
+static int act_traverse_handler(struct collection_item *head,
+ struct collection_item *previous,
+ struct collection_item *current,
+ void *passed_traverse_data,
+ item_fn user_item_handler,
+ void *custom_data,
+ int *stop);
+
+/* Traverse callback signature */
+typedef int (*internal_item_fn)(struct collection_item *head,
+ struct collection_item *previous,
+ struct collection_item *current,
+ void *traverse_data,
+ item_fn user_item_handler,
+ void *custom_data,
+ int *stop);
+
+/******************** SUPPLIMENTARY FUNCTIONS ****************************/
+
+
+/* BASIC OPERATIONS */
+/* Function that checks if property can be added */
+static int validate_property(char *property)
+{
+ DEBUG_STRING("validate_property","Entry point.");
+ /* Only alpha numeric characters are allowed in names of the properties */
+ int invalid = 0;
+ char *check;
+
+ check = property;
+ while(*check != '\0') {
+ if((!isalnum((int)(*check))) && (*check!='_')) {
+ invalid = 1;
+ break;
+ }
+ check++;
+ }
+ DEBUG_NUMBER("validate_property. Returning ",invalid);
+ return invalid;
+}
+
+
+
+/* Function that cleans the item */
+static void delete_item(struct collection_item *item)
+{
+ DEBUG_STRING("delete_item","Entry point.");
+
+ if(item == (struct collection_item *)NULL) return;
+
+ if(item->property != NULL) free(item->property);
+ if(item->data != NULL) free(item->data);
+
+ free(item);
+
+ DEBUG_STRING("delete_item","Exit.");
+}
+
+/* A generic function to allocate a property item */
+static int allocate_item(struct collection_item **ci,char *property,void *item_data,int length, int type)
+{
+ struct collection_item *item = NULL;
+ int error = 0;
+ errno = 0;
+
+ DEBUG_STRING("allocate_item","Entry point.");
+ DEBUG_NUMBER("Will be using type:",type);
+
+ /* Check the length */
+ if(length >= ELAPI_MAX_DATA) {
+ DEBUG_STRING("allocate_item","Data to long.");
+ return EMSGSIZE;
+ }
+
+ if(validate_property(property)) {
+ DEBUG_STRING("Invalid chracters in the property name",property);
+ return EINVAL;
+ }
+
+ /* Allocate memory for the structure */
+ item = (struct collection_item *)(malloc(sizeof(struct collection_item)));
+ if(item == (struct collection_item *)(NULL)) {
+ error = errno;
+ DEBUG_STRING("allocate_item","Malloc failed.");
+ return error;
+ }
+
+ /* After we initialize "next" we can use delete_item() in case of error */
+ item->next = (struct collection_item *)(NULL);
+
+ /* Copy property */
+ item->property = strdup(property);
+ if(item->property == NULL) {
+ error = errno;
+ DEBUG_STRING("allocate_item","Failed to dup property.");
+ delete_item(item);
+ return error;
+ }
+
+ item->property_len = strlen(item->property);
+
+ /* Deal with data */
+ item->data = malloc(length);
+ if(item->data == NULL) {
+ DEBUG_STRING("allocate_item","Failed to dup data.");
+ delete_item(item);
+ return errno;
+ }
+ memcpy(item->data,item_data,length);
+
+ /* Deal with other properties of the item */
+ DEBUG_NUMBER("About to set type to:",type);
+ item->type = type;
+ item->length = length;
+
+ /* Make sure that data is NULL terminated in case of string */
+ if(type == ELAPI_TYPE_STRING) *(((char *)(item->data))+length-1) = '\0';
+
+ *ci = item;
+
+ DEBUG_STRING("Item property",item->property);
+ DEBUG_NUMBER("Item property type",item->type);
+ DEBUG_NUMBER("Item data length",item->length);
+ DEBUG_STRING("allocate_item","Success exit.");
+ return 0;
+}
+
+/* Add item to the end of collection */
+/* Can add itself to itself - nice...*/
+static int add_item_to_collection(struct collection_item *collection,struct collection_item *item)
+{
+ struct collection_header *header;
+
+ DEBUG_STRING("add_item_to_collection","Entry point.");
+
+ if(collection == (struct collection_item *)(NULL)) {
+ DEBUG_STRING("add_item_to_collection","Collection accepting is NULL");
+ if((item != (struct collection_item *)(NULL)) &&
+ (item->type == ELAPI_TYPE_COLLECTION)) {
+ /* This is a special case of self creation */
+ DEBUG_STRING("add_item_to_collection","Adding header item to new collection.");
+ collection = item;
+ }
+ }
+
+ /* We can add items only to collections */
+ if(collection->type != ELAPI_TYPE_COLLECTION) {
+ DEBUG_STRING("add_item_to_collection","Attempt to add item to non collection.");
+ DEBUG_STRING("Collection name:",collection->property);
+ DEBUG_NUMBER("Collection type:",collection->type);
+ return EINVAL;
+ }
+
+ header = (struct collection_header *)(collection->data);
+
+ /* Link new item to the last item in the list if there any */
+ if(header->last != (struct collection_item *)(NULL)) {
+ (header->last)->next = item;
+ }
+
+ /* Make sure we save a new last element */
+ header->last = item;
+ header->count++;
+
+ DEBUG_STRING("Collection:",collection->property);
+ DEBUG_STRING("Just added item is:",item->property);
+ DEBUG_NUMBER("Item type.",item->type);
+ DEBUG_NUMBER("Number of items in collection now is.",header->count);
+
+ DEBUG_STRING("add_item_to_collection","Success exit.");
+ return EOK;
+}
+
+
+/* TRAVERSE HANDLERS */
+
+/* Special handler to just set a flag if the item is found */
+static int is_in_item_handler(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *found,
+ int *dummy)
+{
+ DEBUG_STRING("is_in_item_handler","Entry.");
+ DEBUG_STRING("Property:",property);
+ DEBUG_NUMBER("Property length:",property_len);
+ DEBUG_NUMBER("Type:",type);
+ DEBUG_NUMBER("Length:",length);
+
+ *((int *)(found)) = ELAPI_MATCH;
+
+ DEBUG_STRING("is_in_item_handler","Success Exit.");
+
+ return EOK;
+}
+
+/* Special handler to retrieve the sub collection */
+static int get_subcollection(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *found,
+ int *dummy)
+{
+ DEBUG_STRING("get_subcollection","Entry.");
+ DEBUG_STRING("Property:",property);
+ DEBUG_NUMBER("Property length:",property_len);
+ DEBUG_NUMBER("Type:",type);
+ DEBUG_NUMBER("Length:",length);
+
+ *((struct collection_item **)(found)) = *((struct collection_item **)(data));
+
+ DEBUG_STRING("get_subcollection","Success Exit.");
+
+ return EOK;
+
+}
+
+
+/* ADD PROPERTY */
+
+/* Add a single property to a collection. Returns a pointer to a newly allocated property */
+static struct collection_item *add_property(struct collection_item *collection,
+ char *subcollection,
+ char *property,
+ void *item_data,
+ int length,
+ int type,
+ int *error)
+{
+ struct collection_item *item;
+ struct collection_item *acceptor = (struct collection_item *)(NULL);
+
+ DEBUG_STRING("add_property","Entry.");
+ /* Allocate item */
+
+ DEBUG_NUMBER("Property type to add",type);
+ *error = allocate_item(&item,property,item_data,length, type);
+ if(*error) return (struct collection_item *)(NULL);
+
+ DEBUG_STRING("Created item:",item->property);
+ DEBUG_NUMBER("Item has type:",item->type);
+
+ /* Add item to collection */
+ if(subcollection == NULL) acceptor = collection;
+ else {
+ DEBUG_STRING("Subcollection id not null, searching",subcollection);
+ *error = find_item_and_do(collection, subcollection, ELAPI_TYPE_COLLECTIONREF,
+ ELAPI_TRAVERSE_DEFAULT,
+ get_subcollection,(void *)(&acceptor),ELAPI_ACTION_FIND);
+ if(*error) {
+ DEBUG_NUMBER("Search for subcollection returned error:",*error);
+ delete_item(item);
+ return (struct collection_item *)(NULL);
+ }
+
+ if(acceptor == (struct collection_item *)(NULL)) {
+ DEBUG_STRING("Search for subcollection returned NULL pointer","");
+ delete_item(item);
+ *error=ENOENT;
+ return (struct collection_item *)(NULL);
+ }
+
+ }
+ *error = add_item_to_collection(acceptor,item);
+ if(*error) {
+ delete_item(item);
+ return (struct collection_item *)(NULL);
+ }
+
+ DEBUG_STRING("add_property","Success Exit.");
+ return item;
+}
+
+/* CLEANUP */
+
+/* Cleans the collection tree including current item. */
+/* After the execution passed in variable should not be used - memory is gone!!! */
+static void delete_collection(struct collection_item *ci)
+{
+ struct collection_item *other_collection;
+
+ DEBUG_STRING("delete_collection","Entry.");
+
+ if(ci == (struct collection_item *)(NULL)) {
+ DEBUG_STRING("delete_collection","Nothing to do Exit.");
+ return;
+ }
+
+ DEBUG_STRING("Real work to do","");
+
+ delete_collection(ci->next);
+
+ /* Handle external or embedded collection */
+ if(ci->type == ELAPI_TYPE_COLLECTIONREF) {
+ /* Our data is a pointer to a whole external collection so dereference it or delete */
+ other_collection = *((struct collection_item **)(ci->data));
+ destroy_collection(other_collection);
+ }
+
+ /* Delete this item */
+ delete_item(ci);
+ DEBUG_STRING("delete_collection","Exit.");
+}
+
+
+/* NAME MANAGEMENT - used by search */
+
+/* Internal data structures used for search */
+
+struct path_data {
+ char *name;
+ int length;
+ struct path_data *previous_path;
+};
+
+struct find_name {
+ char *name_to_find;
+ int name_len_to_find;
+ int type_to_match;
+ char *given_name;
+ int given_len;
+ struct path_data *current_path;
+ int action;
+};
+
+/* Create a new name */
+static int create_path_data(struct path_data **name_path,
+ char *name, int length,
+ char *property, int property_len)
+{
+ int error = EOK;
+ struct path_data *new_name_path;
+
+ DEBUG_STRING("create_path_data","Entry.");
+
+ DEBUG_STRING("Constructing path from name:",name);
+ DEBUG_STRING("Constructing path from property:",property);
+
+ /* Allocate structure */
+ errno = 0;
+ new_name_path = (struct path_data *)(malloc(sizeof(struct path_data)));
+ if(new_name_path == (struct path_data *)(NULL)) return errno;
+
+ new_name_path->name=malloc(length+property_len+2);
+ if(new_name_path->name == NULL) {
+ error = errno;
+ DEBUG_NUMBER("Failed to allocate memory for new path name. Errno",error);
+ free((void *)(new_name_path));
+ return error;
+ }
+
+ /* Construct the new name */
+ new_name_path->length = 0;
+
+ if(length > 0) {
+ memcpy(new_name_path->name,name,length);
+ new_name_path->length = length;
+ *(new_name_path->name+new_name_path->length) = '.';
+ new_name_path->length++;
+ *(new_name_path->name+new_name_path->length) = '\0';
+ DEBUG_STRING("Name so far:",new_name_path->name);
+ DEBUG_NUMBER("Len so far:",new_name_path->length);
+ }
+ memcpy(new_name_path->name+new_name_path->length,property,property_len);
+ new_name_path->length += property_len;
+ *(new_name_path->name + new_name_path->length) = '\0';
+
+ /* Link to the chain */
+ new_name_path->previous_path = *name_path;
+ *name_path = new_name_path;
+
+ DEBUG_STRING("Constructed path",new_name_path->name);
+
+
+ DEBUG_NUMBER("create_path_data. Returning:",error);
+ return error;
+}
+
+/* Matching item name and type */
+static int match_item(struct collection_item *current,
+ struct find_name *traverse_data)
+{
+
+ char *find_str;
+ char *start;
+ char *data_str;
+
+ DEBUG_STRING("match_item","Entry");
+
+ if(traverse_data->type_to_match & current->type) {
+ /* Check if there is any value to match */
+ if((traverse_data->name_to_find == NULL) ||
+ (*(traverse_data->name_to_find) == '\0')) {
+ DEBUG_STRING("match_item","Returning MATCH because there is no search criteria!");
+ return ELAPI_MATCH;
+ }
+
+ /* Start comparing the two strings from the end */
+ find_str = traverse_data->name_to_find + traverse_data->name_len_to_find;
+ start = current->property;
+ data_str = start + current->property_len;
+
+ DEBUG_STRING("Searching for:",traverse_data->name_to_find);
+ DEBUG_STRING("Item name:",current->property);
+ DEBUG_STRING("Current path:",traverse_data->current_path->name);
+ DEBUG_NUMBER("Searching:",toupper(*find_str));
+ DEBUG_NUMBER("Have:",toupper(*data_str));
+
+ /* We start pointing to 0 so the loop will be executed at least once */
+ while(toupper(*data_str) == toupper(*find_str)) {
+
+ DEBUG_STRING("Loop iteration:","");
+
+ if(data_str == start) {
+ if(find_str > traverse_data->name_to_find) {
+ if(*(find_str-1) == '.') {
+ /* We matched the property but the search string is longer */
+ /* so we need to continue matching */
+ DEBUG_STRING("match_item","Need to continue matching");
+ start = traverse_data->current_path->name;
+ data_str = start + traverse_data->current_path->length - 1;
+ find_str-=2;
+ continue;
+ }
+ else {
+ DEBUG_STRING("match_item","Returning NO match!");
+ return ELAPI_NOMATCH;
+ }
+ }
+ else {
+ DEBUG_STRING("match_item","Returning MATCH!");
+ return ELAPI_MATCH;
+ }
+ }
+ else if((find_str == traverse_data->name_to_find) &&
+ (*(data_str-1) == '.')) return ELAPI_MATCH;
+
+ data_str--;
+ find_str--;
+ DEBUG_NUMBER("Searching:",toupper(*find_str));
+ DEBUG_NUMBER("Have:",toupper(*data_str));
+
+ }
+ }
+
+ DEBUG_STRING("match_item","Returning NO match!");
+ return ELAPI_NOMATCH;
+
+}
+
+/* Function to delete the data that contains search path */
+static void delete_path_data(struct path_data *path)
+{
+ DEBUG_STRING("delete_path_data","Entry.");
+
+ if(path!= (struct path_data *)(NULL)) {
+ DEBUG_STRING("delete_path_data","Item to delete exits.");
+ if(path->previous_path != (struct path_data *)(NULL)) {
+ DEBUG_STRING("delete_path_data","But previous item to delete exits to. Nesting.");
+ delete_path_data(path->previous_path);
+ }
+ if(path->name != NULL) {
+ DEBUG_STRING("delete_path_data Deleting path:",path->name);
+ free(path->name);
+ }
+ DEBUG_STRING("delete_path_data","Deleting path element");
+ free((void *)(path));
+ }
+ DEBUG_STRING("delete_path_data","Exit");
+}
+
+
+/* MAIN TRAVERSAL FUNCTION */
+
+/* Internal function to walk collection */
+/* For each item walked it will call traverse handler.
+ Traverse handler accepts: current item,
+ user provided item handler and user provided custom data. */
+/* See below defferent traverse handlers for different cases */
+static int walk_items(struct collection_item *ci,
+ int mode_flags,
+ internal_item_fn traverse_handler,
+ void *traverse_data,
+ item_fn user_item_handler,
+ void *custom_data) {
+
+ struct collection_item *current;
+ struct collection_item *parent;
+ struct collection_item *sub;
+ int stop = 0;
+ int error = EOK;
+
+ DEBUG_STRING("walk_items","Entry.");
+ DEBUG_NUMBER("Mode flags:",mode_flags);
+
+ current = ci;
+
+ while(current != (struct collection_item *)(NULL)) {
+
+ DEBUG_STRING("Processing item:",current->property);
+ DEBUG_NUMBER("Item type:",current->type);
+
+ if(current->type == ELAPI_TYPE_COLLECTIONREF) {
+
+ DEBUG_STRING("Subcollection:",current->property);
+
+ if((mode_flags & ELAPI_TRAVERSE_IGNORE) == 0) {
+
+ DEBUG_STRING("Subcollection is not ignored.","");
+
+ /* We are not ignoring sub collections */
+ error = traverse_handler(ci,parent,current,traverse_data,user_item_handler,custom_data,&stop);
+ if(stop != 0) {
+ DEBUG_STRING("Traverse handler returned STOP.","");
+ error = EINTR_INTERNAL;
+ }
+ if(error) {
+ DEBUG_NUMBER("Traverse handler returned error.",error);
+ return error;
+ }
+
+ if((mode_flags & ELAPI_TRAVERSE_ONELEVEL) == 0) {
+ DEBUG_STRING("Before diving into sub collection","");
+ sub = *((struct collection_item **)(current->data));
+ DEBUG_STRING("Sub collection name",sub->property);
+ DEBUG_NUMBER("Header type",sub->type);
+ /* We need to go into sub collections */
+ error = walk_items(sub, mode_flags,traverse_handler,traverse_data,
+ user_item_handler, custom_data);
+ DEBUG_STRING("Returned from sub collection processing","");
+ DEBUG_STRING("Done processing item:",current->property);
+ DEBUG_NUMBER("Done processing item type:",current->type);
+
+ }
+ }
+ }
+ else
+ /* Call handler then move on */
+ error = traverse_handler(ci,parent,current,traverse_data,user_item_handler,custom_data,&stop);
+
+ /* If we are stopped - return EINTR_INTERNAL */
+ if(stop != 0) {
+ DEBUG_STRING("Traverse handler returned STOP.","");
+ error = EINTR_INTERNAL;
+ }
+ if(error) {
+ DEBUG_NUMBER("Traverse handler returned error.",error);
+ return error;
+ }
+
+ parent = current;
+ current = current->next;
+
+ }
+
+ DEBUG_STRING("Out of loop","");
+
+ if((mode_flags & ELAPI_TRAVERSE_END) != 0) {
+ DEBUG_STRING("About to do the special end collection invocation of handler","");
+ error = traverse_handler(ci,parent,current,traverse_data,user_item_handler,custom_data,&stop);
+ }
+
+ DEBUG_NUMBER("walk_items. Returns: ",error);
+ return error;
+}
+
+
+/* ACTION */
+
+/* Find an item by property name and perform an action on it. */
+/* No pattern matching supported in the first implementation. */
+/* To refer to child properties use dotted notatation like this: */
+/* parent.child.subchild.subsubchild etc. */
+static int find_item_and_do(struct collection_item *ci,
+ char *property_to_find,
+ int type,
+ int mode_flags,
+ item_fn item_handler,
+ void *custom_data,
+ int action)
+{
+
+ int error = EOK;
+ struct find_name *traverse_data = NULL;
+
+ DEBUG_STRING("find_item_and_do","Entry.");
+
+ /* Item handler is always required */
+ if((item_handler == (item_fn)(NULL)) && (action ==ELAPI_ACTION_FIND)) {
+ DEBUG_NUMBER("No item handler - returning error!",EINVAL);
+ return EINVAL;
+ }
+
+ /* Make sure that there is anything to search */
+ type &= ELAPI_TYPE_ANY;
+ if((ci == (struct collection_item *)(NULL)) ||
+ ((property_to_find == NULL) && (type == 0)) ||
+ ((*property_to_find == '\0') && (type == 0))) {
+ DEBUG_NUMBER("No item search criteria specified - returning error!",ENOKEY);
+ return ENOKEY;
+ }
+ /* Prepare data for traversal */
+ errno = 0;
+ traverse_data= (struct find_name *)(malloc(sizeof(struct find_name)));
+ if(traverse_data == (struct find_name *)(NULL)) {
+ error = errno;
+ DEBUG_NUMBER("Failed to allocate traverse data memory - returning error!",errno);
+ return error;
+ }
+
+ DEBUG_STRING("find_item_and_do","Filling in traverse data.");
+
+ traverse_data->name_to_find = property_to_find;
+ traverse_data->name_len_to_find = strlen(property_to_find);
+ traverse_data->type_to_match = type;
+ traverse_data->given_name = NULL;
+ traverse_data->given_len = 0;
+ traverse_data->current_path = (struct path_data *)(NULL);
+ traverse_data->action = action;
+
+ mode_flags |= ELAPI_TRAVERSE_END;
+
+ DEBUG_STRING("find_item_and_do","About to walk the tree.");
+ DEBUG_NUMBER("Traverse flags",mode_flags);
+
+ error = walk_items(ci, mode_flags, act_traverse_handler,
+ (void *)traverse_data, item_handler, custom_data);
+
+ if(traverse_data->current_path != (struct path_data *)(NULL)) {
+ DEBUG_STRING("find_item_and_do","Path was not cleared - deleting");
+ delete_path_data(traverse_data->current_path);
+ }
+
+ free((void *)(traverse_data));
+
+ if(error != EINTR_INTERNAL) {
+ DEBUG_NUMBER("Walk items returned error. Returning: ",error);
+ return error;
+ }
+ else {
+ DEBUG_STRING("Walk items returned SUCCESS.","");
+ return EOK;
+ }
+}
+
+/* Function to replace data in the item */
+static int update_item(struct collection_item *current,
+ struct update_property *update_data)
+{
+ int error = EOK;
+ DEBUG_STRING("update_item","Entry");
+
+ /* If type is different or samew but it is string or binary we need to replace the storage */
+ if((current->type != update_data->type) ||
+ ((current->type == update_data->type) &&
+ ((current->type != ELAPI_TYPE_STRING) || (current->type != ELAPI_TYPE_BINARY)))) {
+ DEBUG_STRING("Replacing item data buffer","");
+ free(current->data);
+ current->data = malloc(update_data->length);
+ if(current->data == NULL) {
+ error = errno;
+ DEBUG_STRING("Failed to allocate memory","");
+ return error;
+ }
+ current->length = update_data->length;
+ }
+
+ DEBUG_STRING("Overwriting item data","");
+ memcpy(current->data,update_data->data,current->length);
+ current->type = update_data->type;
+
+ if(current->type == ELAPI_TYPE_STRING) *(((char *)(current->data))+current->length-1) = '\0';
+
+
+ DEBUG_STRING("update_item","Exit");
+ return EOK;
+}
+
+
+/* TRAVERSE CALLBACKS */
+
+/* Traverse handler for simple traverse function */
+/* Handler must be able to deal with NULL current item */
+static int simple_traverse_handler(struct collection_item *head,
+ struct collection_item *previous,
+ struct collection_item *current,
+ void *traverse_data,
+ item_fn user_item_handler,
+ void *custom_data,
+ int *stop)
+{
+ int error = EOK;
+
+ DEBUG_STRING("simple_traverse_handler","Entry.");
+
+ if(current != (struct collection_item *)(NULL))
+ error = user_item_handler(current->property,
+ current->property_len,
+ current->type,
+ current->data,
+ current->length,
+ custom_data,
+ stop);
+ else
+ error = user_item_handler("",
+ 0,
+ ELAPI_TYPE_END,
+ NULL,
+ 0,
+ custom_data,
+ stop);
+
+ DEBUG_NUMBER("simple_traverse_handler. Returning:",error);
+ return error;
+}
+
+
+/* Traverse callback for find & delete function */
+static int act_traverse_handler(struct collection_item *head,
+ struct collection_item *previous,
+ struct collection_item *current,
+ void *passed_traverse_data,
+ item_fn user_item_handler,
+ void *custom_data,
+ int *stop)
+{
+ int error = EOK;
+ struct find_name *traverse_data = NULL;
+ char *name;
+ int length;
+ struct path_data *temp;
+ struct collection_header *header;
+ struct collection_item *other;
+ char *property;
+ int property_len;
+ struct update_property *update_data;
+
+ DEBUG_STRING("act_traverse_handler","Entry.");
+
+ traverse_data = (struct find_name *)(passed_traverse_data);
+
+ /* We can be called when current points to NULL */
+ if(current==(struct collection_item *)(NULL)) {
+ DEBUG_STRING("act_traverse_handler","Special call at the end of the collection.");
+ temp = traverse_data->current_path;
+ traverse_data->current_path = temp->previous_path;
+ temp->previous_path = (struct path_data *)(NULL);
+ delete_path_data(temp);
+ traverse_data->given_name = NULL;
+ traverse_data->given_len = 0;
+ DEBUG_NUMBER("Handling end of collection - removed path. Returning:", error);
+ return error;
+ }
+
+ /* Create new path at the beginning of a new sub collection */
+ if(current->type == ELAPI_TYPE_COLLECTION) {
+
+ DEBUG_STRING("act_traverse_handler","Processing collection handle.");
+
+ /* Create new path */
+ if(traverse_data->current_path != (struct path_data *)(NULL)) {
+ DEBUG_STRING("Already have part of the path","");
+ name = (traverse_data->current_path)->name;
+ length = (traverse_data->current_path)->length;
+ DEBUG_STRING("Path:",name);
+ DEBUG_NUMBER("Path len:",length);
+ }
+ else {
+ name = NULL;
+ length = 0;
+ }
+
+ if(traverse_data->given_name != NULL) {
+ property = traverse_data->given_name;
+ property_len = traverse_data->given_len;
+ }
+ else {
+ property = current->property;
+ property_len = current->property_len;
+ }
+
+ DEBUG_STRING("act_traverse_handler","About to create path data.");
+
+ error = create_path_data(&(traverse_data->current_path),
+ name, length, property,property_len);
+
+ DEBUG_NUMBER("create_path_data returned:", error);
+ return error;
+ }
+
+ /* Handle the collection pointers */
+ if(current->type == ELAPI_TYPE_COLLECTIONREF) {
+ traverse_data->given_name = current->property;
+ traverse_data->given_len = current->property_len;
+ DEBUG_STRING("Saved given name:",traverse_data->given_name);
+ }
+
+ DEBUG_STRING("Processing item with property:",current->property);
+
+ /* Do here what we do with items */
+ if(match_item(current,traverse_data)) {
+ DEBUG_STRING("Matched item:",current->property);
+ switch(traverse_data->action) {
+ case ELAPI_ACTION_FIND:
+ DEBUG_STRING("It is a find action - calling handler.","");
+ if(user_item_handler != (item_fn)(NULL)) {
+ /* Call user handler */
+ error = user_item_handler(current->property,
+ current->property_len,
+ current->type,
+ current->data,
+ current->length,
+ custom_data,
+ stop);
+
+ DEBUG_NUMBER("Handler returned:",error);
+ DEBUG_NUMBER("Handler set STOP to:",*stop);
+
+ }
+ break;
+ case ELAPI_ACTION_DEL:
+ DEBUG_STRING("It is a delete action.","");
+ /* Make sure we tell the caller we found a match */
+ if(custom_data != NULL) *(int *)(custom_data) = ELAPI_MATCH;
+ /* Dereference external collections */
+ if(current->type == ELAPI_TYPE_COLLECTIONREF) {
+ DEBUG_STRING("Dereferencing a referenced collection.","");
+ other = *((struct collection_item **)(current->data));
+ header = (struct collection_header *)(other->data);
+ destroy_collection(other);
+ }
+
+ /* Adjust header of the collection */
+ header = (struct collection_header *)(head->data);
+ (header->count)--;
+ if(current->next == (struct collection_item *)(NULL)) header->last = previous;
+
+ /* Unlink and delete iteam */
+ /* Previous can't be NULL here becuase we never delete header elements */
+ previous->next = current->next;
+ delete_item(current);
+ DEBUG_STRING("Did the delete of the item.","");
+ break;
+ case ELAPI_ACTION_UPDATE:
+ DEBUG_STRING("It is an update action.","");
+ if((current->type == ELAPI_TYPE_COLLECTION) ||
+ (current->type == ELAPI_TYPE_COLLECTIONREF)) {
+ DEBUG_STRING("Can't update collections it is an error for now","");
+ return EINVAL;
+ }
+
+ /* Make sure we tell the caller we found a match */
+ if(custom_data != NULL) {
+ update_data = (struct update_property *) custom_data;
+ update_data-> found = ELAPI_MATCH;
+ error = update_item(current, update_data);
+ }
+ else {
+ DEBUG_STRING("Error - update data is required","");
+ return EINVAL;
+ }
+
+ DEBUG_STRING("Did the delete of the item.","");
+ break;
+ default:
+ break;
+ }
+ /* Force interrupt if we found */
+ *stop = 1;
+ }
+
+ DEBUG_NUMBER("act_traverse_handler returning",error);
+ return error;
+}
+
+
+/* Traverse handler for copy function */
+static int copy_traverse_handler(struct collection_item *head,
+ struct collection_item *previous,
+ struct collection_item *current,
+ void *passed_traverse_data,
+ item_fn user_item_handler,
+ void *custom_data,
+ int *stop)
+{
+ int error = EOK;
+ struct collection_item *parent;
+ struct collection_item *item;
+ struct collection_item *new_collection = (struct collection_item *)(NULL);
+
+ DEBUG_STRING("copy_traverse_handler","Entry.");
+
+ parent = (struct collection_item *)(passed_traverse_data);
+
+ /* Skip current element but rather work with next if it is not NULL */
+ item = current->next;
+ if(item == (struct collection_item *)(NULL)) return error;
+
+
+ /* Check if this is a special case of sub collection */
+ if(item->type == ELAPI_TYPE_COLLECTIONREF) {
+ DEBUG_STRING("Found a subcollection we need to copy. Name:",item->property);
+
+ error = copy_collection(&new_collection,
+ *((struct collection_item **)(item->data)),
+ item->property);
+ if(error) {
+ DEBUG_NUMBER("Copy subcollection returned error:",error);
+ return error;
+ }
+
+ /* Add new item to a collection - all references are now sub collections */
+ (void)add_property(parent,NULL,item->property,(void *)(&new_collection),
+ sizeof(struct collection_item **),
+ ELAPI_TYPE_COLLECTIONREF, &error);
+ if(error) {
+ DEBUG_NUMBER("Add property returned error:",error);
+ return error;
+ }
+ }
+ else {
+ (void)add_property(parent,NULL,item->property,item->data,
+ item->length,item->type,&error);
+ if(error) {
+ DEBUG_NUMBER("Add property returned error:",error);
+ return error;
+ }
+ }
+
+ DEBUG_NUMBER("copy_traverse_handler returning",error);
+ return error;
+}
+
+
+
+/********************* MAIN INTERFACE FUNCTIONS ***********************************/
+
+
+/* CREATE */
+
+/* Function that creates a named collection */
+int create_collection(struct collection_item **ci,char *name)
+{
+ struct collection_item *handle = (struct collection_item *)(NULL);
+ struct collection_header header;
+ int error=EOK;
+
+ DEBUG_STRING("create_collection","Entry.");
+
+ /* Prepare header */
+ header.last = (struct collection_item *)(NULL);
+ header.reference_count = 1;
+ header.count = 0;
+
+ /* Create a collection type property */
+ handle = add_property((struct collection_item *)(NULL),NULL,name,&header,sizeof(header), ELAPI_TYPE_COLLECTION, &error);
+ if(error) return error;
+
+ *ci = handle;
+
+ DEBUG_STRING("create_collection","Success Exit.");
+ return 0;
+}
+
+/* DESTROY */
+
+/* Function that destroys a collection */
+void destroy_collection(struct collection_item *ci)
+{
+ struct collection_header *header;
+
+ DEBUG_STRING("destroy_collection","Entry.");
+
+ /* Do not try to delete NULL */
+ if(ci == (struct collection_item *)(NULL)) return;
+
+ /* You can delete only whole collection not a part of it */
+ if(ci->type != ELAPI_TYPE_COLLECTION) {
+ DEBUG_STRING("Attempt to delete a non collection - BAD!","");
+ DEBUG_NUMBER("Actual type is:",ci->type);
+ return;
+ }
+
+ /* Collection can be referenced by other collection */
+ header = (struct collection_header *)(ci->data);
+ if(header->reference_count>1) {
+ DEBUG_STRING("Dereferencing a referenced collection.","");
+ (header->reference_count)--;
+ DEBUG_NUMBER("Number after dereferencing.",header->reference_count);
+ }
+ else delete_collection(ci);
+
+ DEBUG_STRING("destroy_collection","Exit.");
+}
+
+
+/* PROPERTIES */
+
+/* Add a string property.
+ If length equals 0, the length is determined based on the string.
+ Lenght INCLUDES the terminating 0 */
+int add_str_property(struct collection_item *ci,char *subcollection, char *property,char *string,int length)
+{
+ int error = EOK;
+
+ DEBUG_STRING("add_str_property","Entry.");
+
+ if(length == 0) length = strlen(string) + 1;
+ (void)(add_property(ci,subcollection,property,(void *)(string),length, ELAPI_TYPE_STRING, &error));
+
+ DEBUG_NUMBER("add_str_property returning",error);
+ return error;
+}
+
+/* Add a binary property. */
+int add_binary_property(struct collection_item *ci,char *subcollection, char *property,void *binary_data,int length)
+{
+ int error = EOK;
+
+ DEBUG_STRING("add_binary_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,binary_data,length, ELAPI_TYPE_BINARY, &error));
+
+ DEBUG_NUMBER("add_binary_property returning",error);
+ return error;
+}
+
+/* Add an int property. */
+int add_int_property(struct collection_item *ci,char *subcollection, char *property,int number)
+{
+ int error = EOK;
+
+ DEBUG_STRING("add_int_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&number),sizeof(int), ELAPI_TYPE_INTEGER, &error));
+
+ DEBUG_NUMBER("add_int_property returning",error);
+ return error;
+}
+
+/* Add an unsigned int property. */
+int add_unsigned_property(struct collection_item *ci,char *subcollection, char *property,unsigned int number)
+{
+ int error = EOK;
+
+ DEBUG_STRING("add_unsigned_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&number),sizeof(int), ELAPI_TYPE_UNSIGNED, &error));
+
+ DEBUG_NUMBER("add_unsigned_property returning",error);
+ return error;
+}
+
+/* Add an long property. */
+int add_long_property(struct collection_item *ci,char *subcollection, char *property,long number)
+{
+ int error = EOK;
+
+ DEBUG_STRING("add_long_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&number),sizeof(long), ELAPI_TYPE_LONG, &error));
+
+ DEBUG_NUMBER("add_long_property returning",error);
+ return error;
+}
+
+/* Add an unsigned long property. */
+int add_ulong_property(struct collection_item *ci,char *subcollection, char *property,unsigned long number)
+{
+ int error = EOK;
+
+ DEBUG_STRING("add_ulong_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&number),sizeof(long), ELAPI_TYPE_ULONG, &error));
+
+ DEBUG_NUMBER("add_ulong_property returning",error);
+ return error;
+}
+
+/* Add a double property. */
+int add_double_property(struct collection_item *ci,char *subcollection, char *property,double number)
+{
+ int error = EOK;
+
+ DEBUG_STRING("add_double_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&number),sizeof(double), ELAPI_TYPE_DOUBLE, &error));
+
+ DEBUG_NUMBER("add_double_property returning",error);
+ return error;
+}
+
+/* A function to add a property */
+int add_any_property(struct collection_item *ci,
+ char *subcollection,
+ char *property,
+ int type,
+ void *data,
+ int length)
+{
+ int error = EOK;
+
+ DEBUG_STRING("add_any_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,data,length, type, &error));
+
+ DEBUG_NUMBER("add_any_property returning",error);
+ return error;
+}
+
+
+/* COPY */
+
+/* Create a deep copy of the current collection. */
+/* Referenced collections of the donor are copied as sub collections. */
+int copy_collection(struct collection_item **collection_copy,
+ struct collection_item *collection_to_copy,
+ char *name_to_use) {
+
+ int error = EOK;
+ struct collection_item *new_collection = (struct collection_item *)(NULL);
+ char *name;
+
+ DEBUG_STRING("copy_collection","Entry.");
+
+ /* Determine what name to use */
+ if(name_to_use != NULL) name = name_to_use;
+ else name = collection_to_copy->property;
+
+ /* Create a new collection */
+ error = create_collection(&new_collection,name);
+ if(error) {
+ DEBUG_NUMBER("Create_cllection failed returning",error);
+ return error;
+ }
+
+ error = walk_items(collection_to_copy, ELAPI_TRAVERSE_ONELEVEL, copy_traverse_handler,
+ new_collection, NULL, NULL);
+
+ if(!error) *collection_copy = new_collection;
+ else destroy_collection(new_collection);
+
+ DEBUG_NUMBER("copy_collection returning",error);
+ return error;
+
+}
+
+/* EXTRACTION */
+
+/* Extract collection */
+int get_collection_reference(struct collection_item *ci, /* High level collection */
+ struct collection_item **acceptor, /* The pointer that will accept extracted handle */
+ char *collection_to_find) /* Name to of the collection */
+{
+ struct collection_header *header;
+ struct collection_item *subcollection = (struct collection_item *)(NULL);
+ int error = EOK;
+
+ DEBUG_STRING("get_collection_reference","Entry.");
+
+ if((ci == (struct collection_item *)(NULL)) ||
+ (ci->type != ELAPI_TYPE_COLLECTION) ||
+ (acceptor == (struct collection_item **)(NULL)) ||
+ (collection_to_find == NULL)) {
+ DEBUG_NUMBER("Invalid parameter - returning error",EINVAL);
+ return EINVAL;
+ }
+
+ /* Find a sub collection */
+ DEBUG_STRING("We are given subcollection name - search it:",collection_to_find);
+ error = find_item_and_do(ci,collection_to_find,ELAPI_TYPE_COLLECTIONREF,
+ ELAPI_TRAVERSE_DEFAULT,
+ get_subcollection,(void *)(&subcollection),ELAPI_ACTION_FIND);
+ if(error) {
+ DEBUG_NUMBER("Search failed returning error",error);
+ return error;
+ }
+
+ if(subcollection == (struct collection_item *)(NULL)) {
+ DEBUG_STRING("Search for subcollection returned NULL pointer","");
+ return ENOENT;
+ }
+
+ header = (struct collection_header *)(subcollection->data);
+ DEBUG_NUMBER("Count:",header->count);
+ DEBUG_NUMBER("Ref count:",header->reference_count);
+ (header->reference_count)++;
+ DEBUG_NUMBER("Ref count after increment:",header->reference_count);
+ *acceptor = subcollection;
+
+ DEBUG_STRING("get_collection_reference","Success Exit.");
+ return EOK;
+}
+
+
+
+/* ADDITION */
+
+/* Add collection to collection */
+int add_collection_to_collection(
+ struct collection_item *ci, /* Collection handle to with we add another collection */
+ char *sub_collection_name, /* Name of the sub collection to which
+ collection needs to be added as a property.
+ If NULL high level collection is assumed. */
+ char *as_property, /* Name of the collection property.
+ If NULL, same property as the name of
+ the collection being added will be used. */
+ struct collection_item *collection_to_add, /* Collection to add */
+ int mode) /* How this collection needs to be added */
+{
+ struct collection_item *acceptor = (struct collection_item *)(NULL);
+ char *name_to_use;
+ struct collection_header *header;
+ struct collection_item *collection_copy;
+ int error = EOK;
+
+ DEBUG_STRING("add_collection_to_collection","Entry.");
+
+ if((ci == (struct collection_item *)(NULL)) ||
+ (ci->type != ELAPI_TYPE_COLLECTION) ||
+ (collection_to_add == (struct collection_item *)(NULL)) ||
+ (collection_to_add->type != ELAPI_TYPE_COLLECTION)) {
+ /* Need to debug here */
+ DEBUG_NUMBER("Missing parameter - returning error",EINVAL);
+ return EINVAL;
+ }
+
+ if(sub_collection_name != NULL) {
+ /* Find a sub collection */
+ DEBUG_STRING("We are given subcollection name - search it:",sub_collection_name);
+ error = find_item_and_do(ci,sub_collection_name,ELAPI_TYPE_COLLECTIONREF,
+ ELAPI_TRAVERSE_DEFAULT,
+ get_subcollection,(void *)(&acceptor),ELAPI_ACTION_FIND);
+ if(error) {
+ DEBUG_NUMBER("Search failed returning error",error);
+ return error;
+ }
+
+ if(acceptor == (struct collection_item *)(NULL)) {
+ DEBUG_STRING("Search for subcollection returned NULL pointer","");
+ return ENOENT;
+ }
+
+ }
+ else acceptor = ci;
+
+ if(as_property != NULL)
+ name_to_use = as_property;
+ else
+ name_to_use = collection_to_add->property;
+
+
+ DEBUG_STRING("Going to use name:",name_to_use);
+
+
+ switch(mode) {
+ case ELAPI_ADD_MODE_REFERENCE:
+ DEBUG_STRING("We are adding a reference.","");
+ DEBUG_NUMBER("Type of the header element:",collection_to_add->type);
+ DEBUG_STRING("Header name we are adding.",collection_to_add->property);
+ /* Create a pointer to external collection */
+ /* For future thread safety: Transaction start -> */
+ (void)(add_property(acceptor,NULL,name_to_use,(void *)(&collection_to_add),
+ sizeof(struct collection_item **),
+ ELAPI_TYPE_COLLECTIONREF, &error));
+
+ DEBUG_NUMBER("Type of the header element after add_property:",collection_to_add->type);
+ DEBUG_STRING("Header name we just added.",collection_to_add->property);
+ if(error) {
+ DEBUG_NUMBER("Adding property failed with error:",error);
+ return error;
+ }
+ header = (struct collection_header *)(collection_to_add->data);
+ DEBUG_NUMBER("Count:",header->count);
+ DEBUG_NUMBER("Ref count:",header->reference_count);
+ (header->reference_count)++;
+ DEBUG_NUMBER("Ref count after increment:",header->reference_count);
+ /* -> Transaction end */
+ break;
+ case ELAPI_ADD_MODE_EMBED:
+ DEBUG_STRING("We are embedding the collection.","");
+ /* First check if the passed in collection is referenced more than once */
+ DEBUG_NUMBER("Type of the header element we are adding:",collection_to_add->type);
+ DEBUG_STRING("Header name we are adding.",collection_to_add->property);
+ DEBUG_NUMBER("Type of the header element we are adding to:",acceptor->type);
+ DEBUG_STRING("Header name we are adding to.",acceptor->property);
+
+ (void)(add_property(acceptor,NULL,name_to_use,(void *)(&collection_to_add),
+ sizeof(struct collection_item **),
+ ELAPI_TYPE_COLLECTIONREF, &error));
+
+ DEBUG_NUMBER("Adding property returned:",error);
+ break;
+
+ case ELAPI_ADD_MODE_CLONE:
+ DEBUG_STRING("We are cloning the collection.","");
+ DEBUG_STRING("Name we will use.",name_to_use);
+
+ /* For future thread safety: Transaction start -> */
+ error = copy_collection(&collection_copy, collection_to_add, name_to_use);
+ if(error) return error;
+
+ DEBUG_STRING("We have a collection copy.", collection_copy->property);
+ DEBUG_NUMBER("Collection type.", collection_copy->type);
+ DEBUG_STRING("Acceptor collection.", acceptor->property);
+ DEBUG_NUMBER("Acceptor collection type.", acceptor->type);
+
+ (void)(add_property(acceptor,NULL,name_to_use,(void *)(&collection_copy),
+ sizeof(struct collection_item **),
+ ELAPI_TYPE_COLLECTIONREF, &error));
+
+ /* -> Transaction end */
+ DEBUG_NUMBER("Adding property returned:",error);
+ break;
+
+ default: error = EINVAL;
+ }
+
+ DEBUG_NUMBER("add_collection_to_collection returning:",error);
+ return error;
+}
+
+/* TRAVERSING */
+
+/* Function to traverse the entire collection including optionally sub collections */
+int traverse_collection(struct collection_item *ci,
+ int mode_flags,
+ item_fn item_handler,
+ void *custom_data)
+{
+
+ int error = EOK;
+ DEBUG_STRING("traverse_collection","Entry.");
+
+ error = walk_items(ci, mode_flags, simple_traverse_handler,
+ NULL, item_handler, custom_data);
+
+ if((error != 0) && (error != EINTR_INTERNAL)) {
+ DEBUG_NUMBER("Error walking tree",error);
+ return error;
+ }
+
+ DEBUG_STRING("traverse_collection","Success exit.");
+ return EOK;
+}
+
+/* CHECK */
+
+/* Convenience function to check if specific property is in the collection */
+int is_item_in_collection(struct collection_item *ci,
+ char *property_to_find,
+ int type,
+ int mode_flags,
+ int *found)
+{
+ int error;
+
+ DEBUG_STRING("is_item_in_collection","Entry.");
+
+ *found = ELAPI_NOMATCH;
+ error = find_item_and_do(ci,property_to_find,type,mode_flags,
+ is_in_item_handler,(void *)found,ELAPI_ACTION_FIND);
+
+ DEBUG_NUMBER("is_item_in_collection returning",error);
+ return error;
+}
+
+/* SEARCH */
+/* Search function. Looks up an item in the collection based on the property.
+ Essentually it is a traverse function with spacial traversing logic.
+ */
+int get_item_and_do(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags, /* How to traverse the collection */
+ item_fn item_handler, /* Function to call when the item is found */
+ void *custom_data) /* Custom data passed around */
+{
+ int error = EOK;
+
+ DEBUG_STRING("get_item_and_do","Entry.");
+
+ error = find_item_and_do(ci,property_to_find,type,mode_flags,item_handler,custom_data,ELAPI_ACTION_FIND);
+
+ DEBUG_NUMBER("get_item_and_do returning",error);
+ return error;
+}
+
+/* DELETE */
+/* Delete property from the collection */
+int delete_property(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags) /* How to traverse the collection */
+{
+ int error = EOK;
+ int found;
+
+ DEBUG_STRING("delete_property","Entry.");
+ found = ELAPI_NOMATCH;
+
+ error = find_item_and_do(ci,property_to_find,type,mode_flags,NULL,(void *)(&found),ELAPI_ACTION_DEL);
+
+ if((error == EOK) && (found == ELAPI_NOMATCH)) error = ENOENT;
+ DEBUG_NUMBER("delete_property returning",error);
+ return error;
+}
+
+/* UPDATE */
+/* Update property in the collection */
+int update_property(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type of the passed in data */
+ void *new_data, /* Pointer to the new data */
+ int length, /* Length of the data. For strings should include trailing 0 */
+ int mode_flags) /* How to traverse the collection */
+
+{
+ int error = EOK;
+ struct update_property update_data;
+
+ DEBUG_STRING("update_property","Entry.");
+ update_data.type = type;
+ update_data.data = new_data;
+ update_data.length = length;
+ update_data.found = ELAPI_NOMATCH;
+
+ error = find_item_and_do(ci,property_to_find,type,mode_flags,NULL,(void *)(&update_data),ELAPI_ACTION_UPDATE);
+
+ if((error == EOK) && (update_data.found == ELAPI_NOMATCH)) error = ENOENT;
+ DEBUG_NUMBER("update_property returning",error);
+ return error;
+}
+
+/* Update a string property in the collection. Length should include the null terminating 0 */
+int update_str_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ char *string,
+ int length)
+{
+ int error = EOK;
+ DEBUG_STRING("update_str_property","Entry.");
+
+ if(length == 0) length = strlen(string) + 1;
+ error = update_property(ci,property, ELAPI_TYPE_STRING, (void *)(string),length,mode_flags);
+
+ DEBUG_NUMBER("update_str_property Returning",error);
+ return error;
+}
+
+/* Update a binary property in the collection. */
+int update_binary_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ void *binary_data,
+ int length)
+{
+ int error = EOK;
+ DEBUG_STRING("update_binary_property","Entry.");
+
+ error = update_property(ci,property, ELAPI_TYPE_BINARY, binary_data, length, mode_flags);
+
+ DEBUG_NUMBER("update_binary_property Returning",error);
+ return error;
+}
+
+/* Update an int property in the collection. */
+int update_int_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ int number)
+{
+ int error = EOK;
+ DEBUG_STRING("update_int_property","Entry.");
+
+ error = update_property(ci,property, ELAPI_TYPE_INTEGER, (void *)(&number), sizeof(int), mode_flags);
+
+ DEBUG_NUMBER("update_int_property Returning",error);
+ return error;
+}
+
+/* Update an unsigned int property. */
+int update_unsigned_property(struct collection_item *ci,
+ char *property,int mode_flags,
+ unsigned int number)
+{
+ int error = EOK;
+ DEBUG_STRING("update_unsigned_property","Entry.");
+
+ error = update_property(ci,property, ELAPI_TYPE_UNSIGNED, (void *)(&number), sizeof(unsigned int), mode_flags);
+
+ DEBUG_NUMBER("update_unsigned_property Returning",error);
+ return error;
+}
+/* Update a long property. */
+int update_long_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ long number)
+{
+ int error = EOK;
+ DEBUG_STRING("update_long_property","Entry.");
+
+ error = update_property(ci,property, ELAPI_TYPE_LONG, (void *)(&number), sizeof(long), mode_flags);
+
+ DEBUG_NUMBER("update_long_property Returning",error);
+ return error;
+
+}
+
+/* Update an unsigned long property. */
+int update_ulong_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ unsigned long number)
+{
+ int error = EOK;
+ DEBUG_STRING("update_ulong_property","Entry.");
+
+ error = update_property(ci,property, ELAPI_TYPE_ULONG, (void *)(&number), sizeof(unsigned long), mode_flags);
+
+ DEBUG_NUMBER("update_ulong_property Returning",error);
+ return error;
+}
+
+/* Update a double property. */
+int update_double_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ double number)
+{
+ int error = EOK;
+ DEBUG_STRING("update_double_property","Entry.");
+
+ error = update_property(ci,property, ELAPI_TYPE_DOUBLE, (void *)(&number), sizeof(double), mode_flags);
+
+ DEBUG_NUMBER("update_double_property Returning",error);
+ return error;
+}
+
+
+
+
+
+
diff --git a/collection/elapi_collection.h b/collection/elapi_collection.h
new file mode 100644
index 0000000..129b83a
--- /dev/null
+++ b/collection/elapi_collection.h
@@ -0,0 +1,196 @@
+/* Copyright */
+
+#ifndef ELAPI_COLLECTION_H
+#define ELAPI_COLLECTION_H
+
+#ifndef EOK
+#define EOK 0
+#endif
+
+#define ELAPI_TYPE_STRING 0x00000001
+#define ELAPI_TYPE_BINARY 0x00000002
+#define ELAPI_TYPE_INTEGER 0x00000004
+#define ELAPI_TYPE_UNSIGNED 0x00000008
+#define ELAPI_TYPE_LONG 0x00000010
+#define ELAPI_TYPE_ULONG 0x00000020
+#define ELAPI_TYPE_DOUBLE 0x00000040
+#define ELAPI_TYPE_COLLECTION 0x00000080 /* The item of this type denotes that starting element of a collection */
+#define ELAPI_TYPE_COLLECTIONREF 0x00000100 /* The item of this type denotes a pointer to already existing external collection */
+#define ELAPI_TYPE_END 0x10000000 /* Special type that denotes the end of the collection. Useful when traversing collection */
+#define ELAPI_TYPE_ANY 0x0FFFFFFF /* Special type that denotes any. Useful when traversing collection */
+
+/* Any data we deal with can't be longer than this */
+#define ELAPI_MAX_DATA 65535
+
+/* The modes that define how one collection can be added to another */
+
+#define ELAPI_ADD_MODE_REFERENCE 0 /* One collection will contain a pointer of another */
+#define ELAPI_ADD_MODE_EMBED 1 /* One collection will be donated to become a part of another collection.
+ After that the donating connection handle should not be used or freed.
+ It means that it can be donated only once. The donation attempt will
+ fail if the collection is referenced by other collection. */
+#define ELAPI_ADD_MODE_CLONE 2 /* Creates a deep copy of a collection with its sub collections */
+
+
+/* Modes how the collection is traversed */
+#define ELAPI_TRAVERSE_DEFAULT 0x00000000 /* No special flags - means it will go through all the items */
+#define ELAPI_TRAVERSE_ONELEVEL 0x00000001 /* Flag to traverse only high level */
+#define ELAPI_TRAVERSE_END 0x00000002 /* Call handler once more when end of the collection is reached - good for processing nested collections */
+#define ELAPI_TRAVERSE_IGNORE 0x00000004 /* Ignore sub collections at all as if there are none */
+
+
+/* Match values */
+#define ELAPI_NOMATCH 0
+#define ELAPI_MATCH 1
+
+
+/* Structure that holds one property */
+struct collection_item {
+ struct collection_item *next;
+ char *property;
+ int property_len;
+ int type;
+ int length;
+ void *data;
+};
+
+/* Special type of data that stores collection header information */
+struct collection_header {
+ struct collection_item *last;
+ int reference_count;
+ int count;
+};
+
+/* Function that creates an named collection */
+int create_collection(struct collection_item **ci,char *name);
+
+/* Function that destroys a collection */
+void destroy_collection(struct collection_item *ci);
+
+/* Family of functions that add properties to an event */
+/* Family includes the following convinience functions: */
+
+/* Add a string property to collection. Length should include the null terminating 0 */
+int add_str_property(struct collection_item *ci,char *subcollection, char *property,char *string,int length);
+/* Add a binary property to collection. */
+int add_binary_property(struct collection_item *ci,char *subcollection, char *property,void *binary_data,int length);
+/* Add an int property to collection. */
+int add_int_property(struct collection_item *ci,char *subcollection, char *property,int number);
+/* Add an unsigned int property. */
+int add_unsigned_property(struct collection_item *ci,char *subcollection, char *property,unsigned int number);
+/* Add a long property. */
+int add_long_property(struct collection_item *ci,char *subcollection, char *property,long number);
+/* Add an unsigned long property. */
+int add_ulong_property(struct collection_item *ci,char *subcollection, char *property,unsigned long number);
+/* Add a double property. */
+int add_double_property(struct collection_item *ci,char *subcollection, char *property,double number);
+
+/* Add any property */
+int add_any_property(struct collection_item *ci, /* Collection to find things in */
+ char *subcollection, /* Subcollection */
+ char *property, /* Name */
+ int type, /* Type of the passed in data */
+ void *data, /* Pointer to the new data */
+ int length); /* Length of the data. For strings should include trailing 0 */
+
+
+
+/* Update functions */
+/* Update a string property in the collection. Length should include the null terminating 0 */
+int update_str_property(struct collection_item *ci, char *property,int mode_flags, char *string,int length);
+/* Update a binary property in the collection. */
+int update_binary_property(struct collection_item *ci, char *property,int mode_flags, void *binary_data,int length);
+/* Update an int property in the collection. */
+int update_int_property(struct collection_item *ci, char *property,int mode_flags, int number);
+/* Update an unsigned int property. */
+int update_unsigned_property(struct collection_item *ci, char *property,int mode_flags, unsigned int number);
+/* Update a long property. */
+int update_long_property(struct collection_item *ci, char *property,int mode_flags ,long number);
+/* Update an unsigned long property. */
+int update_ulong_property(struct collection_item *ci, char *property,int mode_flags, unsigned long number);
+/* Update a double property. */
+int update_double_property(struct collection_item *ci, char *property,int mode_flags, double number);
+
+
+/* Update property in the collection */
+int update_property(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type of the passed in data */
+ void *new_data, /* Pointer to the new data */
+ int length, /* Length of the data. For strings should include trailing 0 */
+ int mode_flags); /* How to traverse the collection */
+
+
+
+
+/* Add collection to collection */
+int add_collection_to_collection(struct collection_item *ci, /* Collection handle to with we add another collection */
+ char *sub_collection_name, /* Name of the sub collection to which
+ collection needs to be added as a property.
+ If NULL high level collection is assumed. */
+ char *as_property, /* Name of the collection property.
+ If NULL, same property as the name of
+ the collection being added will be used. */
+ struct collection_item *collection_to_add, /* Collection to add */
+ int mode); /* How this collection needs to be added */
+
+/* Create a deep copy of the current collection. */
+/* Referenced collections of the donor are copied as sub collections. */
+int copy_collection(struct collection_item **collection_copy,
+ struct collection_item *collection_to_copy,
+ char *name_to_use);
+
+/* Signature of the callback that needs to be used when
+ traversing a collection or looking for a specific item */
+typedef int (*item_fn)(char *, /* The name of the property will be passed in this parameter. */
+ int, /* Length of the property name will be passed in this parameter. */
+ int, /* Type of the data will be passed in this parameter */
+ void *, /* Ponter to the data will be passed in this parameter */
+ int, /* Length of data will be passed in this parameter */
+ void *, /* Custom data will be passed in this parameter */
+ int *); /* Pointer to variable where the handler can put non zero to stop processing */
+
+/* Function to traverse the entire collection including optionally sub collections */
+int traverse_collection(struct collection_item *ci, /* Collection to traverse */
+ int mode_flags, /* Flags defining how to traverse */
+ item_fn item_handler, /* Handler called for each item */
+ void *custom_data); /* Custom data passed around */
+
+/* Search function. Looks up an item in the collection based on the property.
+ Essentually it is a traverse function with spacial traversing logic.
+ It is the responsibility of the handler to set something in the custom data
+ to indicate that the item was found.
+ Function will not return error if the item is not found.
+ It is the responsibility of the calling application to check
+ the data passed in custom_data and see if the item was found and
+ that the action was performed.
+ */
+int get_item_and_do(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags, /* How to traverse the collection */
+ item_fn item_handler, /* Function to call when the item is found */
+ void *custom_data); /* Custom data passed around */
+
+/* Delete property from the collection */
+int delete_property(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags); /* How to traverse the collection */
+
+
+/* Convinience function to check if the property is indeed in the collection */
+int is_item_in_collection(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags, /* How to traverse the collection */
+ int *found); /* Boolean that turns to nonzero if the match is found */
+
+
+/* Get collection - get a pointer to a collection included into another collection */
+int get_collection_reference(struct collection_item *ci, /* High level collection */
+ struct collection_item **acceptor, /* The pointer that will accept extracted handle */
+ char *collection_to_find); /* Name to of the collection */
+
+
+#endif
diff --git a/collection/elapi_collection_ut.c b/collection/elapi_collection_ut.c
new file mode 100644
index 0000000..9ee5261
--- /dev/null
+++ b/collection/elapi_collection_ut.c
@@ -0,0 +1,522 @@
+/* Copyright */
+
+#include <stdio.h>
+#include <string.h>
+#include <errno.h>
+#include "elapi_collection.h"
+#include "elapi_util.h"
+#include "elapi_debug.h"
+#include "elapi_tools.h"
+
+
+
+/* Print the collection using default serialization */
+int collection_to_XML(struct collection_item *handle)
+{
+ struct xml_data xml;
+ int error = EOK;
+
+ printf("COLLECTION TO XML:\n");
+
+ xml.writer = (xmlTextWriterPtr)(NULL);
+ xml.buf = (xmlBufferPtr)(NULL);
+ xml.given_name = NULL;
+ xml.level = 0;
+
+ /* Traverse collection */
+ error = traverse_collection(handle,ELAPI_TRAVERSE_DEFAULT | ELAPI_TRAVERSE_END ,xml_add,(void *)(&xml));
+ if(error) printf("Error converting collection to XML %d\n",error);
+ else {
+ xmlFreeTextWriter(xml.writer);
+ printf("%s\n", (const char *) ((xml.buf)->content));
+ xmlBufferFree(xml.buf);
+ }
+
+
+ return error;
+}
+
+
+int ref_collection_test()
+{
+ struct collection_item *peer;
+ struct collection_item *socket;
+ char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
+ int found = 0;
+
+ int error = EOK;
+
+ DEBUG_STRING("ref_collection_test","Entry.");
+
+ printf("\n\nREF TEST!!!.\n\n\n");
+ printf("Creating PEER collection.\n");
+
+ if((error=create_collection(&peer,"peer")) ||
+ (error=add_str_property(peer,NULL,"hostname","peerhost.mytest.com",0)) ||
+ (error=add_str_property(peer,NULL,"IPv4","10.10.10.10",12)) || /* Expect trailing zero to be truncated */
+ (error=add_str_property(peer,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ return error;
+ }
+
+ printf("Creating SOCKET collection.\n");
+
+ if((error=create_collection(&socket,"socket")) ||
+ (error=add_int_property(socket,NULL,"id",1)) ||
+ (error=add_long_property(socket,NULL,"packets",100000000L)) ||
+ (error=add_binary_property(socket,NULL,"stack",binary_dump,sizeof(binary_dump)))) {
+ destroy_collection(peer);
+ destroy_collection(socket);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket,ELAPI_TRAVERSE_DEFAULT);
+ debug_collection(peer,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Adding PEER collection to SOCKET collection as a reference named PEER\n");
+
+ /* Embed peer host into the socket2 as reference */
+ error = add_collection_to_collection(socket,NULL,"peer",peer,ELAPI_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(socket);
+ printf("Failed to add collection to collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket,ELAPI_TRAVERSE_DEFAULT);
+ debug_collection(peer,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("About to destroy PEER\n");
+ destroy_collection(peer);
+ debug_collection(socket,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("About to extract PEER\n");
+ error = get_collection_reference(socket,&peer,"peer");
+ if(error) {
+ destroy_collection(socket);
+ printf("Failed to extract collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket,ELAPI_TRAVERSE_DEFAULT);
+ debug_collection(peer,ELAPI_TRAVERSE_DEFAULT);
+ destroy_collection(peer);
+
+ debug_collection(socket,ELAPI_TRAVERSE_DEFAULT);
+ destroy_collection(socket);
+ DEBUG_NUMBER("ref_collection_test. Returning",error);
+
+ printf("\n\nEND OF REF TEST!!!.\n\n\n");
+
+ return error;
+
+}
+
+
+int single_collection_test()
+{
+ struct collection_item *handle;
+ int error = EOK;
+
+ DEBUG_STRING("single_collection_test","Entry.");
+
+ if((error=create_collection(&handle,"string_test")) ||
+ (error=add_str_property(handle,NULL,"property_1","some data",0)) ||
+ (error=add_str_property(handle,NULL,"property_2","some other data",2)) ||
+ (error=add_str_property(handle,NULL,"property_3","more data",7))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(handle);
+ return error;
+ }
+
+ error = add_str_property(handle,NULL,"property 1","some data",0);
+ if(error) printf("Expected error adding bad property to collection %d\n",error);
+ else printf("Expected error but got success\n");
+ error = EOK;
+
+ error=add_double_property(handle,NULL,"double",0.253545);
+ if(error) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(handle);
+ return error;
+ }
+
+ error=update_double_property(handle,"double",ELAPI_TRAVERSE_DEFAULT,1.999999);
+ if(error) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(handle);
+ return error;
+ }
+ printf("Created collection\n");
+
+ /* Traverse collection */
+ error = debug_collection(handle,ELAPI_TRAVERSE_DEFAULT);
+ if(error) printf("Error debugging collection %d\n",error);
+ error = print_collection(handle);
+ if(error) printf("Error printing collection %d\n",error);
+
+ destroy_collection(handle);
+
+ DEBUG_NUMBER("single_collection_test. Error: ",error);
+ return error;
+}
+
+int add_collection_test()
+{
+ struct collection_item *peer;
+ struct collection_item *socket;
+ char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
+ int found = 0;
+
+ int error = EOK;
+
+ DEBUG_STRING("add_collection_test","Entry.");
+
+ printf("\n\nADD TEST!!!.\n\n\n");
+ printf("Creating PEER collection.\n");
+
+ if((error=create_collection(&peer,"peer")) ||
+ (error=add_str_property(peer,NULL,"hostname","peerhost.mytest.com",0)) ||
+ (error=add_str_property(peer,NULL,"IPv4","10.10.10.10",12)) || /* Expect trailing zero to be truncated */
+ (error=add_str_property(peer,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ return error;
+ }
+
+ printf("Creating SOCKET collection.\n");
+
+ if((error=create_collection(&socket,"socket")) ||
+ (error=add_int_property(socket,NULL,"id",1)) ||
+ (error=add_long_property(socket,NULL,"packets",100000000L)) ||
+ (error=add_binary_property(socket,NULL,"stack",binary_dump,sizeof(binary_dump)))) {
+ destroy_collection(peer);
+ destroy_collection(socket);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket,ELAPI_TRAVERSE_DEFAULT);
+ debug_collection(peer,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Adding PEER collection to SOCKET collection as a reference named PEER\n");
+
+ /* Embed peer host into the socket2 as reference */
+ error = add_collection_to_collection(socket,NULL,"peer",peer,ELAPI_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(socket);
+ printf("Failed to create collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket,ELAPI_TRAVERSE_DEFAULT);
+ debug_collection(peer,ELAPI_TRAVERSE_DEFAULT);
+ destroy_collection(peer);
+ debug_collection(socket,ELAPI_TRAVERSE_DEFAULT);
+ destroy_collection(socket);
+ DEBUG_NUMBER("add_collection_test. Returning",error);
+ return error;
+}
+
+int mixed_collection_test()
+{
+ struct collection_item *peer;
+ struct collection_item *socket1;
+ struct collection_item *socket2;
+ struct collection_item *packet;
+ struct collection_item *event;
+ struct collection_item *host;
+ char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
+ int found = 0;
+
+ int error = EOK;
+
+ DEBUG_STRING("mixed_collection_test","Entry.");
+
+ printf("\n\nMIXED TEST!!!.\n\n\n");
+ printf("Creating PEER collection.\n");
+
+ if((error=create_collection(&peer,"peer")) ||
+ (error=add_str_property(peer,NULL,"hostname","peerhost.mytest.com",0)) ||
+ (error=add_str_property(peer,NULL,"IPv4","10.10.10.10",12)) || /* Expect trailing zero to be truncated */
+ (error=add_str_property(peer,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ return error;
+ }
+
+ debug_collection(peer,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Creating HOST collection.\n");
+
+ if((error=create_collection(&host,"host")) ||
+ (error=add_str_property(host,NULL,"hostname","myhost.mytest.com",0)) ||
+ (error=add_str_property(host,NULL,"IPv4","20.20.20.20",13)) ||
+ (error=add_str_property(host,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0)) ||
+ (error=add_double_property(host,NULL,"double",0.253545))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ destroy_collection(host);
+ return error;
+ }
+
+ debug_collection(host,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Creating SOCKET1 collection.\n");
+
+ if((error=create_collection(&socket1,"socket1")) ||
+ (error=add_int_property(socket1,NULL,"id",1)) ||
+ (error=add_long_property(socket1,NULL,"packets",100000000L)) ||
+ (error=add_binary_property(socket1,NULL,"stack",binary_dump,sizeof(binary_dump)))) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket1,ELAPI_TRAVERSE_DEFAULT);
+ printf("Creating a copy of SOCKET1 collection named SOCKET2.\n");
+
+ error = copy_collection(&socket2,socket1,"socket2");
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ printf("Failed to copy collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket2,ELAPI_TRAVERSE_DEFAULT);
+ debug_collection(peer,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Adding PEER collection to SOCKET2 collection as a reference named PEER2\n");
+
+ /* Embed peer host into the socket2 as reference */
+ error = add_collection_to_collection(socket2,NULL,"peer2",peer,ELAPI_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ destroy_collection(socket2);
+ printf("Failed to create collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket2,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Creating an EVENT collection.\n");
+
+ /* Construct event */
+ error = create_collection(&event,"event");
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ destroy_collection(socket2);
+ printf("Failed to create collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(event,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Adding HOST to EVENT.\n");
+
+ /* Add host to event */
+ error = add_collection_to_collection(event,NULL,NULL,host,ELAPI_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ destroy_collection(socket2);
+ printf("Failed to add collections. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(event,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Embed SOCKET1 into EVENT.\n");
+ /* Donate socket1 to event */
+ /* Socket1 should not be used after this */
+ error = add_collection_to_collection(event,NULL,NULL,socket1,ELAPI_ADD_MODE_EMBED);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ destroy_collection(socket2);
+ printf("Failed to add collections. Error %d\n",error);
+ return error;
+ }
+
+ printf("Traverse one level:\n");
+ debug_collection(event,ELAPI_TRAVERSE_ONELEVEL);
+ printf("Traverse ignore subcollections:\n");
+ debug_collection(event,ELAPI_TRAVERSE_IGNORE);
+ printf("Traverse normal:\n");
+ debug_collection(event,ELAPI_TRAVERSE_DEFAULT);
+ debug_collection(socket1,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("SOCKET1 MUST NO BE USED AFTER THIS POINT!!!\n");
+ socket1 = (struct collection_item *)(NULL);
+
+ printf("Add collection PEER as PEER1 to subcollection SOCKET1 of the EVENT.\n");
+
+ debug_collection(peer,ELAPI_TRAVERSE_DEFAULT);
+
+ error = add_collection_to_collection(event,"socket1","peer1",peer,ELAPI_ADD_MODE_CLONE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ /* No socket1 any more :) */
+ destroy_collection(socket2);
+ printf("Failed to add collections. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(event,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Add property named TIMEOUT to PEER collection.\n");
+
+ /* Add new property to the peer collection */
+ error = add_int_property(peer,NULL,"timeout",5);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ /* No socket1 any more :) */
+ destroy_collection(socket2);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket2,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Add property named DELAY to PEER1 collection.\n");
+
+ error = add_int_property(event,"peer1","delay",10);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ /* No socket1 any more :) */
+ destroy_collection(socket2);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(event,ELAPI_TRAVERSE_DEFAULT);
+ debug_collection(host,ELAPI_TRAVERSE_DEFAULT);
+
+ printf("Check if property PEER1.DELAY is in the EVENT collection.\n");
+
+ /* Check if the property in the collection */
+ found = 0;
+ error = is_item_in_collection(event, "peer1.delay", ELAPI_TYPE_ANY, ELAPI_TRAVERSE_DEFAULT, &found);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ /* No socket1 any more :) */
+ destroy_collection(socket2);
+ printf("Failed to check property. Error %d\n",error);
+ return error;
+ }
+
+ if (found == 1) printf("Property is found!\n");
+ else printf("Error property is not found!\n");
+
+
+ print_item(event, "peer1.IPv6");
+ print_item(event, "event.socket1.peer1.IPv6");
+ print_item(event, "event.peer1.IPv6");
+ print_item(event, "speer1.IPv6");
+ print_item(event, "eer1.IPv6");
+ print_item(event, ".peer1.IPv6");
+ print_item(event, "t.peer1.IPv6");
+
+ collection_to_XML(event);
+
+ printf("Delete property PEER1.DELAY from the EVENT collection.\n");
+
+ error = delete_property(event,"peer1.delay",ELAPI_TYPE_ANY, ELAPI_TRAVERSE_DEFAULT);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ /* No socket1 any more :) */
+ destroy_collection(socket2);
+ printf("Failed to delete property. Error %d\n",error);
+ return error;
+ }
+
+ printf("Printing EVENT.\n");
+
+ /* Traverse collection */
+ error = print_collection(event);
+ if(error) printf("Error printing collection %d\n",error);
+
+ printf("Debugging EVENT.\n");
+
+ error = debug_collection(event,ELAPI_TRAVERSE_DEFAULT);
+ if(error) printf("Error printing collection %d\n",error);
+
+ printf("Cleanup of the collections PEER, HOST and SOCKET2.\n");
+
+ /* Destroy a referenced collection */
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket2);
+
+ printf("Printing EVENT again.\n");
+
+ /* Traverse collection again - peer should still be there */
+ error = print_collection(event);
+ if(error) printf("Error printing collection %d\n",error);
+
+ printf("Debugging EVENT again.\n");
+
+ error = debug_collection(event,ELAPI_TRAVERSE_DEFAULT);
+ if(error) printf("Error printing collection %d\n",error);
+
+ printf("Attempt to add property to a referenced collection.\n");
+
+ /* Some negative tests */
+ /* Can't add attributes to the referenced collection */
+ error = add_int_property(event,"host","session",500);
+ if(error == 0) printf("Error was able to add property to referenced collection.\n");
+ printf("Expected error %d\n",error);
+
+ printf("Attempt to delete non-existent property.\n");
+
+ /* Can't delete non exitent property */
+ error = delete_property(event,"host.host",ELAPI_TYPE_ANY, ELAPI_TRAVERSE_DEFAULT);
+ if(error == 0) printf("Error was able to delete property that does not exist.\n");
+ printf("Expected error %d\n",error);
+
+ printf("Done.Cleaning...\n");
+
+ destroy_collection(event);
+
+ printf("Exit.\n");
+ return EOK;
+}
+
+
+/* Main function of the unit test */
+
+int main()
+{
+ int error = 0;
+
+ printf("Start\n");
+ if((error=ref_collection_test()) ||
+ (error=single_collection_test()) ||
+ (error=add_collection_test()) ||
+ (error=mixed_collection_test())) {
+ printf("Failed!\n");
+ }
+ else printf("Success!\n");
+ /* Add other tests here ... */
+ return error;
+}
+
diff --git a/collection/elapi_util.c b/collection/elapi_util.c
new file mode 100644
index 0000000..1224c25
--- /dev/null
+++ b/collection/elapi_util.c
@@ -0,0 +1,499 @@
+/* Copyright */
+
+#include <stdio.h>
+#include <string.h>
+#include <errno.h>
+#include <stdlib.h>
+#include "elapi_collection.h"
+#include "elapi_debug.h"
+#include "elapi_util.h"
+
+/* Return a static string based on type of the element */
+const char *get_type(int type)
+{
+ switch(type) {
+ case ELAPI_TYPE_STRING: return ELAPI_TYPE_NAME_STRING;
+ case ELAPI_TYPE_INTEGER: return ELAPI_TYPE_NAME_INTEGER;
+ case ELAPI_TYPE_UNSIGNED: return ELAPI_TYPE_NAME_UNSIGNED;
+ case ELAPI_TYPE_LONG: return ELAPI_TYPE_NAME_LONG;
+ case ELAPI_TYPE_ULONG: return ELAPI_TYPE_NAME_ULONG;
+ case ELAPI_TYPE_BINARY: return ELAPI_TYPE_NAME_BINARY;
+ default: return ELAPI_TYPE_NAME_UNKNOWN;
+ }
+
+}
+
+/* Calculate the potential size of the item */
+int get_data_len(int type, int length)
+{
+ int len = 0;
+
+ DEBUG_STRING("util_get_item_len","Entry point");
+
+ switch(type) {
+ case ELAPI_TYPE_INTEGER:
+ case ELAPI_TYPE_UNSIGNED:
+ case ELAPI_TYPE_LONG:
+ case ELAPI_TYPE_ULONG:
+ len = 15;
+ break;
+ case ELAPI_TYPE_STRING:
+ case ELAPI_TYPE_BINARY:
+ len = length * 2 + 2;
+ break;
+ case ELAPI_TYPE_DOUBLE:
+ len = 64;
+ break;
+ default:
+ len = 0;
+ break;
+ }
+
+ DEBUG_STRING("util_get_item_len","Exit point");
+
+ return len;
+}
+
+/* Copy data escaping characters */
+static int copy_esc(char *dest,char *source,char esc)
+{
+ int i=0;
+ int j=0;
+
+ *(dest +j) = esc;
+ j++;
+
+ while(*(source+i) != '\0') {
+ if((*(source+i) == '\\') ||
+ (*(source+i) == esc)) {
+
+ *(dest +j) = '\\';
+ j++;
+
+ }
+ *(dest +j) = *(source +i);
+ i++;
+ j++;
+ }
+ *(dest +j) = esc;
+ j++;
+
+ return j;
+}
+
+
+
+/* Grow buffer to accomodate more space */
+int grow_buffer(struct serial_data *buf_data, int len)
+{
+ void *tmp;
+
+ DEBUG_STRING("grow_buffer","Entry point");
+ DEBUG_NUMBER("Current length: ",buf_data->length);
+ DEBUG_NUMBER("Increment length: ",len);
+ DEBUG_NUMBER("Expected length: ",buf_data->length+len);
+ DEBUG_NUMBER("Current size: ",buf_data->size);
+
+ /* Grow buffer if needed */
+ while(buf_data->length+len >= buf_data->size) {
+ errno = 0;
+ tmp = realloc(buf_data->buffer,buf_data->size+BLOCK_SIZE);
+ if(tmp == NULL) {
+ DEBUG_NUMBER("Error. Failed to allocate memory. Errno: ",errno);
+ return errno;
+ }
+ buf_data->buffer = (char *)(tmp);
+ buf_data->size += BLOCK_SIZE;
+ DEBUG_NUMBER("New size: ",buf_data->size);
+
+ }
+
+ DEBUG_NUMBER("Final size: ",buf_data->size);
+ DEBUG_STRING("grow_buffer","Success Exit.");
+ return EOK;
+}
+
+/* Specail function to add different formatting symbols to the output */
+int put_marker(struct serial_data *buf_data, void *data, int len)
+{
+ int error = EOK;
+
+ DEBUG_STRING("put_marker","Entry point");
+ DEBUG_NUMBER("Marker length: ",len);
+
+ error = grow_buffer(buf_data, len);
+ if(error) {
+ DEBUG_NUMBER("grow_buffer failed with: ",error);
+ return error;
+ }
+ memcpy(buf_data->buffer+buf_data->length,data,len);
+ buf_data->length+=len;
+ *(buf_data->buffer+buf_data->length) = '\0';
+
+ DEBUG_STRING("put_marker","Success exit");
+ return error;
+}
+
+/* Add item's data */
+int serialize(char *property_in,
+ int property_len_in,
+ int type,
+ void *data_in,
+ int length_in,
+ void *custom_data,
+ int *dummy)
+{
+ int len;
+ struct serial_data *buf_data;
+ char *property;
+ void *data;
+ int property_len;
+ int length;
+ int error = EOK;
+ int i;
+
+ DEBUG_STRING("serialize","Entry point");
+
+ *dummy = 0;
+
+ /* Check is there is buffer. If not allocate */
+ buf_data = (struct serial_data *)(custom_data);
+ if(buf_data == (struct serial_data *)(NULL)) {
+ DEBUG_STRING("Error.","Storage data is not passed in!");
+ return EINVAL;
+ }
+ if(buf_data->buffer == NULL) {
+ DEBUG_STRING("First time use.","Allocating buffer.");
+ errno = 0;
+ buf_data->buffer = malloc(BLOCK_SIZE);
+ if(buf_data->buffer == NULL) {
+ DEBUG_NUMBER("Error. Failed to allocate memory. Errno: ",errno);
+ return errno;
+ }
+ *(buf_data->buffer)='\0';
+ buf_data->length=0;
+ buf_data->size = BLOCK_SIZE;
+ }
+
+ DEBUG_NUMBER("Buffer len: ", buf_data->length);
+ DEBUG_NUMBER("Buffer size: ", buf_data->size);
+ DEBUG_STRING("Buffer: ", buf_data->buffer);
+
+ /* Check the beginning of the collection */
+ if(type == ELAPI_TYPE_COLLECTION) {
+ DEBUG_STRING("Serializing collection: ", property_in);
+ DEBUG_STRING("First header. ", "");
+ if((error=put_marker(buf_data,"(",1))) return error;
+ property = TEXT_COLLECTION;
+ property_len = TEXT_COLLEN;
+ data = property_in;
+ length = property_len_in+1;
+ type=ELAPI_TYPE_STRING;
+ buf_data->nest_level++;
+ }
+ /* Check for subcollections */
+ else if(type==ELAPI_TYPE_COLLECTIONREF) {
+ /* Skip */
+ return EOK;
+ }
+ /* Check for the end of the collection */
+ else if(type==ELAPI_TYPE_END) {
+ if((buf_data->length>0) &&
+ (*(buf_data->buffer+buf_data->length-1) == ',')) {
+ buf_data->length--;
+ *(buf_data->buffer+buf_data->length) = '\0';
+ }
+ if(buf_data->nest_level>0) {
+ buf_data->nest_level--;
+ if((error=put_marker(buf_data,")",1))) return error;
+ }
+ return EOK;
+ }
+ else {
+ property = property_in;
+ property_len = property_len_in;
+ data = data_in;
+ length = length_in;
+ }
+
+ DEBUG_STRING("Property: ", property);
+ DEBUG_NUMBER("Property length: ", property_len);
+
+ /* Start with property and "=" */
+ if((error=put_marker(buf_data,property,property_len)) ||
+ (error=put_marker(buf_data,"=",1))) return error;
+
+ /* Get projected length of the item */
+ len = get_data_len(type,length);
+ DEBUG_NUMBER("Expected data length: ",len);
+ DEBUG_STRING("Buffer so far: ", buf_data->buffer);
+
+ /* Make sure we have enough space */
+ if((error=grow_buffer(buf_data,len))) return error;
+
+ /* Add the value */
+ switch(type) {
+ case ELAPI_TYPE_STRING:
+ /* No escaping for now */
+ len = copy_esc(buf_data->buffer+buf_data->length,(char *)(data),'"');
+ break;
+ case ELAPI_TYPE_BINARY:
+ *(buf_data->buffer+buf_data->length) = '\'';
+ for(i=0;i<length;i++) sprintf(buf_data->buffer+buf_data->length+i*2 + 1,"%02X",*((unsigned char *)(data+i)));
+ len = length * 2 + 1;
+ *(buf_data->buffer+buf_data->length + len) = '\'';
+ len++;
+ break;
+ case ELAPI_TYPE_INTEGER:
+ len = sprintf(buf_data->buffer+buf_data->length,"%d",*((int *)(data)));
+ break;
+ case ELAPI_TYPE_UNSIGNED:
+ len = sprintf(buf_data->buffer+buf_data->length,"%u",*((unsigned int *)(data)));
+ break;
+ case ELAPI_TYPE_LONG:
+ len = sprintf(buf_data->buffer+buf_data->length,"%ld",*((long *)(data)));
+ break;
+ case ELAPI_TYPE_ULONG:
+ len = sprintf(buf_data->buffer+buf_data->length,"%lu",*((unsigned long *)(data)));
+ break;
+ case ELAPI_TYPE_DOUBLE:
+ len = sprintf(buf_data->buffer+buf_data->length,"%.4f",*((double *)(data)));
+ break;
+ default:
+ *(buf_data->buffer+buf_data->length) = '\0';
+ len = 0;
+ break;
+ }
+
+ /* Adjust length */
+ buf_data->length+=len;
+ *(buf_data->buffer+buf_data->length) = '\0';
+
+ /* Always put a comma at the end */
+ if((error=put_marker(buf_data,",",1))) return error;
+
+
+ DEBUG_STRING("Data: ",buf_data->buffer);
+ DEBUG_STRING("serialize","Exit point");
+ return EOK;
+
+}
+
+
+/* Add item's data */
+int xml_add(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *custom_data,
+ int *dummy)
+{
+ int rc;
+ struct xml_data *buf_data;
+ int error = EOK;
+ char *data_xml;
+ char *name;
+
+ DEBUG_STRING("xml_add","Entry point");
+
+ *dummy = 0;
+
+ /* Check is there is buffer. If not allocate */
+ buf_data = (struct xml_data *)(custom_data);
+ if(buf_data == (struct xml_data *)(NULL)) {
+ DEBUG_STRING("Error.","Storage data is not passed in!");
+ return EINVAL;
+ }
+
+ /* Check if there is buffer allocated */
+ if(buf_data->buf == (xmlBufferPtr)(NULL)) {
+ DEBUG_STRING("xml_add", "First use - allocating memory");
+ buf_data->buf = xmlBufferCreate();
+ if (buf_data->buf == NULL) {
+ DEBUG_STRING("xml_add", "Error creating the xml buffer");
+ return ENOMEM;
+ }
+ DEBUG_NUMBER("Buffer allocated", buf_data->buf);
+ DEBUG_NUMBER("Buffer output", (buf_data->buf)->content);
+
+ /* Create a new XmlWriter for memory, with no compression.
+ * Remark: there is no compression for this kind of xmlTextWriter */
+ buf_data->writer = xmlNewTextWriterMemory(buf_data->buf, 0);
+ if (buf_data->writer == NULL) {
+ error = errno;
+ DEBUG_STRING("xml_add", "Error creating the xml writer");
+ xmlBufferFree(buf_data->buf);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return ENOMEM;
+ }
+
+ /* Start the document with the xml default for the version,
+ * encoding and the default for the standalone declaration. */
+ rc = xmlTextWriterStartDocument(buf_data->writer, NULL, NULL, NULL);
+ if (rc < 0) {
+ DEBUG_STRING("xml_add", "Error at xmlTextWriterStartDocument");
+ xmlFreeTextWriter(buf_data->writer);
+ xmlBufferFree(buf_data->buf);
+ buf_data->writer = (xmlTextWriterPtr)(NULL);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return EIO;
+ }
+ buf_data->given_name = NULL;
+ buf_data->level = 0;
+ }
+
+ DEBUG_STRING("current buffer:", (buf_data->buf)->content);
+ DEBUG_NUMBER("Writer", buf_data->writer);
+
+
+ /* Check the beginning of the collection */
+ if(type == ELAPI_TYPE_COLLECTION) {
+ DEBUG_STRING("XML collection start: ", property);
+ rc = xmlTextWriterStartElement(buf_data->writer, BAD_CAST ELEMENT_COLLECTION);
+ if (rc < 0) {
+ DEBUG_STRING("xml_add", "Error at xmlTextWriterStartElement");
+ xmlFreeTextWriter(buf_data->writer);
+ xmlBufferFree(buf_data->buf);
+ buf_data->writer = (xmlTextWriterPtr)(NULL);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return EIO;
+ }
+
+ if(buf_data->given_name != NULL) name = buf_data->given_name;
+ else name = property;
+ rc = xmlTextWriterWriteAttribute(buf_data->writer, BAD_CAST ATTRIBUTE_NAME, BAD_CAST property);
+ if (rc < 0) {
+ DEBUG_STRING("xml_add", "Error at xmlTextWriterWriteAttribute");
+ xmlFreeTextWriter(buf_data->writer);
+ xmlBufferFree(buf_data->buf);
+ buf_data->writer = (xmlTextWriterPtr)(NULL);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return EIO;
+ }
+
+ /* Make sure we track the level */
+ buf_data->level++;
+ }
+ /* Check for subcollections */
+ else if(type==ELAPI_TYPE_COLLECTIONREF) {
+ buf_data->given_name = property;
+ }
+ /* Check for the end of the collection */
+ else if(type==ELAPI_TYPE_END) {
+ buf_data->given_name = NULL;
+ buf_data->level--;
+ /* Check if this is the end of the whole collection */
+ if(buf_data->level == 0) {
+ rc = xmlTextWriterEndDocument(buf_data->writer);
+ if (rc < 0) {
+ DEBUG_STRING("xml_add", "Error at xmlTextWriterEndDocument");
+ xmlFreeTextWriter(buf_data->writer);
+ xmlBufferFree(buf_data->buf);
+ buf_data->writer = (xmlTextWriterPtr)(NULL);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return EIO;
+ }
+ }
+ else {
+ rc = xmlTextWriterFullEndElement(buf_data->writer);
+ if (rc < 0) {
+ DEBUG_STRING("xml_add", "Error at xmlTextWriterEndElement");
+ xmlFreeTextWriter(buf_data->writer);
+ xmlBufferFree(buf_data->buf);
+ buf_data->writer = (xmlTextWriterPtr)(NULL);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return EIO;
+ }
+ }
+ }
+ else {
+ DEBUG_STRING("Property: ", property);
+ DEBUG_NUMBER("Property length: ", property_len);
+
+ rc = xmlTextWriterStartElement(buf_data->writer, BAD_CAST ELEMENT_MEMBER);
+ if (rc < 0) {
+ DEBUG_STRING("xml_add", "Error at xmlTextWriterStartElement");
+ xmlFreeTextWriter(buf_data->writer);
+ xmlBufferFree(buf_data->buf);
+ buf_data->writer = (xmlTextWriterPtr)(NULL);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return EIO;
+ }
+
+ rc = xmlTextWriterWriteAttribute(buf_data->writer, BAD_CAST ATTRIBUTE_NAME, BAD_CAST property);
+ if (rc < 0) {
+ DEBUG_STRING("xml_add", "Error at xmlTextWriterWriteAttribute");
+ xmlFreeTextWriter(buf_data->writer);
+ xmlBufferFree(buf_data->buf);
+ buf_data->writer = (xmlTextWriterPtr)(NULL);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return EIO;
+ }
+
+ rc = xmlTextWriterWriteAttribute(buf_data->writer, BAD_CAST ATTRIBUTE_TYPE, BAD_CAST get_type(type));
+ if (rc < 0) {
+ DEBUG_STRING("xml_add", "Error at xmlTextWriterWriteAttribute");
+ xmlFreeTextWriter(buf_data->writer);
+ xmlBufferFree(buf_data->buf);
+ buf_data->writer = (xmlTextWriterPtr)(NULL);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return EIO;
+ }
+
+ /* Add the value */
+
+ switch(type) {
+ case ELAPI_TYPE_STRING:
+ data_xml = (char *)(data);
+ if(!xmlCheckUTF8((const unsigned char *)(data_xml))) data_xml = BAD_DATA;
+ rc = xmlTextWriterWriteString(buf_data->writer, BAD_CAST data_xml);
+ break;
+ case ELAPI_TYPE_BINARY:
+ rc = xmlTextWriterWriteBase64(buf_data->writer, (const char *)(data),0,length);
+ break;
+ case ELAPI_TYPE_INTEGER:
+ rc = xmlTextWriterWriteFormatString(buf_data->writer, "%d", *((int *)(data)));
+ break;
+ case ELAPI_TYPE_UNSIGNED:
+ rc = xmlTextWriterWriteFormatString(buf_data->writer, "%u", *((unsigned int *)(data)));
+ break;
+ case ELAPI_TYPE_LONG:
+ rc = xmlTextWriterWriteFormatString(buf_data->writer, "%ld", *((long *)(data)));
+ break;
+ case ELAPI_TYPE_ULONG:
+ rc = xmlTextWriterWriteFormatString(buf_data->writer, "%lu", *((unsigned long *)(data)));
+ break;
+ case ELAPI_TYPE_DOUBLE:
+ rc = xmlTextWriterWriteFormatString(buf_data->writer, "%.4f", *((double *)(data)));
+ break;
+ default:
+ rc = xmlTextWriterWriteString(buf_data->writer, BAD_CAST "");
+ break;
+ }
+
+ if (rc < 0) {
+ DEBUG_STRING("xml_add", "Error trying put data into XML");
+ xmlFreeTextWriter(buf_data->writer);
+ xmlBufferFree(buf_data->buf);
+ buf_data->writer = (xmlTextWriterPtr)(NULL);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return EIO;
+ }
+
+ rc = xmlTextWriterFullEndElement(buf_data->writer);
+ if (rc < 0) {
+ DEBUG_STRING("xml_add", "Error at xmlTextWriterFullEndElement");
+ xmlFreeTextWriter(buf_data->writer);
+ xmlBufferFree(buf_data->buf);
+ buf_data->writer = (xmlTextWriterPtr)(NULL);
+ buf_data->buf = (xmlBufferPtr)(NULL);
+ return EIO;
+ }
+
+ }
+
+ DEBUG_STRING("xml_add","Exit point");
+ return EOK;
+
+}
diff --git a/collection/elapi_util.h b/collection/elapi_util.h
new file mode 100644
index 0000000..f701e5c
--- /dev/null
+++ b/collection/elapi_util.h
@@ -0,0 +1,76 @@
+/* Copyright */
+
+#ifndef ELAPI_UTIL_H
+#define ELAPI_UTIL_H
+
+#include <libxml/xmlwriter.h>
+
+#define DEFAULT_ENCODING "ISO-8859-1"
+
+#define TEXT_COLLECTION "EVENT"
+#define TEXT_COLLEN 5
+
+#define ELEMENT_COLLECTION "MAP"
+#define ELEMENT_MEMBER "MEMBER"
+#define ATTRIBUTE_NAME "name"
+#define ATTRIBUTE_TYPE "type"
+#define COLLEN 3
+#define BLOCK_SIZE 1024
+
+#define ELAPI_TYPE_NAME_STRING "string"
+#define ELAPI_TYPE_NAME_BINARY "bin"
+#define ELAPI_TYPE_NAME_INTEGER "int"
+#define ELAPI_TYPE_NAME_UNSIGNED "uint"
+#define ELAPI_TYPE_NAME_LONG "long"
+#define ELAPI_TYPE_NAME_ULONG "ulong"
+#define ELAPI_TYPE_NAME_DOUBLE "double"
+#define ELAPI_TYPE_NAME_UNKNOWN "unknown"
+
+#define BAD_DATA "NOT UTF-8"
+
+
+struct serial_data {
+ char *buffer;
+ int size;
+ int length;
+ int nest_level;
+};
+
+
+struct xml_data {
+ xmlTextWriterPtr writer;
+ xmlBufferPtr buf;
+ char *given_name;
+ int level;
+};
+
+
+/* Calculate the potential size of the item */
+int get_data_len(int type, int length);
+
+/* Grow buffer to accomodate more space */
+int grow_buffer(struct serial_data *buf_data, int len);
+
+/* Specail function to add different formatting symbols to the output */
+int put_marker(struct serial_data *buf_data, void *data, int len);
+
+/* Serialization of data user handler */
+int serialize(char *property_in,
+ int property_len_in,
+ int type,
+ void *data_in,
+ int length_in,
+ void *custom_data,
+ int *dummy);
+
+/* Add item's data */
+int xml_add(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *custom_data,
+ int *dummy);
+
+
+#endif
diff --git a/configure.ac b/configure.ac
new file mode 100644
index 0000000..26350f2
--- /dev/null
+++ b/configure.ac
@@ -0,0 +1,13 @@
+AC_INIT([elapi], [0.0], [dpal@redhat.com])
+AC_CONFIG_SRCDIR([collection/elapi_collection.c])
+AM_INIT_AUTOMAKE([-Wall -Werror foreign])
+AC_PROG_CC
+AC_PROG_RANLIB
+#AC_PROG_LIBTOOL
+#AM_GNU_GETTEXT([external])
+AC_PROG_INSTALL
+
+AC_CONFIG_HEADERS([config.h])
+#AC_CONFIG_FILES([Makefile collection/Makefile dispatcher/Makefile ini/Makefile tools/Makefile sinks/Makefile sinks/stderr/Makefile sinks/syslog/Makefile])
+AC_CONFIG_FILES([Makefile tools/Makefile collection/Makefile])
+AC_OUTPUT
diff --git a/dispatcher/elapi_dispatcher.c b/dispatcher/elapi_dispatcher.c
new file mode 100644
index 0000000..cecf5bf
--- /dev/null
+++ b/dispatcher/elapi_dispatcher.c
@@ -0,0 +1,688 @@
+/* Copyright */
+
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+#include <errno.h>
+#include <sys/time.h>
+#include <dlfcn.h>
+#include "elapi_debug.h"
+#include "elapi_dispatcher.h"
+#include "elapi_collection.h"
+#include "elapi_sink.h"
+
+#define SINK_COLLECTION "sinks"
+
+char def_application_name[] = "unknown";
+
+char *default_sinks[] = { "ipa","kernel","syslog","file","stderr", NULL };
+
+
+/* Structure to pass data from logging function to sinks */
+struct sink_context {
+ struct collection_item *event;
+ struct dispatcher_handle *handle;
+ char *previous;
+ int previous_status;
+};
+
+/* The structure to hold a command and a result of the command execution */
+struct get_sink {
+ int action;
+ int found;
+};
+
+
+#ifdef ELAPI_LOG_DEBUG
+#define DEBUG_SINK(sink_data) print_sink(sink_data);
+#else
+#define DEBUG_SINK(sink_data) ;
+#endif
+
+/* Debug function */
+static void print_sink(struct sink_descriptor *sink_data)
+{
+ DEBUG_NUMBER("SINK data address",sink_data);
+ DEBUG_NUMBER("SINK data DBLOCK address",&(sink_data->dblock));
+ DEBUG_NUMBER("SINK data DBLOCK internals",(&(sink_data->dblock))->internal_data);
+}
+
+
+static void init_sink(struct sink_descriptor *sink_data, int status)
+{
+ int error;
+ struct timeval tv;
+
+ DEBUG_STRING("init_sink","Entry");
+ DEBUG_STRING("In init_sink application name:",sink_data->dblock.appname);
+
+ /* Pass in the data block storage */
+ error = (sink_data->sink_cpb_block).init_cb(&(sink_data->dblock));
+ DEBUG_NUMBER("DBLOCK in init_sink",&(sink_data->dblock));
+ if(error != EOK) {
+ DEBUG_NUMBER("Failed to initialize the sink:",error);
+ (void)gettimeofday(&tv,NULL);
+ sink_data->suspended = ELAPI_SINK_SUSPENDED;
+ sink_data->lasttry = tv.tv_sec;
+ }
+ else {
+ DEBUG_NUMBER("Initialized the sink. Status set to:",status);
+ sink_data->suspended = status;
+ sink_data->lasttry = 0;
+ }
+ DEBUG_SINK(sink_data);
+ DEBUG_STRING("init_sink","Exit");
+}
+
+static void wash_sink(struct sink_descriptor *sink_data)
+{
+ int error;
+ struct timeval tv;
+
+ DEBUG_STRING("wash_sink","Entry");
+ DEBUG_NUMBER("Descriptor",sink_data);
+ DEBUG_NUMBER("Capability",&(sink_data->sink_cpb_block));
+ DEBUG_NUMBER("Callback",(sink_data->sink_cpb_block).close_cb);
+ DEBUG_NUMBER("DBLOCK in wash",&(sink_data->dblock));
+
+ /* Pass in the data block storage */
+ (sink_data->sink_cpb_block).close_cb(&(sink_data->dblock));
+
+ DEBUG_STRING("wash_sink","Exit");
+}
+
+
+/* Function to load sink library */
+static int load_sink(struct sink_descriptor *sink_data,char *sink_name)
+{
+ char sink_lib_name[SINK_LIB_NAME_SIZE];
+ capability_fn get_lib_info;
+ void *lib_handle;
+ char *lib_error;
+ int error = EOK;
+
+ DEBUG_STRING("load_sink","Entry");
+
+ sprintf(sink_lib_name,SINK_NAME_TEMPLATE,sink_name);
+ DEBUG_STRING("Name of the library to load",sink_lib_name);
+
+ /* Load library */
+ sink_data->lib_handle = dlopen (sink_lib_name, RTLD_LAZY);
+ if (!(sink_data->lib_handle)) {
+ DEBUG_STRING("Dlopen returned error",dlerror());
+ return ELIBACC;
+ }
+
+ /* Clear any existing error */
+ dlerror();
+ /* Get addres to the main entry point */
+ get_lib_info = (capability_fn)(dlsym(sink_data->lib_handle, SINK_ENTRY_POINT));
+ if ((lib_error = dlerror()) != NULL) {
+ DEBUG_STRING("Dlsym returned error",lib_error);
+ return ELIBACC;
+ }
+
+ /* Init data */
+ get_lib_info(&(sink_data->sink_cpb_block));
+
+ /* Call library initialization function */
+ init_sink(sink_data,ELAPI_SINK_OK);
+
+ /* If we return ELIBACC it would indicate that the desired library is missing */
+
+ DEBUG_STRING("load_sink","Returning Success");
+ return EOK;
+}
+
+
+/* Function to add a sink in the list */
+static int add_sink_to_list(struct collection_item *sink_list,
+ char *sink,
+ char *appname)
+{
+ int error = EOK;
+ int found = 0;
+ struct sink_descriptor sink_data;
+
+ DEBUG_STRING("add_sink_to_list","Entry");
+ error = is_item_in_collection(sink_list,
+ sink,
+ ELAPI_TYPE_ANY,
+ ELAPI_TRAVERSE_DEFAULT,
+ &found);
+ if(error) {
+ DEBUG_NUMBER("Search returned error",error);
+ return error;
+ }
+
+ /* Check if it was found */
+ if(found) {
+ DEBUG_STRING("Attempt to add an exiting sink.","");
+ return EINVAL;
+ }
+
+ /* Save the pointer to application name into the sink's data block */
+ sink_data.dblock.appname = appname;
+ DEBUG_STRING("add_sink_to_list - saving appname:",sink_data.dblock.appname);
+
+ /* Try to load the sink library */
+ error = load_sink(&sink_data,sink);
+ if(error != 0) {
+ DEBUG_NUMBER("Failed to load sink",error);
+ return error;
+ }
+
+ /* We got a valid sink so add it to the collection */
+ error=add_binary_property(sink_list,NULL,
+ sink,(void *)(&sink_data),
+ sizeof(struct sink_descriptor));
+ if(error != 0) {
+ DEBUG_NUMBER("Failed to add sink data as property",error);
+ return error;
+ }
+
+ DEBUG_NUMBER("add_sink_to_list returning",error);
+ return error;
+}
+
+/* Handler to change the sink status data */
+static int update_sink_handle(char *sink,
+ int sink_len,
+ int type,
+ void *data,
+ int length,
+ void *passed_data,
+ int *stop)
+{
+ int error = EOK;
+ struct sink_descriptor *sink_data;
+ struct get_sink *get_sink_op;
+
+ DEBUG_STRING("update_sink_handler","Entry.");
+
+ sink_data = (struct sink_descriptor *)(data);
+ get_sink_op = (struct get_sink *)(passed_data);
+
+ switch(get_sink_op->action) {
+ case ELAPI_SINK_ACTION_DISABLE:
+ DEBUG_STRING("Disabling sink:",sink);
+ wash_sink(sink_data);
+ sink_data->suspended = ELAPI_SINK_DISABLED;
+ break;
+ case ELAPI_SINK_ACTION_ENABLE:
+ DEBUG_STRING("Enabling sink:",sink);
+ wash_sink(sink_data);
+ /* Init sink will set the correct status */
+ init_sink(sink_data,ELAPI_SINK_OK);
+ break;
+ case ELAPI_SINK_ACTION_PULSE:
+ DEBUG_STRING("Pulsing sink:",sink);
+ wash_sink(sink_data);
+ init_sink(sink_data,ELAPI_SINK_PULSE);
+ break;
+ default:
+ DEBUG_STRING("update_sink_handler","ERROR Invalid argument");
+ return EINVAL;
+ }
+
+ *stop = 1;
+ /* Indicate that we found item */
+ get_sink_op->found = 1;
+
+ DEBUG_STRING("update_sink_handler","Return.");
+ return EOK;
+}
+
+/* Handler to clean sinks at the end */
+static int close_sink_handler(char *sink,
+ int sink_len,
+ int type,
+ void *data,
+ int length,
+ void *passed_data,
+ int *stop)
+{
+ int error = EOK;
+ struct sink_descriptor *sink_data;
+
+ DEBUG_STRING("close_sink_handler","Entry.");
+ DEBUG_STRING("Sink:",sink);
+
+ if(type == ELAPI_TYPE_COLLECTION) return EOK;
+
+ sink_data = (struct sink_descriptor *)(data);
+
+ wash_sink(sink_data);
+
+ if(sink_data->lib_handle != NULL) {
+ DEBUG_STRING("Closing lib handle","");
+ dlclose(sink_data->lib_handle);
+ sink_data->lib_handle = NULL;
+ }
+
+ DEBUG_STRING("close_sink_handler","Return.");
+ return EOK;
+}
+
+
+/* Handler for logging through the sinks */
+static int sink_handler(char *sink,
+ int sink_len,
+ int type,
+ void *data,
+ int length,
+ void *passed_data,
+ int *stop)
+{
+ struct sink_context *sink_env;
+ struct sink_descriptor *sink_data;
+ int status = 0;
+ int error = EOK;
+ struct timeval tv;
+
+ DEBUG_STRING("sink_handler","Entry.");
+ DEBUG_STRING("Sink:",sink);
+
+ sink_env = (struct sink_context *)(passed_data);
+ sink_data = (struct sink_descriptor *)(data);
+
+ /* When porcessing header just initialize and continue */
+ if(type == ELAPI_TYPE_COLLECTION) {
+ sink_env->previous = NULL;
+ sink_env->previous_status = 0;
+ return error;
+ }
+
+ /* Check if the sink is healthy to use */
+ if(sink_data->suspended!= ELAPI_SINK_OK) {
+ DEBUG_NUMBER("Sink is suspended:",sink_data->suspended);
+ if(sink_data->suspended == ELAPI_SINK_DISABLED) {
+ DEBUG_STRING("Sink is suspended by caller. Skipping sink.",sink);
+ return EOK;
+ }
+ if(sink_data->suspended == ELAPI_SINK_PULSE) {
+ DEBUG_STRING("Sink is suspended by caller for one time. Skipping sink but resetting to Ok.",sink);
+ sink_data->suspended = ELAPI_SINK_OK;
+ return EOK;
+ }
+ if(sink_data->suspended == ELAPI_SINK_SUSPENDED) {
+ DEBUG_STRING("Sink is suspended is it time to retry.",sink);
+ /* Is the sink permanently suspended ? */
+ if((sink_data->sink_cpb_block).retry_interval == SINK_NEVER_RETRY) {
+ DEBUG_STRING("Sink is suspended forever since the sink tells not to retry.",sink);
+ /* For future: should we delete the sink ?*/
+ /* IMO we should not becuase the calling
+ * application can potentially do something to fix the issue and
+ * explicitely re-enable the sink after it. */
+ return EOK;
+ }
+ /* Check interval */
+ (void)gettimeofday(&tv,NULL);
+ if(difftime(tv.tv_sec,sink_data->lasttry + (sink_data->sink_cpb_block).retry_interval) < 0) {
+ DEBUG_STRING("Sink is suspended is it not time to retry.",sink);
+ return EOK;
+ }
+
+ /* Time to retry a suspended sink */
+ init_sink(sink_data,ELAPI_SINK_OK);
+ if(sink_data->suspended == ELAPI_SINK_SUSPENDED) {
+ DEBUG_STRING("Sink is still suspended. Problem still exists.",sink);
+ return EOK;
+ }
+
+ }
+ else {
+ DEBUG_STRING("Status is invalid for sink.",sink);
+ return EINVAL;
+ }
+ }
+
+
+ /* Call router function */
+ status = (sink_env->handle)->router(sink,
+ sink_env->previous,
+ sink_env->previous_status,
+ sink_env->event,
+ sink_data,
+ (sink_env->handle)->custom_data,
+ &error);
+ /* Check the status */
+ switch(status) {
+ case ELAPI_DISPATCHER_SKIP: /* Ignore current sink as if it is abcent */
+ DEBUG_STRING("Ignoring sink.",sink);
+ /* Do not change suspended status */
+ /* Do not change previous fields */
+ break;
+ case ELAPI_DISPATCHER_DONE: /* Sink is done with this event */
+ DEBUG_STRING("Done with this event.",sink);
+ *stop = 1;
+ sink_data->suspended = ELAPI_SINK_OK;
+ break;
+ case ELAPI_DISPATCHER_NEXT: /* Sink thinks somone else would want to log this event */
+ DEBUG_STRING("Go to the next sink.",sink);
+ sink_env->previous = sink;
+ sink_env->previous_status = status;
+ sink_data->suspended = ELAPI_SINK_OK;
+ break;
+ case ELAPI_DISPATCHER_ERROR: /* An error occured */
+ DEBUG_NUMBER("Go to the next sink due to error.",error);
+
+ /* FIXME: In future may be store the error and log it later
+ * when the sink recovers from failure.
+ * Alternatively may be log it into another sink. */
+
+ /* Record the fact that the sink returned error */
+ sink_env->previous = sink;
+ sink_env->previous_status = status;
+
+ /* Suspend this sink */
+ sink_data->suspended = ELAPI_SINK_SUSPENDED;
+ sink_data->lasttry=tv.tv_sec;
+ wash_sink(sink_data);
+ break;
+
+ default: /* This should not happen - codding error */
+ DEBUG_STRING("Status is invalid for sink.",sink);
+ return EINVAL;
+ }
+
+ DEBUG_STRING("sink_handler","Success Exit.");
+
+ return EOK;
+}
+
+
+/* Router function returns status not error */
+static int default_router(char *sink,
+ char *previous_sink,
+ int previous_status,
+ struct collection_item *event,
+ struct sink_descriptor *sink_data,
+ void *custom_data,
+ int *error)
+{
+ DEBUG_STRING("default_router","Entry");
+
+ /* FIXME
+ * default implementation of the routing function:
+ * Log every event into every facility regardless
+ * of the outcome.
+ */
+
+
+ *error = log_event_to_sink(sink_data,event,custom_data);
+
+
+
+ DEBUG_STRING("default_router","Returning");
+ return ELAPI_DISPATCHER_NEXT;
+}
+
+
+
+/* ================== SINK LIST MANAGEMENT ======================== */
+
+/* Function to create a list of sinks */
+static int construct_sink_list(struct dispatcher_handle *handle)
+{
+ int error = EOK;
+ char **current_sink;
+
+ DEBUG_STRING("construct_sink_list","Entry");
+
+ /* Allocate collection to store sinks */
+ error=create_collection(&(handle->sink_list),SINK_COLLECTION);
+ if(error != 0) {
+ DEBUG_NUMBER("Failed to create sink collection. Error",error);
+ /* No cleanup here.
+ * The calling function will call a cleanup
+ * of the dispatcher as a whole.*/
+ return error;
+ }
+
+ current_sink = handle->sinks;
+ handle->sink_counter = 0;
+
+ /* Add sinks as properties to the sink collection */
+ while (*current_sink != NULL) {
+
+ DEBUG_STRING("Current sink",*current_sink);
+ DEBUG_STRING("Will use appname:",handle->appname);
+
+ /* Load sink */
+ error = add_sink_to_list(handle->sink_list,*current_sink,handle->appname);
+ if((error != 0) && (error != ELIBACC)) {
+ DEBUG_NUMBER("Failed to add sink",error);
+ /* No cleanup here. */
+ return error;
+ }
+
+ handle->sink_counter++;
+ current_sink++;
+ }
+
+ /* Check if we have any sinks available */
+ if(handle->sink_counter == 0) {
+ DEBUG_NUMBER("No sinks","");
+ /* No cleanup here. */
+ /* Return "Cannot access a needed shared library" */
+ return ELIBACC;
+ }
+
+ DEBUG_STRING("construct_sink_list","Returning success");
+ return EOK;
+}
+
+/* Function to delete sink list collection */
+static void delete_sink_list(struct dispatcher_handle *handle)
+{
+ DEBUG_STRING("delete_sink_list","Entry point");
+ if(handle->sink_list != (struct collection_item *)(NULL)) {
+ DEBUG_STRING("delete_sink_list","Deleting sink collection");
+ destroy_collection(handle->sink_list);
+ }
+ DEBUG_STRING("delete_sink_list","Exit");
+}
+
+
+/* ========================= MAIN INTERFACE FUNCTIONS ============================ */
+
+/* Function to create an audit dispatcher */
+int create_audit_dispatcher(struct dispatcher_handle **dispatcher,
+ const char *appname,
+ char **desired_sinks,
+ event_router_fn desired_router,
+ void *custom_data)
+{
+ struct dispatcher_handle *handle;
+ int error = EOK;
+
+ DEBUG_STRING("create_audit_dispatcher","Entry point");
+
+ /* Make sure the memory for handle is passed in */
+ if(dispatcher == (struct dispatcher_handle **)(NULL)) {
+ DEBUG_STRING("create_audit_dispatcher","Invalid parameter.");
+ return EINVAL;
+ }
+
+ /* Allocate memory */
+ handle = (struct dispatcher_handle *) malloc(sizeof(struct dispatcher_handle));
+ if(handle == (struct dispatcher_handle *)(NULL)) {
+ error = errno;
+ DEBUG_NUMBER("Memory allocation failed. Error",error);
+ return error;
+ }
+
+ /* Save application name in the handle */
+ if(appname != NULL) handle->appname = strdup(appname);
+ else handle->appname = strdup(def_application_name);
+
+ DEBUG_STRING("Application name:",handle->appname);
+
+ /* Check error */
+ if(handle->appname == NULL) {
+ error = errno;
+ DEBUG_NUMBER("Memory allocation failed. Error",error);
+ return error;
+ }
+
+ /* Check if there is no desired sinks provided */
+ if(desired_sinks != (char **)(NULL)) handle->sinks = desired_sinks;
+ else handle->sinks = default_sinks;
+
+ /* Check the router. If it is empty use the default router */
+ if(desired_router != (event_router_fn)(NULL)) handle->router = desired_router;
+ else handle->router = default_router;
+
+ handle->custom_data = custom_data;
+
+ /* Create the list of sinks */
+ error = construct_sink_list(handle);
+ if(error != EOK) {
+ DEBUG_NUMBER("Failed to create sink list. Error",error);
+ destroy_audit_dispatcher(handle);
+ return error;
+ }
+
+ *dispatcher = handle;
+
+ DEBUG_STRING("create_audit_dispatcher","Returning Success.");
+ return EOK;
+}
+
+/* Function to clean memory associated with the audit dispatcher */
+void destroy_audit_dispatcher(struct dispatcher_handle *dispatcher)
+{
+ DEBUG_STRING("destroy_audit_dispatcher","Entry");
+ if(dispatcher != (struct dispatcher_handle *)(NULL)) {
+ /* Offload libs */
+ (void)traverse_collection(dispatcher->sink_list,ELAPI_TRAVERSE_ONELEVEL,close_sink_handler,(void *)(NULL));
+ DEBUG_STRING("Deleting sink list.","");
+ delete_sink_list(dispatcher);
+ DEBUG_STRING("Freeing application name.","");
+ free((void *)(dispatcher->appname));
+ DEBUG_STRING("Freeing dispatcher.","");
+ free((void *)(dispatcher));
+ }
+ DEBUG_STRING("destroy_audit_dispatcher","Exit");
+}
+
+
+
+/* Log evento into a specific sink */
+int log_event_to_sink(struct sink_descriptor *sink_data,
+ struct collection_item *event,
+ void *custom_data)
+{
+ int error = EOK;
+ struct sink_capability *sink_cpb;
+
+ DEBUG_STRING("log_event_to_sink","Entry");
+
+ sink_cpb = &(sink_data->sink_cpb_block);
+
+ DEBUG_NUMBER("DBLOCK in dispatcher",&(sink_data->dblock));
+ DEBUG_NUMBER("internal data in dispatcher",(&(sink_data->dblock))->internal_data);
+ DEBUG_SINK(sink_data);
+
+ /* Format (serialize the event) */
+ error = sink_cpb->format_cb(&(sink_data->dblock),event);
+ if(error != EOK) {
+ DEBUG_NUMBER("Format function returned error",error);
+ return error;
+ }
+
+ /* Submit the event */
+ error = sink_cpb->submit_cb(&(sink_data->dblock));
+ DEBUG_NUMBER("Format function returned error",error);
+
+ /* Clean internal per event data in any case */
+ sink_cpb->cleanup_cb(&(sink_data->dblock));
+
+ DEBUG_STRING("log_event_to_sink","Return");
+ return error;
+
+}
+
+
+/* Function to clean memory associated with the audit dispatcher */
+void log_audit_event(struct dispatcher_handle *dispatcher, struct collection_item *event)
+{
+ struct sink_context sink_env;
+
+ DEBUG_STRING("log_audit_event","Entry");
+ if((dispatcher == (struct dispatcher_handle *)(NULL)) ||
+ (event == (struct collection_item *)(NULL))) {
+ DEBUG_STRING("log_audit_event","ERROR Invalid argument");
+ DEBUG_NUMBER("Dispatcher",dispatcher);
+ DEBUG_NUMBER("Event",event);
+ DEBUG_STRING("log_audit_event","ERROR Return");
+ return;
+ }
+
+ sink_env.handle = dispatcher;
+ sink_env.event = event;
+
+ /* Logging an event is just iterating through the sinks and calling the sink_handler */
+ (void)traverse_collection(dispatcher->sink_list,ELAPI_TRAVERSE_ONELEVEL,sink_handler,(void *)(&sink_env));
+
+ DEBUG_STRING("log_audit_event","Return");
+}
+
+/* Managing the sink collection */
+int alter_audit_dispatcher(struct dispatcher_handle *dispatcher,
+ char *sink,
+ int action)
+{
+ int error;
+ struct get_sink get_sink_op;
+
+ DEBUG_STRING("alter_audit_dispatcher","Entry");
+ if((dispatcher == (struct dispatcher_handle *)(NULL)) ||
+ (sink == (char *)(NULL))) {
+ DEBUG_STRING("log_audit_event","ERROR Invalid argument");
+ DEBUG_NUMBER("Dispatcher",dispatcher);
+ DEBUG_NUMBER("Sink",sink);
+ DEBUG_STRING("log_audit_event","ERROR Return");
+ return EINVAL;
+ }
+
+ switch(action) {
+ case ELAPI_SINK_ACTION_ADD:
+ /* Try to add it and return whatever the attmpt returned */
+ error = add_sink_to_list(dispatcher->sink_list,sink,dispatcher->appname);
+ DEBUG_NUMBER("alter_audit_dispatcher ADD returning",error);
+ return error;
+ case ELAPI_SINK_ACTION_DELETE:
+ /* Try to delete the sink */
+ error = delete_property(dispatcher->sink_list,
+ sink,
+ ELAPI_TYPE_ANY,
+ ELAPI_TRAVERSE_DEFAULT);
+ DEBUG_NUMBER("alter_audit_dispatcher DELETE returning",error);
+ return error;
+ case ELAPI_SINK_ACTION_DISABLE:
+ case ELAPI_SINK_ACTION_ENABLE:
+ case ELAPI_SINK_ACTION_PULSE:
+ /* Try to modify the sink */
+ get_sink_op.action = action;
+ get_sink_op.found = 0;
+ error = get_item_and_do(dispatcher->sink_list,
+ sink,
+ ELAPI_TYPE_ANY,
+ ELAPI_TRAVERSE_DEFAULT,
+ update_sink_handle,
+ (void *)(&get_sink_op));
+ if(get_sink_op.found == 0) {
+ DEBUG_STRING("alter_audit_dispatcher DISABLE/ENABLE/PULSE sink not found","");
+ return EINVAL;
+ }
+ DEBUG_NUMBER("alter_audit_dispatcher DISABLE/ENABLE/PULSE returning",error);
+ return error;
+ default:
+ DEBUG_STRING("alter_audit_dispatcher","Invalid action");
+ return EINVAL;
+ }
+
+ /* Unreachable */
+}
diff --git a/dispatcher/elapi_dispatcher.h b/dispatcher/elapi_dispatcher.h
new file mode 100644
index 0000000..909505a
--- /dev/null
+++ b/dispatcher/elapi_dispatcher.h
@@ -0,0 +1,68 @@
+/* Copyright */
+
+#ifndef ELAPI_DISPATCHER_H
+#define ELAPI_DISPATCHER_H
+
+#include "elapi_collection.h"
+#include "elapi_sink.h"
+
+/* Status values returned by the routing function */
+#define ELAPI_DISPATCHER_SKIP 0
+#define ELAPI_DISPATCHER_DONE 1
+#define ELAPI_DISPATCHER_NEXT 2
+#define ELAPI_DISPATCHER_ERROR 3
+
+
+/* Actions that can be taken against a sink */
+#define ELAPI_SINK_ACTION_ADD 0 /* Add a new sink */
+#define ELAPI_SINK_ACTION_DELETE 1 /* Delete a sink */
+#define ELAPI_SINK_ACTION_DISABLE 2 /* Disable a sink */
+#define ELAPI_SINK_ACTION_PULSE 3 /* Disable a sink temporarily for one call */
+#define ELAPI_SINK_ACTION_ENABLE 4 /* Enable sink */
+
+
+/* Event routing function */
+typedef int (*event_router_fn)(char *sink,
+ char *previous_sink,
+ int previous_status,
+ struct collection_item *event,
+ struct sink_descriptor *sink_data,
+ void *custom_data,
+ int *error);
+
+struct dispatcher_handle {
+ char **sinks;
+ char *appname;
+ event_router_fn router;
+ struct collection_item *sink_list;
+ int sink_counter;
+ void *custom_data;
+};
+
+/* Function to create a dispatcher */
+int create_audit_dispatcher(struct dispatcher_handle **dispatcher, /* Handle of the dispatcher will be stored in this variable */
+ const char *appname, /* Application name. Passed to the sinks to do initialization */
+ char **desired_sinks, /* List of names of the sinks to use. If NULL the default will be used */
+ event_router_fn desired_router, /* The rounting function. If NULL the default will be used */
+ void *custom_data); /* Custom data that can be used in the router function. */
+
+
+/* Function to clean memory associated with the audit dispatcher */
+void destroy_audit_dispatcher(struct dispatcher_handle *dispatcher);
+
+/* Function to log an event */
+void log_audit_event(struct dispatcher_handle *dispatcher, struct collection_item *event);
+
+/* Advanced functions */
+/* Managing the sink collection */
+int alter_audit_dispatcher(struct dispatcher_handle *dispatcher, /* Dispatcher */
+ char *sink, /* Sink to change */
+ int action); /* Action to perform for sink */
+
+/* This function is exposed in case you are providing your own routing callback */
+int log_event_to_sink(struct sink_descriptor *sink_data,
+ struct collection_item *event,
+ void *custom_data);
+
+
+#endif
diff --git a/dispatcher/elapi_dispatcher_ut.c b/dispatcher/elapi_dispatcher_ut.c
new file mode 100644
index 0000000..119d40a
--- /dev/null
+++ b/dispatcher/elapi_dispatcher_ut.c
@@ -0,0 +1,201 @@
+/* Copyright */
+
+#include <stdio.h>
+#include <malloc.h>
+#include "elapi_dispatcher.h"
+#include "elapi_collection.h"
+#include "elapi_debug.h"
+#include "elapi_util.h"
+#include "elapi_tools.h"
+
+struct collection_item *event;
+struct collection_item *peer;
+struct collection_item *socket;
+struct collection_item *host;
+
+
+int construct_event()
+{
+ char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
+ int found = 0;
+
+ int error = EOK;
+
+ DEBUG_STRING("construct_event","Entry.");
+
+ if((error=create_collection(&peer,"peer")) ||
+ (error=add_str_property(peer,NULL,"hostname","peerhost.mytest.com",0)) ||
+ (error=add_str_property(peer,NULL,"IPv4","10.10.10.10",12)) || /* Expect trailing zero to be truncated */
+ (error=add_str_property(peer,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ return error;
+ }
+
+ if((error=create_collection(&host,"host")) ||
+ (error=add_str_property(host,NULL,"hostname","myhost.mytest.com",0)) ||
+ (error=add_str_property(host,NULL,"IPv4","20.20.20.20",13)) ||
+ (error=add_str_property(host,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ destroy_collection(host);
+ return error;
+ }
+
+
+ if((error=create_collection(&socket,"socket")) ||
+ (error=add_int_property(socket,NULL,"id",1)) ||
+ (error=add_long_property(socket,NULL,"packets",100000000L)) ||
+ (error=add_binary_property(socket,NULL,"stack",binary_dump,sizeof(binary_dump)))) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ /* Embed peer host into the socket2 as reference */
+ error = add_collection_to_collection(socket,NULL,"peer",peer,ELAPI_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket);
+ printf("Failed to create collection. Error %d\n",error);
+ return error;
+ }
+
+ /* Construct event */
+ if((error=create_collection(&event,"event")) ||
+ (error=add_str_property(event,NULL,"escape1","ds\\sd=ewrw===sada",0)) ||
+ (error=add_str_property(event,NULL,"escape2","dss,d,=,ewrw===sada",0)) ||
+ (error=add_str_property(event,NULL,"escape3","ds\\sd=ewrw,()===sada",0)) ||
+ (error=add_str_property(event,NULL,"escape4","dssd=ewrw===))))sada",0)) ||
+ (error=add_str_property(event,NULL,"escape5","d\\ss(((((d=ew(()()()(),(,,\\\\\\\\rw===sada",0)) ||
+ (error=add_int_property(event,NULL,"something",100))) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket);
+ destroy_collection(event);
+ printf("Failed to create collection. Error %d\n",error);
+ return error;
+ }
+
+ /* Add host to event */
+ error = add_collection_to_collection(event,NULL,NULL,host,ELAPI_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket);
+ destroy_collection(event);
+ printf("Failed to add collections. Error %d\n",error);
+ return error;
+ }
+
+ error = add_collection_to_collection(event,NULL,NULL,socket,ELAPI_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket);
+ destroy_collection(event);
+ printf("Failed to add collections. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(event,ELAPI_TRAVERSE_DEFAULT);
+
+ return EOK;
+}
+
+
+int main()
+{
+ int error = EOK;
+ struct dispatcher_handle *dispatcher;
+ char *sinks[]= { "foo", "stderr", "bar", NULL };
+
+ printf("Test start\n");
+
+
+ error = create_audit_dispatcher(&dispatcher,"my_app",sinks,NULL,NULL);
+ printf("create_audit_dispatcher returned %d\n", error);
+
+ /* Try to log with invalid parameters */
+ printf("%s","=================\nNegative test1\n");
+ log_audit_event(NULL, NULL);
+ printf("%s","=================\nNegative test2\n");
+ log_audit_event(dispatcher, NULL);
+
+ printf("%s","=================\nCreating collection\n");
+ error = construct_event();
+ if(error) {
+ printf("Error creating event %d\n",error);
+ return error;
+ }
+
+
+ printf("%s","=================\nLogging peer - expect success\n");
+ print_collection(peer);
+ log_audit_event(dispatcher, peer);
+ printf("%s","=================\nLogging host - expect success\n");
+ print_collection(host);
+ log_audit_event(dispatcher, host);
+ printf("%s","=================\nLogging socket - expect success\n");
+ print_collection(socket);
+ log_audit_event(dispatcher, socket);
+ printf("%s","=================\nLogging event - expect success\n");
+ print_collection(event);
+ log_audit_event(dispatcher, event);
+
+ /* Try to alter list of sinks */
+ printf("%s","=================\nSeries of negative test cases.\n");
+ /* Deleting non exisintg sink */
+ error = alter_audit_dispatcher(dispatcher,"far2",ELAPI_SINK_ACTION_DELETE);
+ if(error == 0) printf("%s","Expected failure got success\n");
+ else printf("Expected failure. Error : %d\n",error);
+
+ /* Editing non exisintg sink */
+ error = alter_audit_dispatcher(dispatcher,"far2",ELAPI_SINK_ACTION_ENABLE);
+ if(error == 0) printf("%s","Expected failure got success\n");
+ else printf("Expected failure. Error : %d\n",error);
+
+ /* Adding duplicate */
+ error = alter_audit_dispatcher(dispatcher,"bar",ELAPI_SINK_ACTION_ADD);
+ if(error == 0) printf("%s","Expected failure got success\n");
+ else printf("Expected failure. Error : %d\n",error);
+
+ /* Adding new */
+ error = alter_audit_dispatcher(dispatcher,"far2",ELAPI_SINK_ACTION_ADD);
+ if(error != 0) printf("Expected success got failure %d\n",error);
+ else printf("Success : %d\n",error);
+
+ /* Enable */
+ error = alter_audit_dispatcher(dispatcher,"far2",ELAPI_SINK_ACTION_ENABLE);
+ if(error != 0) printf("Expected success got failure %d\n",error);
+ else printf("Success : %d\n",error);
+
+ /* Pulse */
+ error = alter_audit_dispatcher(dispatcher,"far2",ELAPI_SINK_ACTION_PULSE);
+ if(error != 0) printf("Expected success got failure %d\n",error);
+ else printf("Success : %d\n",error);
+
+ /* Disable */
+ error = alter_audit_dispatcher(dispatcher,"far2",ELAPI_SINK_ACTION_DISABLE);
+ if(error != 0) printf("Expected success got failure %d\n",error);
+ else printf("Success : %d\n",error);
+
+ /* Delete */
+ error = alter_audit_dispatcher(dispatcher,"far2",ELAPI_SINK_ACTION_DELETE);
+ if(error != 0) printf("Expected success got failure %d\n",error);
+ else printf("Success : %d\n",error);
+
+ destroy_audit_dispatcher(dispatcher);
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket);
+ destroy_collection(event);
+ printf("Test end\n");
+ return error;
+}
+
+
+
diff --git a/etc/syslog_defaults.conf b/etc/syslog_defaults.conf
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/etc/syslog_defaults.conf
diff --git a/ini/elapi.conf b/ini/elapi.conf
new file mode 100644
index 0000000..d8553c6
--- /dev/null
+++ b/ini/elapi.conf
@@ -0,0 +1,41 @@
+
+data = ds,mf.ds,mf.ds,m.ds,mds.,fmds.
+ dskjh = mdsmdssm ,md.sd,
+ C1 = "abcd"
+;test data
+
+
+
+;more data
+
+ = "nmjdsbfmsdn"
+ s = "nmjdsbfmsdn
+
+ HEX1 = 'ABV1'
+ HEX2 = 'ABV'
+ [ ttt ]
+
+C2 ='Ab'
+
+int=-44i44
+int2=-66U
+
+c =
+
+
+ [ dddd ]
+
+DC1 = 123U
+
+f=-9.0.0
+DC2 = -235L
+DC3 = -345.8907
+
+
+ [ ttt ]
+
+v=55555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555
+v1=55555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555.55555555555555555555555555555555
+
+C3 = -34756.56
+C4 = .9
diff --git a/ini/elapi.d/test.conf b/ini/elapi.d/test.conf
new file mode 100644
index 0000000..68e9c67
--- /dev/null
+++ b/ini/elapi.d/test.conf
@@ -0,0 +1,41 @@
+
+data = ds,mf.ds,mf.ds,m.ds,mds.,fmds.
+ dskjh = mdsmdssm ,md.sd,
+ C1 = "abcd"
+;test data
+
+
+
+;more data
+
+ = "nmjdsbfmsdn"
+ s = "nmjdsbfmsdn
+
+ HEX1 = 'ABV1'
+ HEX2 = 'ABV'
+ [ ttt ]
+
+C2 ='AbBB'
+
+int=-44i44
+int2=-66U
+
+c =
+
+
+ [ dddd1 ]
+
+DC1 = 123U
+
+f=-9.0.0
+DC2 = -235L
+DC3 = -345.8907
+
+
+ [ ttt2 ]
+
+v=55555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555
+v1=55555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555.55555555555555555555555555555555
+
+C3 = -34756.56
+C4 = .9
diff --git a/ini/elapi_ini.c b/ini/elapi_ini.c
new file mode 100644
index 0000000..acea402
--- /dev/null
+++ b/ini/elapi_ini.c
@@ -0,0 +1,626 @@
+/* Copyright */
+
+#include <stdio.h>
+#include <errno.h>
+#include <string.h>
+#include <ctype.h>
+#include <stdlib.h>
+#include "elapi_collection.h"
+#include "elapi_debug.h"
+#include "elapi_ini.h"
+
+/* STATIC INTERNAL FUNCTIONS */
+
+#define RET_PAIR 0
+#define RET_COMMENT 1
+#define RET_SECTION 2
+#define RET_INVALID 3
+#define RET_EMPTY 4
+#define RET_EOF 5
+#define RET_ERROR 6
+
+
+#define NAME_OVERHEAD 10
+#define MAX_KEY 65535
+#define MAX_VALUE 65535
+#define BUFFER_SIZE MAX_KEY + MAX_VALUE + 3
+
+#define SLASH "/"
+
+
+/* Special handler to extract configuration value */
+static int value_extractor(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *custom_data,
+ int *stop)
+{
+ void *allocated = NULL;
+
+ DEBUG_STRING("value_extractor","Entry.");
+ DEBUG_STRING("Property:",property);
+ DEBUG_NUMBER("Property length:",property_len);
+ DEBUG_NUMBER("Type:",type);
+ DEBUG_NUMBER("Length:",length);
+
+ allocated = malloc(length);
+ if(allocated == NULL) return errno;
+ memcpy(allocated, data, length);
+
+ *((int **)(custom_data)) = allocated;
+ *stop = 1;
+
+ DEBUG_STRING("value_extractor","Success Exit.");
+
+ return EOK;
+}
+
+
+/* Process value */
+static int process_value(char *buff, void *value, int *length, int *type)
+{
+ int len = 0;
+ int i = 0;
+ int esc = 0;
+ unsigned char hex = 0;
+ int mod = 0;
+ char *dp = NULL;
+ char *dp2 = NULL;
+ int use_long = 0;
+ int use_unsigned = 0;
+ long l_result = 0;
+ unsigned long ul_result = 0;
+ unsigned u_result = 0;
+ int result = 0;
+ double dbl = 0.;
+ char *errconv = NULL;
+
+ DEBUG_STRING("process_value","Entry")
+
+ len = strlen(buff);
+ if(len == 0) {
+ DEBUG_STRING("Empty value","")
+ return RET_INVALID;
+ }
+
+ if(len >= MAX_VALUE) {
+ DEBUG_STRING("Value too big","")
+ return RET_INVALID;
+ }
+
+ /* Is this a string ? */
+ if((*buff == '"') && (*(buff+len-1) == '"')) {
+ buff++;
+ len-=2;
+ *length = 0;
+ *type = ELAPI_TYPE_STRING;
+ esc = 0;
+ for(i=0;i<len;i++) {
+ if(esc == 1) {
+ esc = 0;
+ }
+ else if(*(buff+i)=='\\') {
+ esc = 1;
+ continue;
+ }
+ *((char *)(value+(*length))) = *(buff+i);
+ (*length)++;
+ }
+ *((char *)(value+(*length))) = '\0';
+ (*length)++;
+ return RET_PAIR;
+ }
+
+ /* Is this a binary ? */
+ if((*buff == '\'') && (*(buff+len-1) == '\'')) {
+ buff++;
+ len-=2;
+ if((len/2) *2 != len) {
+ DEBUG_STRING("Invalid length for binary data","")
+ return RET_INVALID;
+ }
+ *length = 0;
+ *type = ELAPI_TYPE_BINARY;
+ for(i=0;i<len;i+=2) {
+ if((!isxdigit(*(buff+i))) || (!isxdigit(*(buff+i+1)))) {
+ DEBUG_STRING("Invalid encoding for binary data","")
+ return RET_INVALID;
+ }
+
+ if(isdigit(*(buff+i))) {
+ if(isdigit(*(buff+i+1))) hex = 16 * (*(buff+i) - '0') + (*(buff+i+1) - '0');
+ else hex = 16 * (*(buff+i) - '0') + (tolower(*(buff+i+1)) - 'a' + 10);
+ }
+ else {
+ if(isdigit(*(buff+i+1))) hex = 16 * (tolower(*(buff+i)) - 'a') + (*(buff+i+1) - '0');
+ else hex = 16 * (tolower(*(buff+i)) - 'a' + 10) + (tolower(*(buff+i+1)) - 'a' + 10);
+ }
+
+ *((char *)(value+(*length))) = (char)(hex);
+ (*length)++;
+ }
+ return RET_PAIR;
+ }
+
+ /* Is this a positive or negative number? */
+ if(*buff == '-') {
+ mod = -1;
+ buff++;
+ len--;
+ use_unsigned = 0;
+ }
+
+ /* Check for decimal point */
+ dp = strchr(buff,'.');
+ if(dp != NULL) {
+ dp2 = strchr(dp+1,'.');
+ if(dp2 != NULL) {
+ DEBUG_STRING("More than one decimal point for double","")
+ return RET_INVALID;
+ }
+ }
+ else {
+ /* No decimal point so check for long */
+ if(*(buff+len-1) == 'L') {
+ use_long = 1;
+ *(buff+len-1) = '\0';
+ len--;
+ }
+
+ if(*(buff+len-1) == 'U') {
+ if(mod < 0) {
+ DEBUG_STRING("Signed/unsigned missmatch","")
+ return RET_INVALID;
+ }
+ use_unsigned = 1;
+ *(buff+len-1) = '\0';
+ len--;
+ }
+ }
+
+ /* Check that the rest are digits */
+ for(i=0;i<len;i++) {
+ if(!(isdigit(*(buff+i)) || (*(buff+i) == '.'))) {
+ DEBUG_STRING("Invalid symbol in the number","")
+ return RET_INVALID;
+ }
+ }
+
+ if(mod == -1) {
+ buff--;
+ len++;
+ *buff = '-';
+ }
+
+ /* Copy longs and ints */
+ if(dp == NULL) {
+ errno = 0;
+ if(use_unsigned) {
+ if(use_long) {
+ *type = ELAPI_TYPE_ULONG;
+ ul_result = (unsigned long) strtol(buff,(char **)(NULL),10);
+ if(errno != 0) {
+ DEBUG_STRING("Number is probably too long","");
+ return RET_INVALID;
+ }
+ *length = sizeof(long);
+ memcpy(value, (void *)(&ul_result),*length);
+ }
+ else {
+ *type = ELAPI_TYPE_UNSIGNED;
+ u_result = (unsigned int) strtol(buff,(char **)(NULL),10);
+ if(errno != 0) {
+ DEBUG_STRING("Number is probably too long","");
+ return RET_INVALID;
+ }
+ *length = sizeof(unsigned);
+ memcpy(value, (void *)(&u_result),*length);
+ }
+ }
+ else {
+ if(use_long) {
+ *type = ELAPI_TYPE_LONG;
+ l_result = (long) strtol(buff,(char **)(NULL),10);
+ if(errno != 0) {
+ DEBUG_STRING("Number is probably too long","");
+ return RET_INVALID;
+ }
+ *length = sizeof(long);
+ memcpy(value, (void *)(&l_result),*length);
+ }
+ else {
+ *type = ELAPI_TYPE_INTEGER;
+ result = (int) strtol(buff,(char **)(NULL),10);
+ if(errno != 0) {
+ DEBUG_STRING("Number is probably too long","");
+ return RET_INVALID;
+ }
+ *length = sizeof(int);
+ memcpy(value, (void *)(&result),*length);
+ }
+ }
+ }
+ /* Deal with double */
+ else {
+ if(len > 20) {
+ DEBUG_STRING("Number is too long","");
+ return RET_INVALID;
+ }
+
+ errno = 0;
+ dbl = (double)(strtod(buff,&errconv));
+ if(errno != 0) {
+ DEBUG_STRING("Invalid double","");
+ return RET_INVALID;
+ }
+ DEBUG_STRING("Value to convert:",buff);
+ DEBUG_DOUBLE("Got double:",dbl)
+ *type = ELAPI_TYPE_DOUBLE;
+ *length = sizeof(double);
+ memcpy(value, (void *)(&dbl),*length);
+ }
+
+
+ DEBUG_STRING("process_value","Success");
+
+ return RET_PAIR;
+
+
+}
+/* Reads a line from the file */
+static int read_line(FILE *file,char *key,void *value, int *length, int *type)
+{
+
+ char *res = NULL;
+ char buf[BUFFER_SIZE+1];
+ int len = 0;
+ char *buffer = NULL;
+ int i = 0;
+ int status = RET_INVALID;
+ char *eq = NULL;
+
+ DEBUG_STRING("read_line","Entry")
+
+ buffer = buf;
+
+ /* Get data from file */
+ res = fgets(buffer,BUFFER_SIZE,file);
+ if(res == NULL) {
+ DEBUG_STRING("Read nothing","")
+ return RET_EOF;
+ }
+
+ len = strlen(buffer);
+ if(len == 0) {
+ DEBUG_STRING("Nothing was read.","")
+ return RET_EMPTY;
+ }
+
+ /* Added \r just in case we deal with Windows in future */
+ if((*(buffer + len - 1) != '\n') && (*(buffer + len - 1) != '\r')) {
+ DEBUG_STRING("String it too big!","")
+ return RET_INVALID;
+ }
+
+ /* Ingnore comments */
+ if(*buffer == ';') {
+ DEBUG_STRING("Comment",buf)
+ return RET_INVALID;
+ }
+
+ /* Empty line */
+ if(*buffer == '\n') {
+ DEBUG_STRING("Empty line",buf)
+ return RET_INVALID;
+ }
+
+ /* Trucate trailing spaces and CRs */
+ while(isspace(*(buffer + len - 1))) {
+ *(buffer + len - 1) = '\0';
+ len--;
+ }
+
+ /* Trucate leading spaces */
+ while(isspace(*buffer)) {
+ buffer++;
+ len--;
+ }
+
+ /* Section */
+ if(*buffer == '[') {
+ if(*(buffer+len-1) != ']') {
+ DEBUG_STRING("Invalid format for section",buf)
+ return RET_ERROR;
+ }
+ buffer++;
+ len--;
+ while(isspace(*(buffer))) {
+ buffer++;
+ len--;
+ }
+ if(len == 0) {
+ DEBUG_STRING("Invalid format for section",buf)
+ return RET_ERROR;
+ }
+
+ *(buffer + len - 1) = '\0';
+ len--;
+ while(isspace(*(buffer + len - 1))) {
+ *(buffer + len - 1) = '\0';
+ len--;
+ }
+ if(len >= MAX_KEY) {
+ DEBUG_STRING("Section name is too long",buf)
+ return RET_ERROR;
+ }
+
+ memcpy(key,buffer,len+1);
+ return RET_SECTION;
+ }
+
+ /* Assume we are dealing with the K-V here */
+ /* Find "=" */
+ eq = strchr(buffer,'=');
+ if(eq == NULL) {
+ DEBUG_STRING("No equal sign",buf)
+ return RET_INVALID;
+ }
+
+ /* Strip spaces around "=" */
+ i = eq - buffer - 1;
+ while((i >= 0) && isspace(*(buffer + i))) i--;
+ if(i<0) {
+ DEBUG_STRING("No key",buf)
+ return RET_INVALID;
+ }
+
+ /* Copy key into provided buffer */
+ if(i >= MAX_KEY) {
+ DEBUG_STRING("Section name is too long",buf)
+ return RET_INVALID;
+ }
+ memcpy(key,buffer,i+1);
+ *(key+i+1) = '\0';
+ DEBUG_STRING("KEY:",key);
+
+ eq++;
+ while(isspace(*eq)) eq++;
+ DEBUG_STRING("VALUE:",eq);
+
+ /* Now process value */
+ status = process_value(eq,value,length,type);
+
+ DEBUG_NUMBER("Type:",*type);
+ DEBUG_NUMBER("Data length:",*length);
+
+ return status;
+}
+
+
+
+/* Add to collection or update */
+static int add_or_update(struct collection_item *current_section,
+ char *key,
+ void *value,
+ int length,
+ int type)
+{
+ int found = ELAPI_NOMATCH;
+ int error = EOK;
+
+ DEBUG_STRING("add_or_update", "Entry");
+
+ (void)is_item_in_collection(current_section,key,ELAPI_TYPE_ANY,ELAPI_TRAVERSE_IGNORE,&found);
+
+ if(found == ELAPI_MATCH) {
+ DEBUG_STRING("Updating...", "");
+ error = update_property(current_section,key,type,value,length,ELAPI_TRAVERSE_IGNORE);
+ }
+ else {
+ DEBUG_STRING("Adding...", "");
+ error = add_any_property(current_section,NULL,key,type,value,length);
+ }
+
+ DEBUG_NUMBER("add_or_update returning", error);
+ return error;
+}
+/***************************************************************************/
+/* Function to read single ini file and pupulate
+ * the provided collection with subcollcetions from the file */
+int ini_to_collection(char *filename, struct collection_item *ini_config)
+{
+ FILE *file;
+ int error;
+ int status;
+ int section_count = 0;
+ char key[MAX_KEY];
+ char value[MAX_VALUE];
+ struct collection_item *current_section = (struct collection_item *)(NULL);
+ int length;
+ int type;
+
+ DEBUG_STRING("ini_to_collection", "Entry");
+
+ /* Open file for reading */
+ file = fopen(filename,"r");
+ if(file == NULL) {
+ error = errno;
+ DEBUG_NUMBER("Failed to open file - but this is OK", error);
+ return EOK;
+ }
+
+ /* Read file lines */
+ while((status = read_line(file,key,(void *)(value),&length,&type)) != RET_EOF) {
+
+ switch(status) {
+ case RET_PAIR:
+ /* Do we have a section at the top of the file ? */
+ if(section_count == 0) {
+ /* Check if collection already exists */
+ error = get_collection_reference(ini_config,&current_section,INI_DEFAULT_SECTION);
+ if(error != EOK) {
+ /* Create default collection */
+ if((error=create_collection(&current_section,INI_DEFAULT_SECTION)) ||
+ (error=add_collection_to_collection(ini_config,NULL,NULL,
+ current_section,
+ ELAPI_ADD_MODE_REFERENCE))) {
+ DEBUG_NUMBER("Failed to create collection", error);
+ fclose(file);
+ destroy_collection(current_section);
+ return error;
+ }
+ }
+ section_count++;
+ }
+
+ /* Put value into the collection */
+ if((error=add_or_update(current_section,key,value,length,type))) {
+ DEBUG_NUMBER("Failed to add pair to collection", error);
+ fclose(file);
+ destroy_collection(current_section);
+ return error;
+ }
+ break;
+
+ case RET_SECTION:
+ /* Read a new section */
+ destroy_collection(current_section);
+ current_section = (struct collection_item *)(NULL);
+
+ error = get_collection_reference(ini_config,&current_section,key);
+ if(error != EOK) {
+ /* Create default collection */
+ if((error=create_collection(&current_section,key)) ||
+ (error=add_collection_to_collection(ini_config,NULL,NULL,
+ current_section,
+ ELAPI_ADD_MODE_REFERENCE))) {
+ DEBUG_NUMBER("Failed to add collection", error);
+ fclose(file);
+ destroy_collection(current_section);
+ return error;
+ }
+ }
+ section_count++;
+ break;
+
+ case RET_EMPTY:
+ DEBUG_STRING("Empty string", "");
+ break;
+
+ case RET_COMMENT:
+ DEBUG_STRING("Comment", "");
+ break;
+
+ case RET_ERROR:
+ DEBUG_STRING("Invalid section format", "");
+ return EINVAL;
+
+ case RET_INVALID:
+ default:
+ DEBUG_STRING("Invalid string", "");
+ break;
+ }
+ }
+
+ /* Close file */
+ fclose(file);
+ destroy_collection(current_section);
+
+ DEBUG_STRING("ini_to_collection", "Success Exit");
+
+ return EOK;
+}
+
+
+/*********************************************************************/
+
+/* read ini file and create collection out of it */
+int config_to_collection(char *application, char *config_file, char *config_dir, struct collection_item **ini_config)
+{
+ int error=EOK;
+ char *file_name;
+
+ DEBUG_STRING("config_to_collection", "Entry");
+
+ *ini_config = (struct collection_item *)(NULL);
+
+ /* Create collection */
+ if((error=create_collection(ini_config,application))) {
+ DEBUG_NUMBER("Failed to create collection", error);
+ destroy_collection(*ini_config);
+ return error;
+ }
+
+ /* Read master file */
+ if((error = ini_to_collection(config_file,*ini_config))) {
+ DEBUG_NUMBER("Failed to read master file", error);
+ destroy_collection(*ini_config);
+ return error;
+ }
+
+ /* Get specific application file */
+ file_name = malloc(strlen(config_dir) + strlen(application) + NAME_OVERHEAD);
+ if(file_name == NULL) {
+ error = errno;
+ DEBUG_NUMBER("Failed to allocate memory for file name", error);
+ destroy_collection(*ini_config);
+ return error;
+ }
+
+ sprintf(file_name,"%s%s%s.conf",config_dir, SLASH, application);
+ DEBUG_STRING("Opening file:", file_name);
+
+ /* Read master file */
+ error = ini_to_collection(file_name,*ini_config);
+ free(file_name);
+ if(error) {
+ DEBUG_NUMBER("Failed to read specific application file", error);
+ destroy_collection(*ini_config);
+ return error;
+ }
+
+ DEBUG_STRING("config_to_collection", "Exit");
+ return EOK;
+}
+
+/* Function to get value from the configration handle */
+int get_value_from_config(void *value,
+ int type,
+ char *section,
+ char *name,
+ struct collection_item *ini_config,
+ int &found)
+{
+ int error = EOK;
+ struct collection_item *section_handle = (struct collection_item *)(NULL);
+ char *to_find;
+ char default_section[] = INI_DEFAULT_SECTION;
+ struct val_extruct pass_in;
+
+ DEBUG_STRING("get_value_from_config", "Entry");
+
+ if(section == NULL) to_find = default_section;
+ else to_find = section;
+
+ /* Get Subcollection */
+ error = get_collection_reference(ini_config,&section_handle,to_find);
+ if(section_handle == (struct collection_item *)(NULL)) {
+ /* We have not found section - return success */
+ DEBUG_STRING("get_value_from_config", "No such section");
+ return EOK;
+ }
+
+ /* If we have the section then get the data */
+ error = get_item_and_do(ini_config, name,type, ELAPI_TRAVERSE_ONELEVEL, value_extractor, value);
+
+ DEBUG_STRING("get_value_from_config", "Exit");
+ return error;
+}
+
+
+
+
+
+
diff --git a/ini/elapi_ini.h b/ini/elapi_ini.h
new file mode 100644
index 0000000..450105b
--- /dev/null
+++ b/ini/elapi_ini.h
@@ -0,0 +1,30 @@
+/* Copyright */
+
+#ifndef ELAPI_INI_H
+#define ELAPI_INI_H
+
+#include "elapi_collection.h"
+
+#define INI_DEFAULT_SECTION "default"
+
+/* Read configuration ini file and create collection out of it */
+int config_to_collection(char *application, /* Name of the application that will be used to get config for */
+ char *config_file, /* Name of the configuration file with default sessings for all apps */
+ char *config_dir, /* Name of the directory where the configuration files for different apps will be dropped */
+ struct collection_item **ini_config); /* New config object */
+
+/* Function to get value from the config */
+int get_value_from_config(void *value, /* Pointer to the memory that will point to the retrieved result.
+ * The memory will always be preallocated. */
+ int type, /* Expected type of the result */
+ char *section, /* Section to search in */
+ char *name, /* Value to look for */
+ struct collection_item *ini_config, /* Config handle */
+ int *found); /* Will update the provided location with 1 in the property was found. */
+
+/* read ini file and create collection out of it factoring in the env variables */
+/* int ini_to_collection_env(char *filename, struct collection_item **ini_config, char *ENV prefix); */
+
+
+
+#endif
diff --git a/ini/elapi_ini_ut b/ini/elapi_ini_ut
new file mode 100755
index 0000000..18deb77
--- /dev/null
+++ b/ini/elapi_ini_ut
Binary files differ
diff --git a/ini/elapi_ini_ut.c b/ini/elapi_ini_ut.c
new file mode 100644
index 0000000..7b783dc
--- /dev/null
+++ b/ini/elapi_ini_ut.c
@@ -0,0 +1,23 @@
+/* Copyright */
+
+#include <stdio.h>
+#include "elapi_ini.h"
+#include "elapi_tools.h"
+
+int main()
+{
+ int error;
+ struct collection_item *ini_config;
+
+ error = config_to_collection("test", "elapi.conf", "./elapi.d", &ini_config);
+ if(error) {
+ printf("Attempt to read configuration returned error: %d\n",error);
+ return error;
+ }
+
+ debug_collection(ini_config,ELAPI_TRAVERSE_DEFAULT);
+ print_collection(ini_config);
+ destroy_collection(ini_config);
+ return 0;
+
+}
diff --git a/sinks/Makefile.am b/sinks/Makefile.am
new file mode 100644
index 0000000..125e373
--- /dev/null
+++ b/sinks/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = stderr syslog
diff --git a/sinks/elapi_sink.h b/sinks/elapi_sink.h
new file mode 100644
index 0000000..0c58c89
--- /dev/null
+++ b/sinks/elapi_sink.h
@@ -0,0 +1,56 @@
+/* Copyright */
+
+#ifndef ELAPI_SINK_H
+#define ELAPI_SINK_H
+
+#include <time.h>
+#include "elapi_collection.h"
+
+#define ELAPI_SINK_OK 0 /* Sink can be used for logging */
+#define ELAPI_SINK_SUSPENDED 1 /* Sink is temporary disabled due to recoverable error */
+#define ELAPI_SINK_DISABLED 2 /* Sink is explicitely disabled by the application */
+#define ELAPI_SINK_PULSE 3 /* Sink is disabled for this one event */
+
+#define SINK_LIB_NAME_SIZE 100
+#define SINK_ENTRY_POINT "get_sink_info"
+#define SINK_NAME_TEMPLATE "libelapi_sink_%s.so"
+#define SINK_NEVER_RETRY -1
+
+struct data_descriptor {
+ char *appname;
+ void *config;
+ void *internal_data;
+};
+
+/* Log facility callbacks */
+typedef int (*init_fn)(struct data_descriptor *dblock);
+typedef void (*cleanup_fn)(struct data_descriptor *dblock);
+typedef int (*format_fn)(struct data_descriptor *dblock, struct collection_item *event);
+typedef int (*submit_fn)(struct data_descriptor *dblock);
+typedef void (*close_fn)(struct data_descriptor *dblock);
+
+struct sink_capability {
+ int retry_interval;
+ init_fn init_cb;
+ cleanup_fn cleanup_cb;
+ format_fn format_cb;
+ submit_fn submit_cb;
+ close_fn close_cb;
+};
+
+/* The only open function the link can expose */
+typedef void (*capability_fn)(struct sink_capability *sink_cpb_block);
+
+struct sink_descriptor {
+ struct sink_capability sink_cpb_block;
+ struct data_descriptor dblock;
+ int suspended;
+ time_t lasttry;
+ void *lib_handle;
+};
+
+/*Standard capability function */
+void get_sink_info(struct sink_capability *sink_cpb_block);
+
+#endif
+
diff --git a/sinks/file/elapi_sink_file.c b/sinks/file/elapi_sink_file.c
new file mode 100644
index 0000000..8358854
--- /dev/null
+++ b/sinks/file/elapi_sink_file.c
@@ -0,0 +1,268 @@
+/* Copyright */
+
+#include <string.h>
+#include <stdlib.h>
+#include <errno.h>
+#include "log_file_facility.h"
+#include "log_util.h"
+#include "log_debug.h"
+
+/******************** MAIN MODULE FUNCTIONS ****************************/
+/* Function to fill in the facility configuration */
+int create_file_facility_config(struct file_config **config, char *path, int mode)
+{
+ struct file_config *cfg = (struct file_config *)(NULL);
+
+ DEBUG_STRING("create_file_facility_config","Entry point");
+
+ errno = 0;
+
+ /* Allocate memory for the structure */
+ cfg = (struct file_config *)(malloc(sizeof(struct file_config)));
+
+ if(cfg == (struct file_config *)(NULL)) return errno;
+
+ /* Initialize. */
+ if(path != NULL) {
+ cfg->path = strdup(path);
+ if(cfg->path == NULL) {
+ free(cfg);
+ return errno;
+ }
+ }
+ else cfg->path = NULL;
+
+ cfg->mode = mode;
+ cfg->ff = NULL;
+
+ *config = cfg;
+
+ DEBUG_STRING("create_file_facility_config","Exit point");
+
+ return 0;
+
+}
+
+/* Function cleans the config */
+void clean_file_facility_config(struct file_config **config)
+{
+ DEBUG_STRING("clean_file_facility_config","Entry point");
+
+ if(config == (struct file_config **)(NULL)) return;
+
+ if(*config != (struct file_config *)(NULL)) {
+ if((*config)->path != NULL) free((*config)->path);
+ free(*config);
+ }
+
+ DEBUG_STRING("clean_file_facility_config","Exit point");
+}
+
+/***** Standard functions each facility has to provide *****/
+/* Initialize facility - open files, establish connnectons, etc... */
+int file_facility_init(struct data_descriptor *dblock)
+{
+ struct file_config *cfg;
+ struct file_event_data *event_data;
+
+ DEBUG_STRING("file_facility_init","Entry point");
+
+ /* Prepare the block where the format function will store its data */
+ errno = 0;
+ event_data = malloc(sizeof(struct file_event_data));
+ if(event_data == NULL) return errno;
+ dblock->event_data = event_data;
+
+ /* Deal with file */
+ errno = 0;
+ cfg = (struct file_config *)(dblock->config);
+
+ /* If we have "path" open file and trancate if needed */
+ if(cfg->path != NULL) {
+ if(cfg->mode & EL_FILE_TRUNCATE) {
+ cfg->ff = fopen(cfg->path,"w");
+ if(cfg->ff == (FILE *)(NULL)) return errno;
+ if(cfg->mode & EL_FILE_OPEN_PER_CMD) {
+ fclose(cfg->ff);
+ cfg->ff = NULL;
+ }
+ }
+ }
+ else {
+ cfg->ff=stderr;
+ cfg->mode = EL_FILE_KEEP_OPEN;
+ }
+
+ DEBUG_STRING("file_facility_init","Exit point");
+ return 0;
+}
+
+/* Formatting calback */
+int file_facility_format(struct data_descriptor *dblock,struct event_handle *event)
+{
+ struct file_event_data *event_data;
+ struct event_item *item = NULL;
+ int length = 0;
+ int size = EL_FILE_BLOCK_SIZE;
+ int item_len = 0;
+ int property_len = 0;
+ int nest_level = 0;
+ int cnt = 0;
+ int first = 1;
+
+ DEBUG_STRING("file_facility_format","Entry point");
+
+ event_data = dblock->event_data;
+
+ /* Prepare momory */
+ errno = 0;
+ event_data->buffer = malloc(size);
+ if(event_data->buffer == NULL) return errno;
+
+ /* Loop and add data */
+ start_iterate_event(event);
+ while((item = iterate_event(event)) != (struct event_item *)(NULL)) {
+
+ DEBUG_STRING("file_facility_format","Top of the item processing loop");
+
+ /* Check the size and increase memory if needed */
+ /* Expect more than one byte to express nesting */
+ item_len = util_get_item_len(item) + 2 * abs(item->nest_level - nest_level) + 2 * nest_level + 1;
+
+ DEBUG_NUMBER("expected item length",item_len);
+
+ if(item_len+length >= size) {
+ size+=EL_FILE_BLOCK_SIZE;
+ DEBUG_NUMBER("expanding data to the given size",size);
+ event_data->buffer = realloc(event_data->buffer,size);
+ if(event_data->buffer == NULL) return errno;
+ }
+
+ DEBUG_NUMBER("current nesting",nest_level);
+ DEBUG_NUMBER("item nesting",item->nest_level);
+
+ /* Add nesting closing parenteces */
+ cnt = 0;
+ while((item->nest_level + cnt) < nest_level) {
+ *(event_data->buffer+length)=')';
+ cnt++;
+ length++;
+ }
+
+ /* Add nesting open parenteces */
+ if(item->nest_level > nest_level) {
+ *(event_data->buffer+length)=' ';
+ length++;
+ *(event_data->buffer+length)='(';
+ length++;
+ first = 0;
+ }
+ else {
+ /* Add comma between items */
+ if(first) first = 0;
+ else {
+ *(event_data->buffer+length)=',';
+ length++;
+ }
+ }
+
+ /* Add property data pair */
+ util_add_data(event_data->buffer, &length, item);
+
+#ifdef ELAPI_LOG_DEBUG
+ *(event_data->buffer+length)='\0';
+#endif
+ DEBUG_STRING("Output",event_data->buffer);
+
+
+ nest_level = item->nest_level;
+ }
+
+ /* Add nesting closing parenteces */
+ cnt = 0;
+ while(cnt < nest_level) {
+ *(event_data->buffer+length)=')';
+ cnt++;
+ length++;
+ }
+
+ DEBUG_STRING("file_facility_format","Exit point");
+
+ return 0;
+}
+
+/* Cleanup per event internal data */
+void file_facility_cleanup(struct data_descriptor *dblock)
+{
+ struct file_event_data *event_data;
+
+ DEBUG_STRING("file_facility_cleanup","Entry point");
+
+ if(dblock->event_data != NULL) {
+ event_data = (struct file_event_data *)(dblock->event_data);
+ if(event_data->buffer != NULL) {
+ free(event_data->buffer);
+ event_data->buffer = NULL;
+ }
+ }
+ DEBUG_STRING("file_facility_cleanup","Exit point");
+}
+
+/* Logging calback */
+int file_facility_log(struct data_descriptor *dblock)
+{
+ struct file_event_data *event_data;
+ struct file_config *cfg;
+
+ DEBUG_STRING("file_facility_log","Entry point");
+
+ errno = 0;
+
+ cfg = (struct file_config *)(dblock->config);
+
+ /* Open file if needed */
+ if((cfg->path != NULL) && (cfg->mode & EL_FILE_OPEN_PER_CMD)) {
+ cfg->ff = fopen(cfg->path,"a");
+ if(cfg->ff == (FILE *)(NULL)) return errno;
+ }
+
+ event_data = (struct file_event_data *)(dblock->event_data);
+ fprintf(cfg->ff,"%s\n",event_data->buffer);
+
+ /* Close file if needed */
+ if((cfg->path != NULL) && (cfg->mode & EL_FILE_OPEN_PER_CMD)) {
+ fclose(cfg->ff);
+ cfg->ff = (FILE *)(NULL);
+ }
+
+ DEBUG_STRING("file_facility_log","Exit point");
+ return 0;
+}
+
+/* Close facility */
+void file_facility_close(struct data_descriptor *dblock)
+{
+ struct file_config *cfg;
+ struct file_event_data *event_data;
+
+ DEBUG_STRING("file_facility_close","Entry point");
+
+ /* Close file if needed */
+ cfg = (struct file_config *)(dblock->config);
+ if((cfg->path != NULL) && (cfg->ff != (FILE *)(NULL))) {
+ fclose(cfg->ff);
+ cfg->ff = (FILE *)(NULL);
+ }
+
+ /* Clean internal data storage */
+ if(dblock->event_data != NULL) {
+ event_data = (struct file_event_data *)(dblock->event_data);
+ if(event_data->buffer != NULL) free(event_data->buffer);
+ free(event_data);
+ dblock->event_data = NULL;
+ }
+
+ DEBUG_STRING("file_facility_close","Exit point");
+}
+
+
diff --git a/sinks/stderr/elapi_sink_stderr.c b/sinks/stderr/elapi_sink_stderr.c
new file mode 100644
index 0000000..17144ac
--- /dev/null
+++ b/sinks/stderr/elapi_sink_stderr.c
@@ -0,0 +1,135 @@
+/* Copyright */
+
+#include <stdio.h>
+#include <errno.h>
+#include <malloc.h>
+#include "elapi_sink.h"
+#include "elapi_collection.h"
+#include "elapi_debug.h"
+#include "elapi_util.h"
+
+
+/***** Standard functions each facility has to provide *****/
+/* Initialize facility - open files, establish connnectons, etc... */
+static int stderr_sink_init(struct data_descriptor *dblock)
+{
+ struct serial_data *serialized_data;
+
+ DEBUG_STRING("stderr_sink_init","Entry");
+
+ /* Prepare the block where the format function will store its data */
+ errno = 0;
+ dblock->internal_data = NULL;
+ serialized_data = malloc(sizeof(struct serial_data));
+ if(serialized_data == NULL) return errno;
+
+ serialized_data->buffer = NULL;
+ serialized_data->size = 0;
+ serialized_data->length = 0;
+ serialized_data->nest_level = 0;
+
+ dblock->internal_data = (void *)(serialized_data);
+
+
+ DEBUG_NUMBER("DBLOCK in init",dblock);
+ DEBUG_NUMBER("internal data in init",dblock->internal_data);
+ DEBUG_STRING("Application name in init:",dblock->appname);
+
+ DEBUG_STRING("stderr_sink_init","Exit");
+ return EOK;
+}
+
+
+/* Formatting calback */
+static int stderr_sink_format(struct data_descriptor *dblock,struct collection_item *event)
+{
+ struct serial_data *serialized_data;
+ int error = EOK;
+
+ DEBUG_STRING("stderr_sink_format","Entry");
+ DEBUG_NUMBER("DBLOCK in format",dblock);
+ DEBUG_NUMBER("internal data in format",dblock->internal_data);
+
+ serialized_data = (struct serial_data *)(dblock->internal_data);
+
+ /* Traverse collection */
+ error = traverse_collection(event,ELAPI_TRAVERSE_DEFAULT | ELAPI_TRAVERSE_END ,serialize,(void *)(serialized_data));
+ if(error) {
+ DEBUG_NUMBER("traverse_collection returned error",error);
+ return error;
+ }
+
+ DEBUG_STRING("stderr_sink_format","Exit");
+ return EOK;
+}
+
+
+/* Cleanup per event internal data after a failure */
+static void stderr_sink_cleanup(struct data_descriptor *dblock)
+{
+ struct serial_data *serialized_data;
+ DEBUG_STRING("stderr_sink_cleanup","Entry");
+
+ serialized_data = (struct serial_data *)(dblock->internal_data);
+
+ if(serialized_data->buffer != NULL) {
+ free(serialized_data->buffer);
+ serialized_data->buffer = NULL;
+ serialized_data->size = 0;
+ serialized_data->length = 0;
+ serialized_data->nest_level = 0;
+ }
+
+ DEBUG_STRING("stderr_sink_cleanup","Exit");
+}
+
+/* Close facility */
+static void stderr_sink_close(struct data_descriptor *dblock)
+{
+ DEBUG_STRING("stderr_sink_close","Entry");
+
+ if(dblock->internal_data != NULL) {
+ stderr_sink_cleanup(dblock);
+ free(dblock->internal_data);
+ dblock->internal_data=NULL;
+ }
+
+ DEBUG_STRING("stderr_sink_close","Exit");
+}
+
+
+/* Logging calback */
+static int stderr_sink_submit(struct data_descriptor *dblock)
+{
+ struct serial_data *serialized_data;
+ DEBUG_STRING("stderr_sink_submit","Entry");
+ DEBUG_NUMBER("DBLOCK in submit",dblock);
+ DEBUG_NUMBER("internal data in submit",dblock->internal_data);
+
+ serialized_data = (struct serial_data *)(dblock->internal_data);
+
+ DEBUG_STRING("OUTPUT:",serialized_data->buffer);
+
+ fprintf(stderr,"%s\n",serialized_data->buffer);
+
+ stderr_sink_cleanup(dblock);
+
+ DEBUG_STRING("stderr_sink_submit","Exit");
+ return EOK;
+}
+
+/* Return a filled in structure */
+void get_sink_info(struct sink_capability *sink_cpb_block)
+{
+ DEBUG_STRING("get_sink_info","Entry");
+
+ sink_cpb_block->retry_interval = SINK_NEVER_RETRY;
+ sink_cpb_block->init_cb = stderr_sink_init;
+ sink_cpb_block->cleanup_cb = stderr_sink_cleanup;
+ sink_cpb_block->format_cb = stderr_sink_format;
+ sink_cpb_block->submit_cb = stderr_sink_submit;
+ sink_cpb_block->close_cb = stderr_sink_close;
+
+ DEBUG_STRING("get_sink_info","Exit");
+}
+
diff --git a/sinks/syslog/elapi_sink_syslog.c b/sinks/syslog/elapi_sink_syslog.c
new file mode 100644
index 0000000..d3a669d
--- /dev/null
+++ b/sinks/syslog/elapi_sink_syslog.c
@@ -0,0 +1,287 @@
+/* Copyright */
+
+#include <stdio.h>
+#include <errno.h>
+#include <malloc.h>
+#include "elapi_sink.h"
+#include "elapi_collection.h"
+#include "elapi_debug.h"
+#include "elapi_util.h"
+#include "elapi_ini.h"
+
+/* FIXME - this should be taken from the config.h generated by autotools */
+#define SYSLOG_RETRY 60
+#define syslog_audit_config "/home/dpal/IPA/Code/elapi/etc/syslog_defaults.conf"
+#define syslog_audit_dir "/home/dpal/IPA/Code/elapi/etc/syslog_defaults.d"
+
+/* FIXME there is currently no code
+ * to make sure we do not call syslog functions from multiple dispatchers.
+ * We probably should create a mutext at the load of the library and
+ * set a flag when the init function is called the first time
+ * and not call the openlog any more times.
+ * But I guess syslog can deal with this internally.
+ */
+
+
+struct syslog_event {
+ struct serial_data sd;
+ int priority;
+}
+
+
+/* Default conmfiguration for syslog */
+struct syslog_config {
+ int option;
+ int facility;
+ int level;
+ char *ident;
+};
+
+/* Internal function to intialize configuration */
+static int init_config(struct data_descriptor *dblock)
+{
+ struct syslog_conf *conf_data;
+ struct collection_item *file_config = (struct collection_item *)(NULL);
+ int found = 0;
+ int *option_cfg = (int *)(NULL);
+ int *facility_cfg = (int *)(NULL);
+ int *level_cfg = (int *)(NULL);
+ char *ident_cfg = NULL;
+
+ DEBUG_STRING("init_config","Entry");
+
+ /* Allocate configuration data */
+ conf_data = (struct syslog_conf *)(malloc(sizeof(struct syslog_config)));
+ if(conf_data == (struct syslog_conf *)(NULL)) return errno;
+
+ /* Read configuration from the configuration file if any */
+ (void)config_to_collection(dblock->appname, syslog_audit_config, syslog_audit_dir, &file_config);
+
+ conf_data->option = LOG_ODELAY;
+ conf_data->facility = LOG_USER;
+ conf_data->level = LOG_INFO;
+ conf_data->ident = NULL;
+
+ DEBUG_NUMBER("Option",conf_data->option);
+ DEBUG_NUMBER("Facility",conf_data->facility);
+ DEBUG_NUMBER("Level",conf_data->level);
+ DEBUG_STRING("Identity",conf_data->ident);
+
+ /* Update defaults with settings from the file */
+ error = get_value_from_config((void *)(&option_cfg),ELAPI_TYPE_INT, INI_DEFAULT_SECTION,"option",file_config);
+ if(error != EOK) {
+ /* There is fundamentally something wrong */
+ DEBUG_NUMBER("Attempt to get option returned error",error);
+ return error;
+ }
+
+ /* Get the value */
+ if(option_cfg != (int *)(NULL)) {
+ conf_data->option = *option_cfg;
+ free((void *)(option_cfg);
+ }
+
+ error = get_value_from_config((void *)(&facility_cfg),ELAPI_TYPE_INT, INI_DEFAULT_SECTION,"facility",file_config);
+ if(error != EOK) {
+ /* There is fundamentally something wrong */
+ DEBUG_NUMBER("Attempt to get option returned error",error);
+ return error;
+ }
+
+ /* Get the value */
+ if(facility_cfg != (int *)(NULL)) {
+ conf_data->facility = *facility_cfg;
+ free((void *)(facility_cfg);
+ }
+
+ error = get_value_from_config((void *)(&level_cfg),ELAPI_TYPE_INT, INI_DEFAULT_SECTION,"level",file_config);
+ if(error != EOK) {
+ /* There is fundamentally something wrong */
+ DEBUG_NUMBER("Attempt to get option returned error",error);
+ return error;
+ }
+
+ /* Get the value */
+ if(level_cfg != (int *)(NULL)) {
+ conf_data->level = *level_cfg;
+ free((void *)(level_cfg);
+ }
+
+ error = get_value_from_config((void *)(&ident_cfg),ELAPI_TYPE_STRING, INI_DEFAULT_SECTION,"identity",file_config);
+ if(error != EOK) {
+ /* There is fundamentally something wrong */
+ DEBUG_NUMBER("Attempt to get option returned error",error);
+ return error;
+ }
+
+ /* Get the value */
+ if(ident_cfg != (char *)(NULL)) {
+ conf_data->ident = *ident_cfg;
+ free((void *)(ident_cfg);
+ }
+
+
+ DEBUG_NUMBER("Option (after conf file):",conf_data->option);
+ DEBUG_NUMBER("Facility (after conf file):",conf_data->facility);
+ DEBUG_NUMBER("Level (after conf file):",conf_data->level);
+ DEBUG_STRING("Identity (after conf file):",conf_data->ident);
+
+ dblock->config = (void *)(conf_data);
+
+ openlog(conf_data->ident,conf_data->option,conf_data->facility);
+
+ DEBUG_STRING("init_config","Entry");
+ return EOK;
+}
+
+/***** Standard functions each facility has to provide *****/
+/* Initialize facility - open files, establish connnectons, etc... */
+static int syslog_sink_init(struct data_descriptor *dblock)
+{
+ struct syslog_event *event_storage;
+ int error;
+
+ DEBUG_STRING("syslog_sink_init","Entry");
+
+ /* Prepare the block where the format function will store its data */
+ errno = 0;
+ dblock->internal_data = NULL;
+ event_storage = (struct syslog_event *)(malloc(sizeof(struct syslog_event)));
+ if(event_storage == (struct syslog_event *)(NULL)) return errno;
+
+ event_storage->sd.buffer = NULL;
+ event_storage->sd.size = 0;
+ event_storage->sd.length = 0;
+ event_storage->sd.nest_level = 0;
+
+ dblock->internal_data = (void *)(event_storage);
+
+ /* Prepare the configuration data block */
+ if((error = init_config(dblock)) {
+ DEBUG_NUMBER("Failed to init config",error);
+ free(dblock->internal_data);
+ dblock->internal_data = NULL;
+ return error;
+ }
+
+ DEBUG_NUMBER("DBLOCK in init",dblock);
+ DEBUG_NUMBER("internal data in init",dblock->internal_data);
+
+ DEBUG_STRING("syslog_sink_init","Exit");
+ return EOK;
+}
+
+
+/* Formatting calback */
+static int syslog_sink_format(struct data_descriptor *dblock,struct collection_item *event)
+{
+ struct syslog_event *event_storage;
+ struct syslog_config *config;
+
+ int error = EOK;
+
+ DEBUG_STRING("syslog_sink_format","Entry");
+ DEBUG_NUMBER("DBLOCK in format",dblock);
+ DEBUG_NUMBER("internal data in format",dblock->internal_data);
+
+ event_storage = (struct event_storage *)(dblock->internal_data);
+ config = (struct event_storage *)(dblock->config);
+
+ event_storage->priority = config->level | config->facility;
+
+ /* FIXME form priority here */
+
+
+
+
+ /* Traverse collection */
+ error = traverse_collection(event,ELAPI_TRAVERSE_DEFAULT | ELAPI_TRAVERSE_END ,serialize,(void *)(event_storage->sd));
+ if(error) {
+ DEBUG_NUMBER("traverse_collection returned error",error);
+ return error;
+ }
+
+ DEBUG_STRING("syslog_sink_format","Exit");
+ return EOK;
+}
+
+
+/* Cleanup per event internal data after a failure */
+static void syslog_sink_cleanup(struct data_descriptor *dblock)
+{
+ struct syslog_event *event_storage;
+ struct syslog_config *config;
+
+ DEBUG_STRING("syslog_sink_cleanup","Entry");
+
+ event_storage = (struct event_storage *)(dblock->internal_data);
+ config = (struct event_storage *)(dblock->config);
+
+ if(event_storage->sd.buffer != NULL) {
+ free(event_storage->sd.buffer);
+ event_storage->sd.buffer = NULL;
+ event_storage->sd.size = 0;
+ event_storage->sd.length = 0;
+ event_storage->sd.nest_level = 0;
+ event_storage->priority = config->level | config->facility;
+ }
+
+ DEBUG_STRING("syslog_sink_cleanup","Exit");
+}
+
+/* Close facility */
+static void syslog_sink_close(struct data_descriptor *dblock)
+{
+ DEBUG_STRING("syslog_sink_close","Entry");
+
+ if(dblock->internal_data != NULL) {
+ syslog_sink_cleanup(dblock);
+ free(dblock->internal_data);
+ free(dblock->config);
+ dblock->internal_data=NULL;
+ dblock->config=NULL;
+ }
+
+ closelog();
+ DEBUG_STRING("syslog_sink_close","Exit");
+}
+
+
+/* Logging calback */
+static int syslog_sink_submit(struct data_descriptor *dblock)
+{
+ struct syslog_event *event_storage;
+ struct syslog_config *config;
+
+ DEBUG_STRING("syslog_sink_submit","Entry");
+ DEBUG_NUMBER("DBLOCK in submit",dblock);
+ DEBUG_NUMBER("internal data in submit",dblock->internal_data);
+
+ event_storage = (struct serial_data *)(dblock->internal_data);
+ config = (struct event_storage *)(dblock->config);
+
+ DEBUG_STRING("OUTPUT:",event_storage->db.buffer);
+
+ fprintf(stderr,"%s %d %s\n",config->ident, event_storage->priority, event_storage->db.buffer);
+
+ syslog_sink_cleanup(dblock);
+
+ DEBUG_STRING("syslog_sink_submit","Exit");
+ return EOK;
+}
+
+/* Return a filled in structure */
+void get_sink_info(struct sink_capability *sink_cpb_block)
+{
+ DEBUG_STRING("get_sink_info","Entry");
+
+ sink_cpb_block->retry_interval = SYSLOG_RETRY;
+ sink_cpb_block->init_cb = syslog_sink_init;
+ sink_cpb_block->cleanup_cb = syslog_sink_cleanup;
+ sink_cpb_block->format_cb = syslog_sink_format;
+ sink_cpb_block->submit_cb = syslog_sink_submit;
+ sink_cpb_block->close_cb = syslog_sink_close;
+
+ DEBUG_STRING("get_sink_info","Exit");
+}
+
diff --git a/tools/Makefile.am b/tools/Makefile.am
new file mode 100644
index 0000000..620da70
--- /dev/null
+++ b/tools/Makefile.am
@@ -0,0 +1,3 @@
+lib_LIBRARIES = libelapi_tools.a
+libelapi_tools_a_SOURCES = elapi_tools.c
+
diff --git a/tools/elapi_tools.c b/tools/elapi_tools.c
new file mode 100644
index 0000000..d1d00c0
--- /dev/null
+++ b/tools/elapi_tools.c
@@ -0,0 +1,192 @@
+/* Copyright */
+
+#include <stdio.h>
+#include <malloc.h>
+#include "elapi_collection.h"
+#include "elapi_debug.h"
+#include "elapi_util.h"
+#include "elapi_tools.h"
+
+/* Debug handle */
+int debug_handle(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *custom_data,
+ int *dummy)
+{
+ int i;
+ int nest_level;
+
+ DEBUG_STRING("debug_handle","Entry.");
+
+
+ nest_level = *(int *)(custom_data);
+ DEBUG_NUMBER("We are getting this pointer:",custom_data);
+ DEBUG_NUMBER("Nest level:",nest_level);
+
+ switch(type) {
+ case ELAPI_TYPE_STRING:
+ printf("%*s %s[%d] str: %s (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ (char *)(data),
+ (int)(nest_level));
+ break;
+ case ELAPI_TYPE_BINARY:
+ printf("%*s %s[%d] bin: ",
+ (nest_level-1)*4,"",
+ property,
+ length);
+ for(i=0;i<length;i++) printf("%02X",*((unsigned char *)(data+i)));
+ printf(" (%d)\n",(int)(nest_level));
+ break;
+ case ELAPI_TYPE_INTEGER:
+ printf("%*s %s[%d] int: %d (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ *((int *)(data)),
+ nest_level);
+ break;
+ case ELAPI_TYPE_UNSIGNED:
+ printf("%*s %s[%d] uint: %u (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ *((unsigned int *)(data)),
+ nest_level);
+ break;
+ case ELAPI_TYPE_LONG:
+ printf("%*s %s[%d] long: %ld (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ *((long *)(data)),
+ nest_level);
+ break;
+ case ELAPI_TYPE_ULONG:
+ printf("%*s %s[%d] ulong: %lu (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ *((unsigned long *)(data)),
+ nest_level);
+ break;
+ case ELAPI_TYPE_DOUBLE:
+ printf("%*s %s[%d] double: %.4f (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ *((double *)(data)),
+ nest_level);
+ break;
+ case ELAPI_TYPE_COLLECTION:
+ nest_level++;
+ printf("%*s %s[%d] header: count %d, ref_count %d data: ",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ ((struct collection_header *)(data))->count,
+ ((struct collection_header *)(data))->reference_count);
+ for(i=0;i<length;i++) printf("%02X",*((unsigned char *)(data+i)));
+ printf(" (%d)\n",(int)(nest_level));
+ break;
+ case ELAPI_TYPE_COLLECTIONREF:
+ printf("%*s %s[%d] external link: ",
+ (nest_level-1)*4,"",
+ property,
+ length);
+ for(i=0;i<length;i++) printf("%02X",*((unsigned char *)(data+i)));
+ printf(" (%d)\n",(int)(nest_level));
+ break;
+ case ELAPI_TYPE_END:
+ nest_level--;
+ /* printf("Reduced nest level\n");*/
+ break;
+ default:
+ printf("Not implemented yet.\n");
+ break;
+ }
+ *(int *)(custom_data) = nest_level;
+ DEBUG_NUMBER("Nest level at the end:",nest_level);
+ DEBUG_STRING("debug_handle","Success exit.");
+ return EOK;
+}
+
+/* Print collection for debugging purposes */
+int debug_collection(struct collection_item *handle,int flag)
+{
+ int error = EOK;
+ int nest_level=0;
+
+ DEBUG_STRING("debug_collection","Entry.");
+
+ printf("DEBUG COLLECTION %s\n",handle->property);
+
+ flag |= ELAPI_TRAVERSE_END;
+
+ printf("Traverse flags %d\n",flag);
+
+ /* Traverse collection */
+ error = traverse_collection(handle,flag,debug_handle,(void *)(&nest_level));
+ if(error) printf("Error debuging collection %d\n",error);
+
+ DEBUG_STRING("debug_collection","Exit.");
+ return error;
+}
+
+/* Print the collection using default serialization */
+int print_collection(struct collection_item *handle)
+{
+ struct serial_data buf_data;
+ int error = EOK;
+
+ printf("COLLECTION:\n");
+
+ buf_data.buffer=NULL;
+ buf_data.length=0;
+ buf_data.size=0;
+ buf_data.nest_level=0;
+
+ /* Traverse collection */
+ error = traverse_collection(handle,ELAPI_TRAVERSE_DEFAULT | ELAPI_TRAVERSE_END ,serialize,(void *)(&buf_data));
+ if(error) printf("Error traversing collection %d\n",error);
+ else printf("%s\n",buf_data.buffer);
+
+ free(buf_data.buffer);
+
+ return error;
+}
+
+
+/* Find and print one item using default serialization */
+int print_item(struct collection_item *handle, char *name)
+{
+ struct serial_data buf_data;
+ int error = EOK;
+
+ printf("FIND ITEM:\n");
+
+ buf_data.buffer=NULL;
+ buf_data.length=0;
+ buf_data.size=0;
+ buf_data.nest_level=0;
+
+ error = get_item_and_do(handle, name, ELAPI_TYPE_ANY,ELAPI_TRAVERSE_DEFAULT, serialize,&buf_data);
+ if(error) printf("Error searching collection %d\n",error);
+ else {
+ if(buf_data.buffer != NULL) {
+ if(buf_data.length> 0) buf_data.length--;
+ *(buf_data.buffer+buf_data.length)= '\0',
+ printf("%s\n",buf_data.buffer);
+ free(buf_data.buffer);
+ }
+ else printf("Name %s is not found in the collection %s.\n",name,handle->property);
+ }
+ return error;
+}
+
+
diff --git a/tools/elapi_tools.h b/tools/elapi_tools.h
new file mode 100644
index 0000000..fd9bf63
--- /dev/null
+++ b/tools/elapi_tools.h
@@ -0,0 +1,27 @@
+/* Copyright */
+
+#ifndef ELAPI_TOOLS_H
+#define ELAPI_TOOLS_H
+
+#include "elapi_collection.h"
+
+/* Debug handle */
+int debug_handle(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *custom_data,
+ int *dummy);
+
+/* Print collection for debugging purposes */
+int debug_collection(struct collection_item *handle,int flag);
+
+/* Print the collection using default serialization */
+int print_collection(struct collection_item *handle);
+
+
+/* Find and print one item using default serialization */
+int print_item(struct collection_item *handle, char *name);
+
+#endif
diff --git a/util/elapi_debug.h b/util/elapi_debug.h
new file mode 100644
index 0000000..3da0685
--- /dev/null
+++ b/util/elapi_debug.h
@@ -0,0 +1,35 @@
+/* Copyright */
+
+#ifndef ELAPI_DEBUG_H
+#define ELAPI_DEBUG_H
+
+#ifdef ELAPI_LOG_DEBUG
+#include <stdio.h>
+#endif
+
+#ifdef ELAPI_LOG_DEBUG
+#define DEBUG_STRING(message,str) printf("[DEBUG] %23s (%4d) %s %s\n",__FILE__,__LINE__,message,str);
+#else
+#define DEBUG_STRING(message,str) ;
+#endif
+
+#ifdef ELAPI_LOG_DEBUG
+#define DEBUG_NUMBER(message,number) printf("[DEBUG] %23s (%4d) %s %lu\n",__FILE__,__LINE__,message,(unsigned long int)(number));
+#else
+#define DEBUG_NUMBER(message,number) ;
+#endif
+
+#ifdef ELAPI_LOG_DEBUG
+#define DEBUG_DOUBLE(message,number) printf("[DEBUG] %23s (%4d) %s %e\n",__FILE__,__LINE__,message,(double)(number));
+#else
+#define DEBUG_DOUBLE(message,number) ;
+#endif
+
+#ifdef ELAPI_LOG_DEBUG
+#define DEBUG_ASSERT(expression) expression ? ; : printf("ASSERTION FAILED\n");
+#else
+#define DEBUG_ASSERT(expression) ;
+#endif
+
+
+#endif