src/json.c

/*
 *
 *  Wireless daemon for Linux
 *
 *  Copyright (C) 2021  Intel Corporation. All rights reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <errno.h>

#include <ell/ell.h>

#include "src/json.h"

#define JSMN_STATIC
#define JSMN_STRICT
#define JSMN_PARENT_LINKS
#include "shared/jsmn.h"

/* Max number of tokens supported. Increase if larger objects are expected */
#define JSON_DEFAULT_TOKENS 60

#define TOK_LEN(token) ((token)->end - (token)->start)
#define TOK_PTR(json, token) (void *)((json) + (token)->start)
#define TOK_TO_STR(json, token) \
({ \
	char *_tmp = l_malloc(TOK_LEN((token)) + 1); \
	memcpy(_tmp, TOK_PTR((json), (token)), TOK_LEN((token))); \
	_tmp[TOK_LEN((token))] = '\0'; \
	_tmp; \
})

#define ITER_END(iter) \
	(((iter)->contents->tokens + (iter)->start) + (iter)->count)

struct json_contents {
	const char *json;
	size_t json_len;
	jsmntok_t *tokens;
	int tokens_len;
	jsmn_parser *p;
};

static jsmntok_t *next_key_in_parent(struct json_iter *iter, jsmntok_t *current)
{
	int parent = current->parent;

	/* iterate the list and stop on the first token with the same parent */
	while (++current < ITER_END(iter)) {
		if (current->parent == parent)
			return current;
	}

	return NULL;
}

static int count_tokens_in_container(struct json_iter *iter,
							jsmntok_t *container)
{
	int idx = container - iter->contents->tokens;
	jsmntok_t *contents;

	for (contents = ++container; contents < ITER_END(iter); contents++)
		if (contents->parent < idx)
			break;

	return contents - container;
}

static void iter_recurse(struct json_iter *iter, jsmntok_t *token,
				struct json_iter *child)
{
	struct json_contents *c = iter->contents;

	child->contents = c;
	child->start = token - c->tokens;
	child->current = child->start;
	child->count = count_tokens_in_container(iter, token);

	/*
	 * Add one to include the object/array token itself. This is required
	 * since 'current' points to the container initially. Only after a call
	 * to json_iter_next() will 'current' point to the first token in the
	 * container.
	 */
	if (token->type == JSMN_OBJECT || token->type == JSMN_ARRAY)
		child->count++;
}

struct json_contents *json_contents_new(const char *json, size_t json_len)
{
	struct json_contents *c = l_new(struct json_contents, 1);

	c->json = json;
	c->json_len = json_len;
	c->p = l_new(jsmn_parser, 1);
	c->tokens = l_new(jsmntok_t, JSON_DEFAULT_TOKENS);

	jsmn_init(c->p);
	c->tokens_len = jsmn_parse(c->p, c->json, c->json_len,
					c->tokens, JSON_DEFAULT_TOKENS);
	if (c->tokens_len < 0) {
		json_contents_free(c);
		return NULL;
	}

	return c;
}

void json_iter_init(struct json_iter *iter, struct json_contents *c)
{
	iter->contents = c;
	iter->start = 0;
	iter->count = c->tokens_len;
}

void json_contents_free(struct json_contents *c)
{
	l_free(c->p);
	l_free(c->tokens);
	l_free(c);
}

struct json_arg {
	enum json_type type;
	void *value;
	jsmntok_t *v;
};

static void push_arg(struct l_queue *q, enum json_type type,
			void *value, jsmntok_t *v)
{
	struct json_arg *arg = l_new(struct json_arg, 1);

	arg->type = type;
	arg->value = value;
	arg->v = v;

	l_queue_push_head(q, arg);
}

static void assign_arg(void *data, void *user_data)
{
	struct json_iter *iter = user_data;
	struct json_arg *arg = data;
	struct json_contents *c = iter->contents;
	char **sval;
	struct json_iter *iter_val;

	switch (arg->type) {
	case JSON_STRING:
		sval = arg->value;

		*sval = arg->v ? TOK_TO_STR(c->json, arg->v) : NULL;

		break;
	case JSON_OBJECT:
	case JSON_PRIMITIVE:
	case JSON_ARRAY:
		iter_val = arg->value;

		if (!arg->v)
			iter_val->start = -1;
		else
			iter_recurse(iter, arg->v, iter_val);

		break;
	default:
		/* Types are verified earlier, this should never happen */
		return;
	}

	l_free(arg);
}

bool json_iter_parse(struct json_iter *iter, enum json_type type, ...)
{
	struct json_contents *c = iter->contents;
	va_list va;
	int i;
	int num = c->tokens->size;
	jsmntok_t *next;
	struct l_queue *args;

	if (iter->start == -1)
		return false;

	if (c->tokens[iter->start].type != JSMN_OBJECT)
		return false;

	args = l_queue_new();

	va_start(va, type);

	while (true) {
		enum json_flag flag;
		char *key;
		void *value;
		jsmntok_t *v = NULL;
		void *ptr;
		size_t len;

		/* Check the type is supported before wasting any cycles */
		switch (type) {
		case JSON_UNDEFINED:
			goto done;
		case JSON_STRING:
		case JSON_OBJECT:
		case JSON_PRIMITIVE:
		case JSON_ARRAY:
			break;
		default:
			goto error;
		}

		key = va_arg(va, char *);
		value = va_arg(va, void *);
		flag = va_arg(va, enum json_flag);

		/* First key */
		next = c->tokens + iter->start + 1;

		/* Iterate over this objects keys */
		for (i = 0; i < num; i++) {
			ptr = TOK_PTR(c->json, next);
			len = TOK_LEN(next);

			if (next + 1 > ITER_END(iter))
				goto error;

			if (strlen(key) == len && !memcmp(ptr, key, len)) {
				/* Key found but the wrong value type */
				if ((next + 1)->type != (jsmntype_t)type)
					goto error;

				v = next + 1;
				break;
			}

			next = next_key_in_parent(iter, next);
			if (!next)
				break;
		}

		if (flag == JSON_FLAG_MANDATORY && !v)
			goto error;

		/*
		 * Still push even if an optional value doesn't exist (!v) so
		 * the caller can check if it was found or not.
		 */
		if (value)
			push_arg(args, type, value, v);

		type = va_arg(va, enum json_type);
	}

done:
	va_end(va);

	l_queue_foreach(args, assign_arg, iter);
	l_queue_destroy(args, NULL);

	return true;

error:
	va_end(va);

	l_queue_destroy(args, l_free);
	return false;
}

static bool iter_get_primitive_data(struct json_iter *iter, void **ptr,
					size_t *len)
{
	struct json_contents *c = iter->contents;
	jsmntok_t *t = c->tokens + iter->current;

	if (t->type != JSMN_PRIMITIVE)
		return false;

	*ptr = TOK_PTR(c->json, t);
	*len = TOK_LEN(t);

	return true;
}

bool json_iter_get_int(struct json_iter *iter, int *i)
{
	void *ptr;
	size_t len;
	long r;
	int t;
	char *endp;

	if (!iter_get_primitive_data(iter, &ptr, &len))
		return false;

	if (!len)
		return false;

	errno = 0;

	t = r = strtol(ptr, &endp, 10);
	if (endp != ptr + len)
		return false;

	if (errno == ERANGE || errno == EINVAL || r != t)
		return false;

	if (i)
		*i = r;

	return true;
}

bool json_iter_get_uint(struct json_iter *iter, unsigned int *i)
{
	void *ptr;
	size_t len;
	unsigned long r;
	unsigned int t;
	char *endp;

	if (!iter_get_primitive_data(iter, &ptr, &len))
		return false;

	if (!len || *((char *) ptr) == '-')
		return false;

	errno = 0;

	t = r = strtoul(ptr, &endp, 10);
	if (endp != ptr + len)
		return false;

	if (errno == ERANGE || errno == EINVAL || r != t)
		return false;

	if (i)
		*i = r;

	return true;
}

bool json_iter_get_boolean(struct json_iter *iter, bool *b)
{
	void *ptr;
	size_t len;

	if (!iter_get_primitive_data(iter, &ptr, &len))
		return false;

	if (len == 4 && !memcmp(ptr, "true", 4)) {
		if (b)
			*b = true;

		return true;
	} else if (len == 5 && !memcmp(ptr, "false", 5)) {
		if (b)
			*b = false;

		return true;
	}

	return false;
}

bool json_iter_get_null(struct json_iter *iter)
{
	void *ptr;
	size_t len;

	if (!iter_get_primitive_data(iter, &ptr, &len))
		return false;

	if (len == 4 && !memcmp(ptr, "null", 4))
		return true;

	return false;
}

bool json_iter_get_container(struct json_iter *iter,
				struct json_iter *container)
{
	struct json_contents *c = iter->contents;
	jsmntok_t *t = c->tokens + iter->current;

	if (t->type != JSMN_OBJECT && t->type != JSMN_ARRAY)
		return false;

	if (container)
		iter_recurse(iter, t, container);

	return true;
}

bool json_iter_get_string(struct json_iter *iter, char **s)
{
	struct json_contents *c = iter->contents;
	jsmntok_t *t = c->tokens + iter->current;

	if (t->type != JSMN_STRING)
		return false;

	if (s)
		*s = TOK_TO_STR(c->json, t);

	return true;
}

enum json_type json_iter_get_type(struct json_iter *iter)
{
	struct json_contents *c = iter->contents;
	jsmntok_t *t = c->tokens + iter->current;

	return (enum json_type) t->type;
}

bool json_iter_next(struct json_iter *iter)
{
	struct json_contents *c = iter->contents;
	jsmntok_t *t = c->tokens + iter->current;
	int inc = 1;

	if (c->tokens[iter->start].type != JSMN_ARRAY)
		return false;

	/*
	 * If this is the initial iteration skip this and just increment
	 * current by 1 since this iterator points to a container which needs to
	 * be advanced to the first token..
	 *
	 * In addition primitive types and empty containers will have a size
	 * of 1, so no special handling is needed there.
	 *
	 * For non-empty containers 'current' needs to be advanced by all the
	 * containers child tokens, plus the container itself.
	 *
	 * This check ensures:
	 *    1. It is not the initial iteration
	 *    2. This is a container
	 *    3. The container is not empty
	 */
	if (iter->current != iter->start && ((t->type == JSMN_OBJECT ||
					t->type == JSMN_ARRAY) && t->size))
		inc = count_tokens_in_container(iter, t) + 1;

	if (c->tokens + iter->current + inc >= ITER_END(iter))
		return false;

	iter->current += inc;

	return true;
}