path: root/src/bundle.c

/*
 * bundle
 *
 * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
 *
 * Contact: Jayoun Lee <airjany@samsung.com>, Sewook Park <sewook7.park@samsung.com>,
 * Jaeho Lee <jaeho81.lee@samsung.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */



/**
 * bundle.c
 */

#include "bundle.h"
#include "keyval.h"
#include "keyval_array.h"
#include "keyval_type.h"
#include "bundle_log.h"
#include <glib.h>

#include <stdlib.h>		/* calloc, free */
#include <string.h>		/* strdup */
#include <errno.h>

#define CHECKSUM_LENGTH 32
#define TAG_IMPORT_EXPORT_CHECK "`zaybxcwdveuftgsh`"
/* ADT */
struct _bundle_t
{
	keyval_t *kv_head;
};


/**
 * Find a kv from bundle
 */
static keyval_t *
_bundle_find_kv(bundle *b, const char *key)
{
	keyval_t *kv;

	if(NULL == b) { errno  = EINVAL; return NULL; }
	if(NULL == key) { errno = EKEYREJECTED; return NULL; }

	kv = b->kv_head;
	while (kv != NULL) {
		if(0 == strcmp(key, kv->key)) return kv;
		kv = kv->next;
	} 
	/* Not found */
	errno = ENOKEY;
	return NULL;
}

/**
 * Append kv into bundle
 */
static int
_bundle_append_kv(bundle *b, keyval_t *new_kv)
{
	keyval_t *kv;

	if (NULL == b->kv_head) b->kv_head = new_kv;
	else {
		kv = b->kv_head;
		while (NULL != kv->next) kv = kv->next;
		kv->next = new_kv;
	}
	return 0;
}

static int
_bundle_add_kv(bundle *b, const char *key, const void *val, const size_t size, const int type, const unsigned int len)
{
	/* basic value check */
	if(NULL == b) { errno = EINVAL; return -1; }
	if(NULL == key) { errno = EKEYREJECTED; return -1; }
	if(0 == strlen(key)) { errno = EKEYREJECTED; return -1; }

	keyval_t *kv = _bundle_find_kv(b, key);
	if(kv) {	/* Key already exists */
		errno = EPERM;
		return -1;
	}
	errno = 0;

	keyval_t *new_kv = NULL;
	if(keyval_type_is_array(type)) {
		// array type
		keyval_array_t *kva = keyval_array_new(NULL, key, type, (const void **) val, len);
		new_kv = (keyval_t *)kva;
	}
	else {
		// normal type
		new_kv = keyval_new(NULL, key, type, val, size);
	}
	if(!new_kv) {
		// NOTE: errno is already set. (ENOMEM, ...)
		return -1;
	}

	_bundle_append_kv(b, new_kv);

	return 0;

}

static int
_bundle_get_val(bundle *b, const char *key, const int type, void **val, size_t *size, unsigned int *len, size_t **array_element_size)
{
	keyval_t *kv = _bundle_find_kv(b, key);
	if(!kv) {	/* Key doesn't exist */
		/* NOTE: errno is already set. */
		return -1;
	}
	if(BUNDLE_TYPE_ANY != type && type != kv->type) {
		errno = ENOTSUP;
		return -1;
	}

	if(keyval_type_is_array(type)) {
		keyval_array_t *kva = (keyval_array_t *)kv;
		keyval_array_get_data(kva, NULL, (void ***)val, len, array_element_size);
	}
	else {
		keyval_get_data(kv, NULL, val, size);
	}

	return 0;
}

/** global initialization
 *  Run only once.
 */
static void
_bundle_global_init(void)
{
	static int _is_done = 0;
	if(_is_done) return;
	
	// Run init functions
	keyval_type_init();

	_is_done = 1;
	return;
}


/* APIs */
bundle *
bundle_create(void)
{
	bundle *b = NULL;
	
	_bundle_global_init();

	b = calloc(1, sizeof(bundle));	/* fill mem with NULL */
	if(NULL == b) {
		BUNDLE_EXCEPTION_PRINT("Unable to allocate memory for bundle\n");
		errno = ENOMEM;
		goto EXCEPTION;
	}

	return b;

EXCEPTION:
	return NULL;
}

int
bundle_free(bundle *b)
{
	keyval_t *kv, *tmp_kv; 

	if(NULL == b) {
		BUNDLE_EXCEPTION_PRINT("Bundle is already freed\n");
		errno = EINVAL;
		return -1;
	}

	/* Free keyval list */
	kv = b->kv_head;
	while(kv != NULL) {
		tmp_kv = kv;
		kv = kv->next;
		tmp_kv->method->free(tmp_kv, 1);
	}

	/* free bundle */
	free(b);

	return 0;
}
// str type
int
bundle_add_str(bundle *b, const char *key, const char *str)
{
	if(!str) { errno = EINVAL; return -1; }
	return _bundle_add_kv(b, key, str, strlen(str)+1, BUNDLE_TYPE_STR, 1);
}

int
bundle_get_str(bundle *b, const char *key, char **str)
{
	return _bundle_get_val(b, key, BUNDLE_TYPE_STR, (void **) str, NULL, NULL, NULL);
}

int
bundle_add(bundle *b, const char *key, const char *val)
{
	return bundle_add_str(b, key, val);
}

int
bundle_del(bundle *b, const char *key)
{
	keyval_t *kv = NULL, *prev_kv = NULL;

	/* basic value check */
	if(NULL == b) { errno = EINVAL; return -1; }
	if(NULL == key) { errno = EKEYREJECTED; return -1; }
	if(0 == strlen(key)) { errno = EKEYREJECTED; return -1; }

	kv = b->kv_head;
	while (kv != NULL) {
		if(0 == strcmp(key, kv->key)) break;
		prev_kv = kv;
		kv = kv->next;
	} 
	if (NULL == kv) { errno = ENOKEY; return -1; }
	else {
		if(NULL != prev_kv) {
			prev_kv->next = kv->next;
		}
		if(kv == b->kv_head) b->kv_head = kv->next;
		kv->method->free(kv, 1);
	}
	return 0;

}

const char *
bundle_get_val(bundle *b, const char *key)
{
	char *val = NULL;
	int r = 0;

	r = bundle_get_str(b, key, &val);
	return val;

}

/**
 * @brief used by bundle_get_count() API, to count number of items in a bundle
 */
static void
_bundle_get_count_iter(const char *k, const int type, const bundle_keyval_t *kv, void *user_data)
{
	int *count = (int *)user_data;
	*count += 1;
}

int
bundle_get_count (bundle *b)
{
	int count = 0;
	if (NULL == b) return count;
	bundle_foreach(b, _bundle_get_count_iter, &count);
	return count;
}

void
bundle_iterate(bundle *b, bundle_iterate_cb_t callback, void *data)
{
	keyval_t *kv = b->kv_head;
	if(callback) {
		while(NULL != kv) {
			callback(kv->key, kv->val, data);
			kv = kv->next;
		}
	}
}

void
bundle_foreach(bundle *b, bundle_iterator_t iter, void *user_data)
{
	if(NULL==b)
	{
		return;		/*TC_FIX if b=NULL- error handling */
	}
	keyval_t *kv = b->kv_head;
	if(iter) {
		while(NULL != kv) {
			iter(kv->key, kv->type, kv, user_data);
			kv = kv->next;
		}
	}
}

/* keyval functions */
int 
bundle_keyval_get_type(bundle_keyval_t *kv)
{
	return kv->type;
}

int 
bundle_keyval_type_is_array(bundle_keyval_t *kv)
{
	return keyval_type_is_array(kv->type);
}

int 
bundle_keyval_type_is_measurable(bundle_keyval_t *kv)
{
	return keyval_type_is_measurable(kv->type);
}

int 
bundle_keyval_get_basic_val(bundle_keyval_t *kv, void **val, size_t *size)
{
	return keyval_get_data(kv, NULL, val, size);
}

int 
bundle_keyval_get_array_val(bundle_keyval_t *kv, void ***array_val, unsigned int *array_len, size_t **array_item_size)
{
	return keyval_array_get_data((keyval_array_t *)kv, NULL, array_val, array_len, array_item_size);
}


/*static void
_iter_do_bundle_dup(const char *key, const void *val, const int type, const size_t size, const unsigned int len, void *user_data)
{
	//int r;
	bundle *b_to = (bundle *)user_data;

	_bundle_add_kv(b_to, key, val, size, type, len);

}
*/
bundle *
bundle_dup(bundle *b_from)
{
	bundle *b_to = NULL;
	int i;

	if(NULL == b_from) { errno = EINVAL; return NULL; }
	b_to = bundle_create();
	if(NULL == b_to) return NULL;

	keyval_t *kv_from = b_from->kv_head;
	keyval_t *kv_to = NULL;
	while(kv_from != NULL) {
		if(keyval_type_is_array(kv_from->type)) {
			keyval_array_t *kva_from = (keyval_array_t *)kv_from;
			kv_to = (keyval_t *) keyval_array_new(NULL, kv_from->key, kv_from->type, NULL, kva_from->len);
			if(!kv_to) goto ERR_CLEANUP;
			for(i=0; i < kva_from->len; i++) {
				if(((keyval_array_t *)kv_from)->array_val[i]) {
					keyval_array_set_element((keyval_array_t*)kv_to, i, ((keyval_array_t *)kv_from)->array_val[i], ((keyval_array_t *)kv_from)->array_element_size[i]);
				}
			}
			_bundle_append_kv(b_to, kv_to);
		}
		else {
			if(_bundle_add_kv(b_to, kv_from->key, kv_from->val, kv_from->size, kv_from->type, 0)) goto ERR_CLEANUP;
		}

		kv_from = kv_from->next;
	}
	return b_to;

ERR_CLEANUP:
	bundle_free(b_to);
	return NULL;
}


int
bundle_encode(bundle *b, bundle_raw **r, int *len)
{
	keyval_t *kv;
	unsigned char *m;
	unsigned char *p_m;
	unsigned char *byte;
	size_t byte_len;
	gchar *chksum_val;

	if(NULL == b) {
		errno = EINVAL;
		return -1;
	}

	/* calculate memory size */
	size_t msize = 0;	// Sum of required size

	kv = b->kv_head;
	while(kv != NULL) {
		msize += kv->method->get_encoded_size(kv);
		kv = kv->next;
	}
	m = calloc(msize+CHECKSUM_LENGTH, sizeof(unsigned char));
	if(unlikely(NULL == m ))  { errno = ENOMEM; return -1; }

	p_m = m+CHECKSUM_LENGTH;	/* temporary pointer */

	kv = b->kv_head;
	while(kv != NULL) {
		byte = NULL;
		byte_len = 0;

		kv->method->encode(kv, &byte, &byte_len);
		memcpy(p_m, byte, byte_len);

		p_m += byte_len;
		kv = kv->next;

		free(byte);
	}

	/*compute checksum from the data*/
	chksum_val = g_compute_checksum_for_string(G_CHECKSUM_MD5,m+CHECKSUM_LENGTH,msize);
	/*prefix checksum to the data */
	memcpy(m,chksum_val,CHECKSUM_LENGTH);
	if ( NULL != r ) {
		/*base64 encode for whole string checksum and data*/
		*r =(unsigned char*)g_base64_encode(m,msize+CHECKSUM_LENGTH);
		if ( NULL != len ) *len = strlen((char*)*r);
	}
	free(m);
	g_free(chksum_val);/*free checksum string */

	return 0;
}

int
bundle_free_encoded_rawdata(bundle_raw **r)
{
	if(!*r) return -1;		/*TC_FIX - double free sigabrt handling */

	free(*r);
	*r=NULL;
	return 0;
}

bundle *
bundle_decode(const bundle_raw *r, const int data_size)
{
	bundle *b;
	bundle_raw *p_r;
	unsigned char *d_str;
	unsigned int d_len_raw;
	unsigned char *d_r;
	unsigned int d_len;
	char *extract_cksum;
	gchar* compute_cksum;

	if(NULL == r) {
		errno = EINVAL;
		return NULL;
	}

	extract_cksum = calloc(CHECKSUM_LENGTH+1, sizeof(char));
	if(unlikely(NULL== extract_cksum))
	{
		errno = ENOMEM;
		return NULL;
	}

	/* base 64 decode of input string*/
	d_str = g_base64_decode((char*)r, &d_len_raw);
	/*extract checksum from the received string */
	strncpy(extract_cksum,d_str,CHECKSUM_LENGTH);
	/* compute checksum for the data */
	compute_cksum = g_compute_checksum_for_string(G_CHECKSUM_MD5,d_str+CHECKSUM_LENGTH,d_len_raw-CHECKSUM_LENGTH);
	/*compare checksum values- extracted from the received string and computed from the data */
	if(strcmp(extract_cksum,compute_cksum)!=0)
	{
		free(extract_cksum);
		g_free(compute_cksum);
		return NULL;
	}
	d_r = d_str+CHECKSUM_LENGTH;
	d_len= d_len_raw-CHECKSUM_LENGTH;

	/* re-construct bundle */
	b = bundle_create();

	p_r = (bundle_raw *)d_r;

	size_t bytes_read;
	keyval_t *kv;

	while(p_r < d_r + d_len - 1) {
		kv = NULL;	// To get a new kv

		// Find type, and use decode function according to type
		int type = keyval_get_type_from_encoded_byte(p_r);

		if(keyval_type_is_array(type)) {
			bytes_read = keyval_array_decode(p_r, (keyval_array_t **) &kv);
		}
		else {
			bytes_read = keyval_decode(p_r, &kv);
		}

		if(kv) _bundle_append_kv(b, kv);
		else { break; }
		p_r += bytes_read;
	}

	free(extract_cksum);
	g_free(compute_cksum);
	free(d_str);

	return b;
}

struct _argv_idx {
	int argc;
	char **argv;
	int idx;
};


void 
_iter_export_to_argv(const char *key, const int type, const keyval_t *kv, void *user_data)
{
	struct _argv_idx *vi = (struct _argv_idx *)user_data;

	vi->argv[vi->idx] = (char *)key;

	unsigned char *byte = NULL, *encoded_byte = NULL;
	size_t byte_len = 0;

	if(0 == kv->method->encode((struct keyval_t *)kv, &byte, &byte_len)) {
		// TODO: encode FAILED!
		BUNDLE_EXCEPTION_PRINT("bundle: FAILED to encode keyval: %s\n", key);
		return;
	}
	// bas64 encode

	encoded_byte =(unsigned char *) g_base64_encode(byte, byte_len);
	if(NULL == encoded_byte) {
		BUNDLE_EXCEPTION_PRINT("bundle: failed to encode byte\n");
		return;
	}
	
	vi->argv[vi->idx + 1] =(char*)encoded_byte;
	(vi->idx) += 2;

	free(byte);
}

int
bundle_export_to_argv(bundle *b, char ***argv)
{
	int argc, item_count;

	item_count = bundle_get_count(b);
	argc = 2 * item_count + 2;	/* 2 more count for argv[0] and arv[1] = encoded */
	*argv = calloc(argc + 1, sizeof(char *));
	if(!*argv) return -1;

	struct _argv_idx vi;
	vi.argc = argc;
	vi.argv = *argv;
	vi.idx = 2; 			 /* start from index 2*/
	vi.argv[1]=TAG_IMPORT_EXPORT_CHECK; 		/* set argv[1] as encoded*/
	/*BUNDLE_LOG_PRINT("\nargument 1 is %s",vi.argv[1]);*/

	bundle_foreach(b, _iter_export_to_argv, &vi);

	return argc;
}

int bundle_free_exported_argv(int argc, char ***argv)
{
	if(!*argv) return -1;		/*TC_FIX : fix for double free- sigabrt */
	
	int i;
	for(i=1; i < argc; i+=2) {
		free((*argv)[i+1]);
	}

	free(*argv);
	*argv= NULL;
	return 0;
}

	bundle *
bundle_import_from_argv(int argc, char **argv)
{
	if(!argv) return NULL;  /* TC_FIX error handling for argv =NULL*/

	bundle *b = bundle_create();
	if(!b) return NULL;


	/*
	   int i;
	   for(i=0; i<argc; i++) {
	   BUNDLE_LOG_PRINT("[bundle-dbg] argv[%d]='%s'\n", i, argv[i]);
	   }
	 */

	if(!argv[1]||strcmp(argv[1],TAG_IMPORT_EXPORT_CHECK))
	{
		/*BUNDLE_LOG_PRINT("\nit is not encoded");*/
		int idx;
		for (idx = 1; idx < argc; idx = idx + 2) {        /*start idx from one as argv[1] is user given argument*/
			bundle_add(b, argv[idx], argv[idx + 1]);
		}
		return b;
	}
	/*BUNDLE_LOG_PRINT("\nit is encoded");*/
	int idx, type;
	keyval_t *kv = NULL;
	keyval_array_t *kva = NULL;
	unsigned char *byte = NULL;
	char *encoded_byte;
	unsigned int byte_size;
	for(idx = 2; idx < argc; idx = idx+2) {  // start idx from 2 as argv[1] is encoded
		kv = NULL;
		kva = NULL;

		encoded_byte = argv[idx+1];

		// base64_decode
		byte = g_base64_decode(encoded_byte, &byte_size);
		if(NULL == byte) {
			if(b) bundle_free(b);
			return NULL;
		}

		type = keyval_get_type_from_encoded_byte(byte);
		if(keyval_type_is_array(type)) {
			if(0 == keyval_array_decode(byte, &kva)) {
				// TODO: error!
				BUNDLE_EXCEPTION_PRINT("Unable to Decode array\n");
			}
			kv = (keyval_t *)kva;
		}
		else {
			if(0 == keyval_decode(byte, &kv)) {
				// TODO: error!
				BUNDLE_EXCEPTION_PRINT("Unable to Decode\n");
			}
		}
		_bundle_append_kv(b, kv);

		free(byte);
		byte = NULL;
	}
	return b;
}


	int
bundle_get_type(bundle *b, const char *key)
{
	keyval_t *kv = _bundle_find_kv(b, key);
	if(kv) return kv->type;
	else {
		errno = ENOKEY;
		return BUNDLE_TYPE_NONE;
	}
}

// array functions
/** Get length of an array
 */
	unsigned int
bundle_get_array_len(bundle *b, const char *key)
{
	return 0;
}

/** Get size of an item in byte, of given pointer
 */
	size_t
bundle_get_array_val_size(bundle *b, const char *key, const void *val_ptr)
{
	return 0;
}
static int
bundle_set_array_val(bundle *b, const char *key, const int type, const unsigned int idx, const void *val, const size_t size)
{
//void **array = NULL;

	keyval_t *kv = _bundle_find_kv(b, key);
	if(NULL == kv) return -1;

	if(type != kv->type) {
		errno = EINVAL;
		return -1;
	}

	if(! keyval_type_is_array(kv->type)) {	// TODO: Is this needed?
		errno = EINVAL;
		return -1;
	}

	keyval_array_t *kva = (keyval_array_t *)kv;

	if(! keyval_array_is_idx_valid(kva, idx)) {
		errno = EINVAL;
		return -1;
	}

	if(!kva->array_val) {	// NULL value test (TODO: is this needed?)
		errno = ENOMEM;
		return -1;
	}

	return keyval_array_set_element(kva, idx, val, size);
}


	int
bundle_add_str_array(bundle *b, const char *key, const char **str_array, const int len)
{
	return _bundle_add_kv(b, key, str_array, 0, BUNDLE_TYPE_STR_ARRAY, len);
}


	int
bundle_get_val_array(bundle *b, const char *key, char ***str_array, int *len)
{
	return _bundle_get_val(b, key, BUNDLE_TYPE_STR_ARRAY, (void **) str_array, NULL,(unsigned int *)len, NULL);
}

const char ** bundle_get_str_array(bundle *b, const char *key,int *len)
{
	const char **arr_val = NULL;
	int r = 0;

	r = bundle_get_val_array(b,key,(char***)&arr_val,len);
	return arr_val;

}


	int
bundle_compare(bundle *b1, bundle *b2)
{
	if(!b1 || !b2) return -1;

	keyval_t *kv1, *kv2;
	//keyval_array_t *kva1, *kva2;
	//char *key;

	if(bundle_get_count(b1) != bundle_get_count(b2)) return 1;
	for(kv1 = b1->kv_head; kv1 != NULL; kv1 = kv1->next) {
		kv2 = _bundle_find_kv(b2, kv1->key);
		if(!kv2) return 1;
		if(kv1->method->compare(kv1, kv2)) return 1;
	}
	return 0;
}



	int
bundle_set_str_array_element(bundle *b, const char *key, const unsigned int idx, const char *val)
{
	if(!val) {
		errno = EINVAL;
		return -1;
	}
	return bundle_set_array_val(b, key, BUNDLE_TYPE_STR_ARRAY, idx, val, strlen(val)+1);
}


// byte type 
	int
bundle_add_byte(bundle *b, const char *key, const void *byte, const size_t size)
{
	return _bundle_add_kv(b, key, byte, size, BUNDLE_TYPE_BYTE, 1);
}

	int
bundle_get_byte(bundle *b, const char *key, void **byte, size_t *size)
{
	return _bundle_get_val(b, key, BUNDLE_TYPE_BYTE, (void **) byte, size, NULL, NULL);
}

	int
bundle_add_byte_array(bundle *b, const char *key, void **byte_array, const unsigned int len)
{
	return _bundle_add_kv(b, key, byte_array, 0, BUNDLE_TYPE_BYTE_ARRAY, len);
}

	int
bundle_get_byte_array(bundle *b, const char *key, void ***byte_array, unsigned int *len, unsigned int **array_element_size)
{
	return _bundle_get_val(b, key, BUNDLE_TYPE_BYTE_ARRAY, (void **)byte_array, NULL, len, array_element_size);
}


	int
bundle_set_byte_array_element(bundle *b, const char *key, const unsigned int idx, const void *val, const size_t size)
{
	return bundle_set_array_val(b, key, BUNDLE_TYPE_BYTE_ARRAY, idx, val, size);
}