json.h File Reference

#include <cjson/cJSON.h>
#include <glib.h>

Include dependency graph for json.h:

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

Go to the source code of this file.

Macros
#define	_GNU_SOURCE

Functions
gchar *	gvm_json_string_escape (const char *, gboolean)
	Escapes a string according to the JSON or JSONPath standard.
double	gvm_json_obj_double (cJSON *, const gchar *)
	Get a double field from a JSON object.
int	gvm_json_obj_check_int (cJSON *, const gchar *, int *)
	Get an int field from a JSON object.
int	gvm_json_obj_int (cJSON *, const gchar *)
	Get an int field from a JSON object.
int	gvm_json_obj_check_str (cJSON *, const gchar *, gchar **)
	Get a string field from a JSON object.
gchar *	gvm_json_obj_str (cJSON *, const gchar *)
	Get a string field from a JSON object.

Macro Definition Documentation

_GNU_SOURCE

#define _GNU_SOURCE

Definition at line 9 of file json.h.

Function Documentation

gvm_json_obj_check_int()

int gvm_json_obj_check_int	(	cJSON *	obj,
		const gchar *	key,
		int *	val )

Get an int field from a JSON object.

Parameters

[in]	obj	Object
[in]	key	Field name.
[out]	val	Either NULL or a return location for the int (only set if int field exists).

Returns

0 if such an int field exists, else 1.

Definition at line 97 of file json.c.

{
  cJSON *item;
 
  item = cJSON_GetObjectItem (obj, key);
  if (item && cJSON_IsNumber (item))
    {
      if (val)
        *val = item->valueint;
      return 0;
    }
  return 1;
}

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

Here is the caller graph for this function:

gvm_json_obj_check_str()

int gvm_json_obj_check_str	(	cJSON *	obj,
		const gchar *	key,
		gchar **	val )

Get a string field from a JSON object.

Parameters

[in]	obj	Object
[in]	key	Field name.
[out]	val	Either NULL or a return location for the string (only set if string field exists). Freed by cJSON_Delete.

Returns

0 if such a field exists, else 1.

Definition at line 142 of file json.c.

{
  cJSON *item;
 
  item = cJSON_GetObjectItem (obj, key);
  if (item && cJSON_IsString (item))
    {
      if (val)
        *val = item->valuestring;
      return 0;
    }
  return 1;
}

Referenced by add_preferences_to_nvt(), add_tags_to_nvt(), Ensure(), Ensure(), Ensure(), Ensure(), parse_references(), and parse_vt_json().

Here is the caller graph for this function:

gvm_json_obj_double()

double gvm_json_obj_double	(	cJSON *	obj,
		const gchar *	key )

Get a double field from a JSON object.

Parameters

[in]	obj	Object
[in]	key	Field name.

Returns

A double.

Definition at line 75 of file json.c.

{
  cJSON *item;
 
  item = cJSON_GetObjectItem (obj, key);
  if (item && cJSON_IsNumber (item))
    return item->valuedouble;
 
  return 0;
}

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

Here is the caller graph for this function:

gvm_json_obj_int()

int gvm_json_obj_int	(	cJSON *	obj,
		const gchar *	key )

Get an int field from a JSON object.

Parameters

[in]	obj	Object
[in]	key	Field name.

Returns

An int.

Definition at line 120 of file json.c.

{
  cJSON *item;
 
  item = cJSON_GetObjectItem (obj, key);
  if (item && cJSON_IsNumber (item))
    return item->valueint;
 
  return 0;
}

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

Here is the caller graph for this function:

gvm_json_obj_str()

gchar * gvm_json_obj_str	(	cJSON *	obj,
		const gchar *	key )

Get a string field from a JSON object.

Parameters

[in]	obj	Object
[in]	key	Field name.

Returns

A string. Will be freed by cJSON_Delete.

Definition at line 165 of file json.c.

{
  cJSON *item;
 
  item = cJSON_GetObjectItem (obj, key);
  if (item && cJSON_IsString (item))
    return item->valuestring;
 
  return 0;
}

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

Here is the caller graph for this function:

gvm_json_string_escape()

gchar * gvm_json_string_escape	(	const char *	string,
		gboolean	single_quote )

Escapes a string according to the JSON or JSONPath standard.

Parameters

[in]	string	The string to escape
[in]	single_quote	Whether to escape single quotes

Returns

The escaped string

Definition at line 17 of file json.c.

{
  gchar *point;
  if (string == NULL)
    return NULL;
 
  GString *escaped = g_string_sized_new (strlen (string));
  for (point = (char *) string; *point != 0; point++)
    {
      unsigned char character = *point;
 
      if ((character > 31) && (character != '\\')
          && (single_quote ? (character != '\'') : (character != '\"')))
        {
          g_string_append_c (escaped, character);
        }
      else
        {
          g_string_append_c (escaped, '\\');
          switch (*point)
            {
            case '\\':
            case '\'':
            case '\"':
              g_string_append_c (escaped, *point);
              break;
            case '\b':
              g_string_append_c (escaped, 'b');
              break;
            case '\f':
              g_string_append_c (escaped, 'f');
              break;
            case '\n':
              g_string_append_c (escaped, 'n');
              break;
            case '\r':
              g_string_append_c (escaped, 'r');
              break;
            case '\t':
              g_string_append_c (escaped, 't');
              break;
            default:
              g_string_append_printf (escaped, "u%04x", character);
            }
        }
    }
  return g_string_free (escaped, FALSE);
}

Referenced by Ensure(), and gvm_json_path_string_add_elem().

Here is the caller graph for this function: