#include "json.h"
#include <glib.h>
#include <stdio.h>

Include dependency graph for jsonpull.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	gvm_json_path_elem
	Path element types for the JSON pull parser. More...
struct	gvm_json_pull_event_t
	Event generated by the JSON pull parser. More...
struct	gvm_json_pull_parser_t
	A json pull parser. More...

Macros
#define	_GNU_SOURCE
#define	GVM_JSON_PULL_PARSE_BUFFER_LIMIT 10485760
#define	GVM_JSON_PULL_READ_BUFFER_SIZE 4096

Typedefs
typedef struct gvm_json_path_elem	gvm_json_path_elem_t
	Path element types for the JSON pull parser.

Enumerations
enum	gvm_json_pull_container_type_t { GVM_JSON_PULL_CONTAINER_NONE = 0 , GVM_JSON_PULL_CONTAINER_ARRAY , GVM_JSON_PULL_CONTAINER_OBJECT }
	Type of container the parser is currently in. More...
enum	gvm_json_pull_event_type_t { GVM_JSON_PULL_EVENT_UNDEFINED = 0 , GVM_JSON_PULL_EVENT_ARRAY_START , GVM_JSON_PULL_EVENT_ARRAY_END , GVM_JSON_PULL_EVENT_OBJECT_START , GVM_JSON_PULL_EVENT_OBJECT_END , GVM_JSON_PULL_EVENT_STRING , GVM_JSON_PULL_EVENT_NUMBER , GVM_JSON_PULL_EVENT_BOOLEAN , GVM_JSON_PULL_EVENT_NULL , GVM_JSON_PULL_EVENT_EOF , GVM_JSON_PULL_EVENT_ERROR }
	Event types for the JSON pull parser. More...
enum	gvm_json_pull_expect_t { GVM_JSON_PULL_EXPECT_UNDEFINED = 0 , GVM_JSON_PULL_EXPECT_VALUE , GVM_JSON_PULL_EXPECT_KEY , GVM_JSON_PULL_EXPECT_COMMA , GVM_JSON_PULL_EXPECT_EOF }
	Expected token state for the JSON pull parser. More...

Functions
gvm_json_path_elem_t *	gvm_json_pull_path_elem_new (gvm_json_pull_container_type_t, int)
	Creates a new JSON path element.
void	gvm_json_pull_path_elem_free (gvm_json_path_elem_t *)
	Frees a JSON path element.
void	gvm_json_pull_event_init (gvm_json_pull_event_t *)
	Initializes a JSON pull event data structure.
void	gvm_json_pull_event_cleanup (gvm_json_pull_event_t *)
	Frees all data of JSON pull event data structure.
void	gvm_json_pull_parser_init_full (gvm_json_pull_parser_t , FILE , size_t, size_t)
	Initializes a JSON pull parser.
void	gvm_json_pull_parser_init (gvm_json_pull_parser_t , FILE )
	Initializes a JSON pull parser with default buffer sizes.
void	gvm_json_pull_parser_cleanup (gvm_json_pull_parser_t *)
	Frees the data of a JSON pull parser.
void	gvm_json_pull_parser_next (gvm_json_pull_parser_t , gvm_json_pull_event_t )
	Get the next event from a JSON pull parser.
cJSON *	gvm_json_pull_expand_container (gvm_json_pull_parser_t , gchar *)
	Expands the current array or object of a JSON pull parser.
gchar *	gvm_json_path_to_string (GQueue *path)
	Converts a path as used by a JSON pull parser to a JSONPath string.

Macro Definition Documentation

◆ _GNU_SOURCE

#define _GNU_SOURCE

Definition at line 9 of file jsonpull.h.

◆ GVM_JSON_PULL_PARSE_BUFFER_LIMIT

#define GVM_JSON_PULL_PARSE_BUFFER_LIMIT 10485760

Definition at line 78 of file jsonpull.h.

Referenced by Ensure(), and gvm_json_pull_parser_init_full().

◆ GVM_JSON_PULL_READ_BUFFER_SIZE

#define GVM_JSON_PULL_READ_BUFFER_SIZE 4096

Definition at line 80 of file jsonpull.h.

Referenced by Ensure(), and gvm_json_pull_parser_init_full().

Typedef Documentation

◆ gvm_json_path_elem_t

typedef struct gvm_json_path_elem gvm_json_path_elem_t

Path element types for the JSON pull parser.

Enumeration Type Documentation

◆ gvm_json_pull_container_type_t

enum gvm_json_pull_container_type_t

Type of container the parser is currently in.

Enumerator
GVM_JSON_PULL_CONTAINER_NONE	No container / document root.
GVM_JSON_PULL_CONTAINER_ARRAY	Array.
GVM_JSON_PULL_CONTAINER_OBJECT	Object.

Definition at line 19 of file jsonpull.h.

{
  GVM_JSON_PULL_CONTAINER_NONE = 0, 
  GVM_JSON_PULL_CONTAINER_ARRAY,    
  GVM_JSON_PULL_CONTAINER_OBJECT,   
} gvm_json_pull_container_type_t;

◆ gvm_json_pull_event_type_t

enum gvm_json_pull_event_type_t

Event types for the JSON pull parser.

Enumerator
GVM_JSON_PULL_EVENT_UNDEFINED
GVM_JSON_PULL_EVENT_ARRAY_START
GVM_JSON_PULL_EVENT_ARRAY_END
GVM_JSON_PULL_EVENT_OBJECT_START
GVM_JSON_PULL_EVENT_OBJECT_END
GVM_JSON_PULL_EVENT_STRING
GVM_JSON_PULL_EVENT_NUMBER
GVM_JSON_PULL_EVENT_BOOLEAN
GVM_JSON_PULL_EVENT_NULL
GVM_JSON_PULL_EVENT_EOF
GVM_JSON_PULL_EVENT_ERROR

Definition at line 40 of file jsonpull.h.

{
  GVM_JSON_PULL_EVENT_UNDEFINED = 0,
  GVM_JSON_PULL_EVENT_ARRAY_START,
  GVM_JSON_PULL_EVENT_ARRAY_END,
  GVM_JSON_PULL_EVENT_OBJECT_START,
  GVM_JSON_PULL_EVENT_OBJECT_END,
  GVM_JSON_PULL_EVENT_STRING,
  GVM_JSON_PULL_EVENT_NUMBER,
  GVM_JSON_PULL_EVENT_BOOLEAN,
  GVM_JSON_PULL_EVENT_NULL,
  GVM_JSON_PULL_EVENT_EOF,
  GVM_JSON_PULL_EVENT_ERROR,
} gvm_json_pull_event_type_t;

◆ gvm_json_pull_expect_t

enum gvm_json_pull_expect_t

Expected token state for the JSON pull parser.

Enumerator
GVM_JSON_PULL_EXPECT_UNDEFINED	Undefined state.
GVM_JSON_PULL_EXPECT_VALUE	Expect start of a value.
GVM_JSON_PULL_EXPECT_KEY	Expect start of a key.
GVM_JSON_PULL_EXPECT_COMMA	Expect comma or container end brace.
GVM_JSON_PULL_EXPECT_EOF	Expect end of file.

Definition at line 69 of file jsonpull.h.

{
  GVM_JSON_PULL_EXPECT_UNDEFINED = 0, 
  GVM_JSON_PULL_EXPECT_VALUE,         
  GVM_JSON_PULL_EXPECT_KEY,           
  GVM_JSON_PULL_EXPECT_COMMA,         
  GVM_JSON_PULL_EXPECT_EOF            
} gvm_json_pull_expect_t;

Function Documentation

◆ gvm_json_path_to_string()

gchar * gvm_json_path_to_string ( GQueue * path )

Converts a path as used by a JSON pull parser to a JSONPath string.

Parameters

[in] path The path to convert

Returns: Newly allocated string of the path in JSONPath bracket notation

Definition at line 910 of file jsonpull.c.

{
  GString *path_string = g_string_new ("$");
  g_queue_foreach (path, (GFunc) gvm_json_path_string_add_elem, path_string);
  return g_string_free (path_string, FALSE);
}

References gvm_json_path_string_add_elem().

Referenced by parse_vt_json().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gvm_json_pull_event_cleanup()

void gvm_json_pull_event_cleanup ( gvm_json_pull_event_t * event )

Frees all data of JSON pull event data structure.

Parameters

[in] event The event structure to clean up

Definition at line 61 of file jsonpull.c.

{
  cJSON_Delete (event->value);
  if (event->error_message)
    g_free (event->error_message);
  memset (event, 0, sizeof (gvm_json_pull_event_t));
}

References gvm_json_pull_event_t::error_message, and gvm_json_pull_event_t::value.

Referenced by Ensure(), Ensure(), and gvm_json_pull_parser_next().

Here is the caller graph for this function:

◆ gvm_json_pull_event_init()

void gvm_json_pull_event_init ( gvm_json_pull_event_t * event )

Initializes a JSON pull event data structure.

Parameters

[in] event The event structure to initialize

Definition at line 50 of file jsonpull.c.

{
  memset (event, 0, sizeof (gvm_json_pull_event_t));
}

Referenced by Ensure().

Here is the caller graph for this function:

◆ gvm_json_pull_expand_container()

cJSON * gvm_json_pull_expand_container	(	gvm_json_pull_parser_t *	parser,
		gchar **	error_message )

Expands the current array or object of a JSON pull parser.

This should be called after an array or object start event.

Parameters

[in]	parser	Parser to get the current container element from
[out]	error_message	Error message output

Returns: The expanded container as a cJSON object if successful, else NULL

Definition at line 746 of file jsonpull.c.

{
  gvm_json_path_elem_t *path_tail = NULL;
 
  int start_depth;
  gboolean in_string, escape_next_char, in_expanded_container;
  cJSON *expanded;
 
  g_string_truncate (parser->parse_buffer, 0);
 
  if (error_message)
    *error_message = NULL;
 
  // require "path_add" to only allow expansion at start of container
  if (parser->path_add)
    {
      path_tail = parser->path_add;
      g_queue_push_tail (parser->path, path_tail);
      parser->path_add = NULL;
    }
 
  if (path_tail && path_tail->parent_type == GVM_JSON_PULL_CONTAINER_ARRAY)
    g_string_append_c (parser->parse_buffer, '[');
  else if (path_tail
           && path_tail->parent_type == GVM_JSON_PULL_CONTAINER_OBJECT)
    g_string_append_c (parser->parse_buffer, '{');
  else
    {
      if (error_message)
        *error_message =
          g_strdup ("can only expand after array or object start");
      return NULL;
    }
 
  start_depth = path_tail->depth;
  in_string = escape_next_char = FALSE;
  in_expanded_container = TRUE;
 
  while (parser->last_read_char >= 0 && in_expanded_container)
    {
      if (parser->parse_buffer->len >= parser->parse_buffer_limit)
        {
          if (error_message)
            *error_message =
              g_strdup_printf ("container exceeds size limit of %zu bytes",
                               parser->parse_buffer_limit);
          return NULL;
        }
 
      g_string_append_c (parser->parse_buffer, parser->last_read_char);
 
      if (escape_next_char)
        {
          escape_next_char = FALSE;
        }
      else if (in_string)
        {
          escape_next_char = (parser->last_read_char == '\\');
          in_string = (parser->last_read_char != '"');
        }
      else
        {
          switch (parser->last_read_char)
            {
            case '"':
              in_string = TRUE;
              break;
            case '[':
              path_tail = gvm_json_pull_path_elem_new (
                GVM_JSON_PULL_CONTAINER_ARRAY, parser->path->length);
              g_queue_push_tail (parser->path, path_tail);
              break;
            case '{':
              path_tail = gvm_json_pull_path_elem_new (
                GVM_JSON_PULL_CONTAINER_OBJECT, parser->path->length);
              g_queue_push_tail (parser->path, path_tail);
              break;
            case ']':
              path_tail = g_queue_pop_tail (parser->path);
              if (path_tail->parent_type != GVM_JSON_PULL_CONTAINER_ARRAY)
                {
                  if (error_message)
                    *error_message =
                      g_strdup ("unexpected closing square bracket");
                  gvm_json_pull_path_elem_free (path_tail);
                  return NULL;
                }
              if (path_tail->depth == start_depth)
                in_expanded_container = FALSE;
 
              gvm_json_pull_path_elem_free (path_tail);
              break;
            case '}':
              path_tail = g_queue_pop_tail (parser->path);
              if (path_tail->parent_type != GVM_JSON_PULL_CONTAINER_OBJECT)
                {
                  if (error_message)
                    *error_message =
                      g_strdup ("unexpected closing curly brace");
                  gvm_json_pull_path_elem_free (path_tail);
                  return NULL;
                }
              if (path_tail->depth == start_depth)
                in_expanded_container = FALSE;
 
              gvm_json_pull_path_elem_free (path_tail);
              break;
            }
        }
      gvm_json_pull_parser_next_char (parser);
    }
 
  if (parser->last_read_char == GVM_JSON_CHAR_ERROR)
    {
      if (error_message)
        *error_message = gvm_json_read_stream_error_str ();
      return NULL;
    }
  else if (in_expanded_container && parser->last_read_char == GVM_JSON_CHAR_EOF)
    {
      if (error_message)
        *error_message = g_strdup ("unexpected EOF");
      return NULL;
    }
 
  expanded = cJSON_Parse (parser->parse_buffer->str);
  g_string_truncate (parser->parse_buffer, 0);
  parse_value_next_expect (parser);
 
  if (expanded == NULL && error_message)
    *error_message = g_strdup ("could not parse expanded container");
 
  return expanded;
}

References gvm_json_path_elem::depth, GVM_JSON_CHAR_EOF, GVM_JSON_CHAR_ERROR, GVM_JSON_PULL_CONTAINER_ARRAY, GVM_JSON_PULL_CONTAINER_OBJECT, gvm_json_pull_parser_next_char(), gvm_json_pull_path_elem_free(), gvm_json_pull_path_elem_new(), gvm_json_read_stream_error_str(), gvm_json_pull_parser_t::last_read_char, gvm_json_path_elem::parent_type, gvm_json_pull_parser_t::parse_buffer, gvm_json_pull_parser_t::parse_buffer_limit, parse_value_next_expect(), gvm_json_pull_parser_t::path, and gvm_json_pull_parser_t::path_add.

Referenced by Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), and parse_vt_json().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gvm_json_pull_parser_cleanup()

void gvm_json_pull_parser_cleanup ( gvm_json_pull_parser_t * parser )

Frees the data of a JSON pull parser.

Parameters

[in] parser The parser data structure to free the data of

Definition at line 120 of file jsonpull.c.

{
  assert (parser);
  g_queue_free_full (parser->path,
                     (GDestroyNotify) gvm_json_pull_path_elem_free);
  g_string_free (parser->parse_buffer, TRUE);
  g_free (parser->read_buffer);
  memset (parser, 0, sizeof (gvm_json_pull_parser_t));
}

References gvm_json_pull_path_elem_free(), gvm_json_pull_parser_t::parse_buffer, gvm_json_pull_parser_t::path, and gvm_json_pull_parser_t::read_buffer.

Referenced by Ensure(), Ensure(), and Ensure().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gvm_json_pull_parser_init()

void gvm_json_pull_parser_init	(	gvm_json_pull_parser_t *	parser,
		FILE *	input_stream )

Initializes a JSON pull parser with default buffer sizes.

Parameters

[in]	parser	The parser data structure to initialize
[in]	input_stream	The JSON input stream

Definition at line 109 of file jsonpull.c.

{
  gvm_json_pull_parser_init_full (parser, input_stream, 0, 0);
}

References gvm_json_pull_parser_init_full().

Referenced by Ensure(), and Ensure().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gvm_json_pull_parser_init_full()

void gvm_json_pull_parser_init_full	(	gvm_json_pull_parser_t *	parser,
		FILE *	input_stream,
		size_t	parse_buffer_limit,
		size_t	read_buffer_size )

Initializes a JSON pull parser.

Parameters

[in]	parser	The parser data structure to initialize
[in]	input_stream	The JSON input stream
[in]	parse_buffer_limit	Maximum buffer size for parsing values
[in]	read_buffer_size	Buffer size for reading from the stream

Definition at line 78 of file jsonpull.c.

{
  assert (parser);
  assert (input_stream);
  memset (parser, 0, sizeof (gvm_json_pull_parser_t));
 
  if (parse_buffer_limit <= 0)
    parse_buffer_limit = GVM_JSON_PULL_PARSE_BUFFER_LIMIT;
 
  if (read_buffer_size <= 0)
    read_buffer_size = GVM_JSON_PULL_READ_BUFFER_SIZE;
 
  parser->input_stream = input_stream;
  parser->path = g_queue_new ();
  parser->expect = GVM_JSON_PULL_EXPECT_VALUE;
  parser->parse_buffer_limit = parse_buffer_limit;
  parser->parse_buffer = g_string_new ("");
  parser->read_buffer_size = read_buffer_size;
  parser->read_buffer = g_malloc0 (read_buffer_size);
  parser->last_read_char = GVM_JSON_CHAR_UNDEFINED;
}

References gvm_json_pull_parser_t::expect, GVM_JSON_CHAR_UNDEFINED, GVM_JSON_PULL_EXPECT_VALUE, GVM_JSON_PULL_PARSE_BUFFER_LIMIT, GVM_JSON_PULL_READ_BUFFER_SIZE, gvm_json_pull_parser_t::input_stream, gvm_json_pull_parser_t::last_read_char, gvm_json_pull_parser_t::parse_buffer, gvm_json_pull_parser_t::parse_buffer_limit, gvm_json_pull_parser_t::path, gvm_json_pull_parser_t::read_buffer, and gvm_json_pull_parser_t::read_buffer_size.

Referenced by gvm_json_pull_parser_init().

Here is the caller graph for this function:

◆ gvm_json_pull_parser_next()

void gvm_json_pull_parser_next	(	gvm_json_pull_parser_t *	parser,
		gvm_json_pull_event_t *	event )

Get the next event from a JSON pull parser.

Note: This invalidates previous event data like the cJSON value.

Parameters

[in]	parser	The JSON pull parser to process until the next event
[in]	event	Structure to store event data in.

Definition at line 669 of file jsonpull.c.

{
  assert (parser);
  assert (event);
 
  gvm_json_pull_event_cleanup (event);
  if (parser->last_read_char == GVM_JSON_CHAR_UNDEFINED)
    {
      // Handle first read of the stream
      if (gvm_json_pull_parser_next_char (parser) < 0)
        {
          gvm_json_pull_handle_read_end (parser, event, TRUE);
          return;
        }
    }
 
  event->path = parser->path;
 
  // Delayed addition to path after a container start element
  if (parser->path_add)
    {
      g_queue_push_tail (parser->path, parser->path_add);
      parser->path_add = NULL;
    }
 
  // Check for expected end of file
  if (parser->expect == GVM_JSON_PULL_EXPECT_EOF)
    {
      if (gvm_json_pull_skip_space (parser, event, TRUE))
        {
          // EOF was reached, or an error occurred.
          // The event type is already set, and if an error occurred, then
          // error_message is also already set.
          return;
        }
 
      // Skipping space succeeded. Check for unexpected characters at EOF.
 
      if (parser->last_read_char == GVM_JSON_CHAR_EOF)
        return;
 
      event->type = GVM_JSON_PULL_EVENT_ERROR;
      event->error_message = g_strdup_printf (
        "unexpected character at end of file (%d)", parser->last_read_char);
      return;
    }
 
  if (parser->expect == GVM_JSON_PULL_EXPECT_COMMA)
    {
      if (gvm_json_pull_parse_comma (parser, event))
        return;
    }
 
  if (parser->expect == GVM_JSON_PULL_EXPECT_KEY)
    {
      if (gvm_json_pull_parse_key (parser, event))
        return;
    }
 
  if (parser->expect == GVM_JSON_PULL_EXPECT_VALUE)
    {
      gvm_json_pull_parse_value (parser, event);
    }
}

Here is the call graph for this function:

◆ gvm_json_pull_path_elem_free()

void gvm_json_pull_path_elem_free ( gvm_json_path_elem_t * elem )

Frees a JSON path element.

Parameters

[in] elem The element to free

Definition at line 38 of file jsonpull.c.

{
  g_free (elem->key);
  g_free (elem);
}

References gvm_json_path_elem::key.

Referenced by gvm_json_pull_expand_container(), gvm_json_pull_parse_comma(), gvm_json_pull_parse_key(), gvm_json_pull_parse_value(), and gvm_json_pull_parser_cleanup().

Here is the caller graph for this function:

◆ gvm_json_pull_path_elem_new()

gvm_json_path_elem_t * gvm_json_pull_path_elem_new	(	gvm_json_pull_container_type_t	parent_type,
		int	depth )

Creates a new JSON path element.

Parameters

[in]	parent_type	Type of the parent (array, object, none/root)
[in]	depth	The depth in the document tree

Returns: The newly allocated path element

Definition at line 23 of file jsonpull.c.

{
  gvm_json_path_elem_t *new_elem = g_malloc0 (sizeof (gvm_json_path_elem_t));
  new_elem->parent_type = parent_type;
  new_elem->depth = depth;
  return new_elem;
}

References gvm_json_path_elem::depth, and gvm_json_path_elem::parent_type.

Referenced by gvm_json_pull_expand_container(), and gvm_json_pull_parse_value().

Here is the caller graph for this function:

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ _GNU_SOURCE

◆ GVM_JSON_PULL_PARSE_BUFFER_LIMIT

◆ GVM_JSON_PULL_READ_BUFFER_SIZE

Typedef Documentation

◆ gvm_json_path_elem_t

Enumeration Type Documentation

◆ gvm_json_pull_container_type_t

◆ gvm_json_pull_event_type_t

◆ gvm_json_pull_expect_t

Function Documentation

◆ gvm_json_path_to_string()

◆ gvm_json_pull_event_cleanup()

◆ gvm_json_pull_event_init()

◆ gvm_json_pull_expand_container()

◆ gvm_json_pull_parser_cleanup()

◆ gvm_json_pull_parser_init()

◆ gvm_json_pull_parser_init_full()

◆ gvm_json_pull_parser_next()

◆ gvm_json_pull_path_elem_free()

◆ gvm_json_pull_path_elem_new()