Blame json_pointer.c

Packit ea8578
/*
Packit ea8578
 * Copyright (c) 2016 Alexandru Ardelean.
Packit ea8578
 *
Packit ea8578
 * This is free software; you can redistribute it and/or modify
Packit ea8578
 * it under the terms of the MIT license. See COPYING for details.
Packit ea8578
 *
Packit ea8578
 */
Packit ea8578
Packit ea8578
#include "config.h"
Packit ea8578
Packit ea8578
#include "strerror_override.h"
Packit ea8578
Packit ea8578
#include <stdarg.h>
Packit ea8578
#include <stdio.h>
Packit ea8578
#include <stdlib.h>
Packit ea8578
#include <string.h>
Packit ea8578
#include <ctype.h>
Packit ea8578
Packit ea8578
#include "json_pointer.h"
Packit ea8578
#include "strdup_compat.h"
Packit ea8578
#include "vasprintf_compat.h"
Packit ea8578
Packit ea8578
/**
Packit ea8578
 * JavaScript Object Notation (JSON) Pointer
Packit ea8578
 *   RFC 6901 - https://tools.ietf.org/html/rfc6901
Packit ea8578
 */
Packit ea8578
Packit ea8578
static void string_replace_all_occurrences_with_char(char *s, const char *occur, char repl_char)
Packit ea8578
{
Packit ea8578
	int slen = strlen(s);
Packit ea8578
	int skip = strlen(occur) - 1; /* length of the occurence, minus the char we're replacing */
Packit ea8578
	char *p = s;
Packit ea8578
	while ((p = strstr(p, occur))) {
Packit ea8578
		*p = repl_char;
Packit ea8578
		p++;
Packit ea8578
		slen -= skip;
Packit ea8578
		memmove(p, (p + skip), slen - (p - s) + 1); /* includes null char too */
Packit ea8578
	}
Packit ea8578
}
Packit ea8578
Packit ea8578
static int is_valid_index(struct json_object *jo, const char *path, int32_t *idx)
Packit ea8578
{
Packit ea8578
	int i, len = strlen(path);
Packit ea8578
	/* this code-path optimizes a bit, for when we reference the 0-9 index range in a JSON array
Packit ea8578
	   and because leading zeros not allowed */
Packit ea8578
	if (len == 1) {
Packit ea8578
		if (isdigit((int)path[0])) {
Packit ea8578
			*idx = (path[0] - '0');
Packit ea8578
			goto check_oob;
Packit ea8578
		}
Packit ea8578
		errno = EINVAL;
Packit ea8578
		return 0;
Packit ea8578
	}
Packit ea8578
	/* leading zeros not allowed per RFC */
Packit ea8578
	if (path[0] == '0') {
Packit ea8578
		errno = EINVAL;
Packit ea8578
		return 0;
Packit ea8578
	}
Packit ea8578
	/* RFC states base-10 decimals */
Packit ea8578
	for (i = 0; i < len; i++) {
Packit ea8578
		if (!isdigit((int)path[i])) {
Packit ea8578
			errno = EINVAL;
Packit ea8578
			return 0;
Packit ea8578
		}
Packit ea8578
	}
Packit ea8578
Packit ea8578
	*idx = strtol(path, NULL, 10);
Packit ea8578
	if (*idx < 0) {
Packit ea8578
		errno = EINVAL;
Packit ea8578
		return 0;
Packit ea8578
	}
Packit ea8578
check_oob:
Packit ea8578
	len = json_object_array_length(jo);
Packit ea8578
	if (*idx >= len) {
Packit ea8578
		errno = ENOENT;
Packit ea8578
		return 0;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	return 1;
Packit ea8578
}
Packit ea8578
Packit ea8578
static int json_pointer_get_single_path(struct json_object *obj, char *path, struct json_object **value)
Packit ea8578
{
Packit ea8578
	if (json_object_is_type(obj, json_type_array)) {
Packit ea8578
		int32_t idx;
Packit ea8578
		if (!is_valid_index(obj, path, &idx))
Packit ea8578
			return -1;
Packit ea8578
		obj = json_object_array_get_idx(obj, idx);
Packit ea8578
		if (obj) {
Packit ea8578
			if (value)
Packit ea8578
				*value = obj;
Packit ea8578
			return 0;
Packit ea8578
		}
Packit ea8578
		/* Entry not found */
Packit ea8578
		errno = ENOENT;
Packit ea8578
		return -1;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	/* RFC states that we first must eval all ~1 then all ~0 */
Packit ea8578
	string_replace_all_occurrences_with_char(path, "~1", '/');
Packit ea8578
	string_replace_all_occurrences_with_char(path, "~0", '~');
Packit ea8578
Packit ea8578
	if (!json_object_object_get_ex(obj, path, value)) {
Packit ea8578
		errno = ENOENT;
Packit ea8578
		return -1;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	return 0;
Packit ea8578
}
Packit ea8578
Packit ea8578
static int json_pointer_set_single_path(
Packit ea8578
	struct json_object *parent,
Packit ea8578
	const char *path,
Packit ea8578
	struct json_object *value)
Packit ea8578
{
Packit ea8578
	if (json_object_is_type(parent, json_type_array)) {
Packit ea8578
		int32_t idx;
Packit ea8578
		/* RFC (Chapter 4) states that '-' may be used to add new elements to an array */
Packit ea8578
		if (path[0] == '-' && path[1] == '\0')
Packit ea8578
			return json_object_array_add(parent, value);
Packit ea8578
		if (!is_valid_index(parent, path, &idx))
Packit ea8578
			return -1;
Packit ea8578
		return json_object_array_put_idx(parent, idx, value);
Packit ea8578
	}
Packit ea8578
Packit ea8578
	/* path replacements should have been done in json_pointer_get_single_path(),
Packit ea8578
	   and we should still be good here */
Packit ea8578
	if (json_object_is_type(parent, json_type_object))
Packit ea8578
		return json_object_object_add(parent, path, value);
Packit ea8578
Packit ea8578
	/* Getting here means that we tried to "dereference" a primitive JSON type (like string, int, bool).
Packit ea8578
	   i.e. add a sub-object to it */
Packit ea8578
	errno = ENOENT;
Packit ea8578
	return -1;
Packit ea8578
}
Packit ea8578
Packit ea8578
static int json_pointer_get_recursive(
Packit ea8578
	struct json_object *obj,
Packit ea8578
	char *path,
Packit ea8578
	struct json_object **value)
Packit ea8578
{
Packit ea8578
	char *endp;
Packit ea8578
	int rc;
Packit ea8578
Packit ea8578
	/* All paths (on each recursion level must have a leading '/' */
Packit ea8578
	if (path[0] != '/') {
Packit ea8578
		errno = EINVAL;
Packit ea8578
		return -1;
Packit ea8578
	}
Packit ea8578
	path++;
Packit ea8578
Packit ea8578
	endp = strchr(path, '/');
Packit ea8578
	if (endp)
Packit ea8578
		*endp = '\0';
Packit ea8578
Packit ea8578
	/* If we err-ed here, return here */
Packit ea8578
	if ((rc = json_pointer_get_single_path(obj, path, &obj)))
Packit ea8578
		return rc;
Packit ea8578
Packit ea8578
	if (endp) {
Packit ea8578
		*endp = '/'; /* Put the slash back, so that the sanity check passes on next recursion level */
Packit ea8578
		return json_pointer_get_recursive(obj, endp, value);
Packit ea8578
	}
Packit ea8578
Packit ea8578
	/* We should be at the end of the recursion here */
Packit ea8578
	if (value)
Packit ea8578
		*value = obj;
Packit ea8578
Packit ea8578
	return 0;
Packit ea8578
}
Packit ea8578
Packit ea8578
int json_pointer_get(struct json_object *obj, const char *path, struct json_object **res)
Packit ea8578
{
Packit ea8578
	char *path_copy = NULL;
Packit ea8578
	int rc;
Packit ea8578
Packit ea8578
	if (!obj || !path) {
Packit ea8578
		errno = EINVAL;
Packit ea8578
		return -1;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	if (path[0] == '\0') {
Packit ea8578
		if (res)
Packit ea8578
			*res = obj;
Packit ea8578
		return 0;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	/* pass a working copy to the recursive call */
Packit ea8578
	if (!(path_copy = strdup(path))) {
Packit ea8578
		errno = ENOMEM;
Packit ea8578
		return -1;
Packit ea8578
	}
Packit ea8578
	rc = json_pointer_get_recursive(obj, path_copy, res);
Packit ea8578
	free(path_copy);
Packit ea8578
Packit ea8578
	return rc;
Packit ea8578
}
Packit ea8578
Packit ea8578
int json_pointer_getf(struct json_object *obj, struct json_object **res, const char *path_fmt, ...)
Packit ea8578
{
Packit ea8578
	char *path_copy = NULL;
Packit ea8578
	int rc = 0;
Packit ea8578
	va_list args;
Packit ea8578
Packit ea8578
	if (!obj || !path_fmt) {
Packit ea8578
		errno = EINVAL;
Packit ea8578
		return -1;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	va_start(args, path_fmt);
Packit ea8578
	rc = vasprintf(&path_copy, path_fmt, args);
Packit ea8578
	va_end(args);
Packit ea8578
Packit ea8578
	if (rc < 0)
Packit ea8578
		return rc;
Packit ea8578
Packit ea8578
	if (path_copy[0] == '\0') {
Packit ea8578
		if (res)
Packit ea8578
			*res = obj;
Packit ea8578
		goto out;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	rc = json_pointer_get_recursive(obj, path_copy, res);
Packit ea8578
out:
Packit ea8578
	free(path_copy);
Packit ea8578
Packit ea8578
	return rc;
Packit ea8578
}
Packit ea8578
Packit ea8578
int json_pointer_set(struct json_object **obj, const char *path, struct json_object *value)
Packit ea8578
{
Packit ea8578
	const char *endp;
Packit ea8578
	char *path_copy = NULL;
Packit ea8578
	struct json_object *set = NULL;
Packit ea8578
	int rc;
Packit ea8578
Packit ea8578
	if (!obj || !path) {
Packit ea8578
		errno = EINVAL;
Packit ea8578
		return -1;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	if (path[0] == '\0') {
Packit ea8578
		json_object_put(*obj);
Packit ea8578
		*obj = value;
Packit ea8578
		return 0;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	if (path[0] != '/') {
Packit ea8578
		errno = EINVAL;
Packit ea8578
		return -1;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	/* If there's only 1 level to set, stop here */
Packit ea8578
	if ((endp = strrchr(path, '/')) == path) {
Packit ea8578
		path++;
Packit ea8578
		return json_pointer_set_single_path(*obj, path, value);
Packit ea8578
	}
Packit ea8578
Packit ea8578
	/* pass a working copy to the recursive call */
Packit ea8578
	if (!(path_copy = strdup(path))) {
Packit ea8578
		errno = ENOMEM;
Packit ea8578
		return -1;
Packit ea8578
	}
Packit ea8578
	path_copy[endp - path] = '\0';
Packit ea8578
	rc = json_pointer_get_recursive(*obj, path_copy, &set);
Packit ea8578
	free(path_copy);
Packit ea8578
Packit ea8578
	if (rc)
Packit ea8578
		return rc;
Packit ea8578
Packit ea8578
	endp++;
Packit ea8578
	return json_pointer_set_single_path(set, endp, value);
Packit ea8578
}
Packit ea8578
Packit ea8578
int json_pointer_setf(struct json_object **obj, struct json_object *value, const char *path_fmt, ...)
Packit ea8578
{
Packit ea8578
	char *endp;
Packit ea8578
	char *path_copy = NULL;
Packit ea8578
	struct json_object *set = NULL;
Packit ea8578
	va_list args;
Packit ea8578
	int rc = 0;
Packit ea8578
Packit ea8578
	if (!obj || !path_fmt) {
Packit ea8578
		errno = EINVAL;
Packit ea8578
		return -1;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	/* pass a working copy to the recursive call */
Packit ea8578
	va_start(args, path_fmt);
Packit ea8578
	rc = vasprintf(&path_copy, path_fmt, args);
Packit ea8578
	va_end(args);
Packit ea8578
Packit ea8578
	if (rc < 0)
Packit ea8578
		return rc;
Packit ea8578
Packit ea8578
	if (path_copy[0] == '\0') {
Packit ea8578
		json_object_put(*obj);
Packit ea8578
		*obj = value;
Packit ea8578
		goto out;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	if (path_copy[0] != '/') {
Packit ea8578
		errno = EINVAL;
Packit ea8578
		rc = -1;
Packit ea8578
		goto out;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	/* If there's only 1 level to set, stop here */
Packit ea8578
	if ((endp = strrchr(path_copy, '/')) == path_copy) {
Packit ea8578
		set = *obj;
Packit ea8578
		goto set_single_path;
Packit ea8578
	}
Packit ea8578
Packit ea8578
	*endp = '\0';
Packit ea8578
	rc = json_pointer_get_recursive(*obj, path_copy, &set);
Packit ea8578
Packit ea8578
	if (rc)
Packit ea8578
		goto out;
Packit ea8578
Packit ea8578
set_single_path:
Packit ea8578
	endp++;
Packit ea8578
	rc = json_pointer_set_single_path(set, endp, value);
Packit ea8578
out:
Packit ea8578
	free(path_copy);
Packit ea8578
	return rc;
Packit ea8578
}
Packit ea8578