diff options
author | Dmitri Pal <dpal@dpal.csb> | 2009-02-23 10:38:06 -0500 |
---|---|---|
committer | Dmitri Pal <dpal@dpal.csb> | 2009-02-23 10:38:06 -0500 |
commit | d986aeb99fa33967374290bf7ce75eab76c6d446 (patch) | |
tree | e85af838cd95b43c4f1be5bc2203a1a3474ba589 /collection | |
download | elapi_draft-d986aeb99fa33967374290bf7ce75eab76c6d446.tar.gz elapi_draft-d986aeb99fa33967374290bf7ce75eab76c6d446.tar.xz elapi_draft-d986aeb99fa33967374290bf7ce75eab76c6d446.zip |
Initial commit.
Diffstat (limited to 'collection')
-rw-r--r-- | collection/Makefile.am | 6 | ||||
-rw-r--r-- | collection/elapi_collection.c | 1590 | ||||
-rw-r--r-- | collection/elapi_collection.h | 196 | ||||
-rw-r--r-- | collection/elapi_collection_ut.c | 522 | ||||
-rw-r--r-- | collection/elapi_util.c | 499 | ||||
-rw-r--r-- | collection/elapi_util.h | 76 |
6 files changed, 2889 insertions, 0 deletions
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 |