xmlutils.h File Reference

Headers for simple XML reader. More...

#include "serverutils.h"
#include <glib.h>
#include <gnutls/gnutls.h>
#include <stdio.h>

Include dependency graph for xmlutils.h:

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

Go to the source code of this file.

Data Structures
struct	context_data_t
	XML context. More...
struct	entity_s
	XML element. More...
struct	xml_search_data_t
	Data for xml search functions. More...

Typedefs
typedef GSList *	entities_t
	Entities. More...
typedef struct entity_s *	entity_t
typedef struct _xmlNode *	element_t

Functions
void	xml_handle_start_element (context_data_t *, const gchar *, const gchar **, const gchar **)
	Handle the start of an OMP XML element. More...
void	xml_handle_end_element (context_data_t *, const gchar *)
	Handle the end of an XML element. More...
void	xml_handle_text (context_data_t *, const gchar *, gsize)
	Handle additional text of an XML element. More...
entities_t	next_entities (entities_t)
	Return all the entities from an entities_t after the first. More...
entity_t	first_entity (entities_t)
	Return the first entity from an entities_t. More...
entity_t	add_entity (entities_t *, const char *, const char *)
	Add an XML entity to a tree of entities. More...
int	compare_entities (entity_t, entity_t)
	Compare two XML entity. More...
entity_t	entity_child (entity_t, const char *)
	Get a child of an entity. More...
const char *	entity_attribute (entity_t, const char *)
	Get an attribute of an entity. More...
char *	entity_name (entity_t entity)
	Get the name an entity. More...
char *	entity_text (entity_t entity)
	Get the text an entity. More...
void	free_entity (entity_t)
	Free an entity, recursively. More...
void	print_entity (FILE *, entity_t)
	Print an XML entity. More...
void	print_entity_format (entity_t, gpointer indentation)
	Print an XML entity to stdout, recursively printing its children. More...
int	try_read_entity_and_string (gnutls_session_t *, int, entity_t *, GString **)
	Try read an XML entity tree from the manager. More...
int	read_entity_and_string (gnutls_session_t *, entity_t *, GString **)
	Try read an XML entity tree from the manager. More...
int	read_entity_and_string_c (gvm_connection_t *, entity_t *, GString **)
	Try read an XML entity tree from the manager. More...
int	read_entity_and_text (gnutls_session_t *, entity_t *, char **)
	Read an XML entity tree from the manager. More...
int	read_entity_and_text_c (gvm_connection_t *, entity_t *, char **)
	Read an XML entity tree from the manager. More...
int	try_read_entity (gnutls_session_t *, int, entity_t *)
	Try read an XML entity tree from the manager. More...
int	try_read_entity_c (gvm_connection_t *, int, entity_t *)
	Try read an XML entity tree from the manager. More...
int	read_entity (gnutls_session_t *, entity_t *)
	Read an XML entity tree from the manager. More...
int	read_entity_s (int, entity_t *)
	Read an XML entity tree from the socket. More...
int	read_entity_c (gvm_connection_t *, entity_t *)
	Read an XML entity tree from the manager. More...
int	read_string (gnutls_session_t *, GString **)
	Read entity and text. Free the entity immediately. More...
int	read_string_c (gvm_connection_t *, GString **)
	Read entity and text. Free the entity immediately. More...
int	read_text_c (gvm_connection_t *, char **)
	Read text from the server. More...
int	parse_entity (const char *, entity_t *)
	Read an XML entity tree from a string. More...
void	print_entity_to_string (entity_t entity, GString *string)
	Print an XML entity tree to a GString, appending it if string is not. More...
int	xml_count_entities (entities_t)
	Count the number of entities. More...
void	xml_string_append (GString *, const char *,...)
	Append formatted escaped XML to a string. More...
int	find_element_in_xml_file (gchar *, gchar *, GHashTable *)
	Tests if an XML file contains an element with given attributes. More...
int	parse_element (const gchar *, element_t *)
	Read an XML element tree from a string. More...
void	element_free (element_t)
	Free an entire element tree. More...
const gchar *	element_name (element_t)
	Get the name of an element. More...
gchar *	element_attribute (element_t, const gchar *)
	Get an attribute of an element. More...
gchar *	element_text (element_t)
	Get text of an element. More...
element_t	element_child (element_t, const gchar *)
	Get a child of an element. More...
element_t	element_first_child (element_t)
	Get the first child of an element. More...
element_t	element_next (element_t)
	Get the next sibling of an element. More...
gchar *	element_to_string (element_t element)
	Output the XML element as a string. More...
void	print_element_to_string (element_t element, GString *string)
	Print an XML element tree to a GString, appending it if string is not. More...

Detailed Description

Headers for simple XML reader.

Definition in file xmlutils.h.

Typedef Documentation

element_t

typedef struct _xmlNode* element_t

Definition at line 157 of file xmlutils.h.

entities_t

typedef GSList* entities_t

Entities.

Definition at line 46 of file xmlutils.h.

entity_t

typedef struct entity_s* entity_t

Definition at line 58 of file xmlutils.h.

Function Documentation

add_entity()

entity_t add_entity	(	entities_t *	entities,
		const char *	name,
		const char *	text
	)

Add an XML entity to a tree of entities.

Parameters

[in]	entities	The tree of entities
[in]	name	Name of the entity. Copied, copy is freed by free_entity.
[in]	text	Text of the entity. Copied, copy is freed by free_entity.

Returns

The new entity.

Definition at line 101 of file xmlutils.c.

{
  entity_t entity = make_entity (name, text);
  if (entities)
    *entities = g_slist_append (*entities, entity);
  return entity;
}

References make_entity().

Referenced by handle_start_element().

Here is the call graph for this function:

Here is the caller graph for this function:

compare_entities()

int compare_entities	(	entity_t	entity1,
		entity_t	entity2
	)

Compare two XML entity.

Parameters

[in]	entity1	First entity.
[in]	entity2	First entity.

Returns

0 if equal, 1 otherwise.

Definition at line 1761 of file xmlutils.c.

{
  if (entity1 == NULL)
    return entity2 == NULL ? 0 : 1;
  if (entity2 == NULL)
    return 1;
 
  if (strcmp (entity1->name, entity2->name))
    {
      g_debug ("  compare failed name: %s vs %s\n", entity1->name,
               entity2->name);
      return 1;
    }
  if (strcmp (entity1->text, entity2->text))
    {
      g_debug ("  compare failed text %s vs %s (%s)\n", entity1->text,
               entity2->text, entity1->name);
      return 1;
    }
 
  if (entity1->attributes == NULL)
    {
      if (entity2->attributes)
        return 1;
    }
  else
    {
      if (entity2->attributes == NULL)
        return 1;
      if (g_hash_table_find (entity1->attributes, compare_find_attribute,
                             (gpointer) entity2->attributes))
        {
          g_debug ("  compare failed attributes\n");
          return 1;
        }
    }
 
  // FIX entities can be in any order
  GSList *list1 = entity1->entities;
  GSList *list2 = entity2->entities;
  while (list1 && list2)
    {
      if (compare_entities (list1->data, list2->data))
        {
          g_debug ("  compare failed subentity\n");
          return 1;
        }
      list1 = g_slist_next (list1);
      list2 = g_slist_next (list2);
    }
  if (list1 == list2)
    return 0;
  /* More entities in one of the two. */
  g_debug ("  compare failed number of entities (%s)\n", entity1->name);
  return 1;
}

References entity_s::attributes, compare_entities(), compare_find_attribute(), entity_s::entities, entity_s::name, and entity_s::text.

Referenced by compare_entities().

Here is the call graph for this function:

Here is the caller graph for this function:

element_attribute()

gchar* element_attribute	(	element_t	element,
		const gchar *	name
	)

Get an attribute of an element.

Parameters

[in]	element	Element.
[in]	name	Name of the attribute.

Returns

Attribute value if found, else NULL. Caller must g_free.

Definition at line 2158 of file xmlutils.c.

{
  const gchar *stripped_name;
 
  if (!element)
    return NULL;
 
  stripped_name = strchr (name, ':');
  if (stripped_name)
    {
      gchar *attribute;
 
      /* There was a namespace in the name.
       *
       * First try without the namespace, because libxml2 doesn't consider the
       * namespace in the name when the namespace is defined. */
 
      stripped_name++;
 
      if (*stripped_name == '\0')
        /* Don't search for child with empty stripped name, because we'll
         * find text nodes.  But search with just the namespace for glib
         * compatibility. */
        return (gchar *) xmlGetProp (element, (const xmlChar *) name);
 
      attribute =
        (gchar *) xmlGetProp (element, (const xmlChar *) stripped_name);
      if (attribute)
        return attribute;
 
      /* Didn't find anything. */
    }
 
  /* There was no namespace, or we didn't find anything without the namespace.
   *
   * Try with the full name. */
 
  return (gchar *) xmlGetProp (element, (const xmlChar *) name);
}

Referenced by Ensure().

Here is the caller graph for this function:

element_child()

element_t element_child	(	element_t	element,
		const gchar *	name
	)

Get a child of an element.

Parameters

[in]	element	Element.
[in]	name	Name of the child.

Returns

Element if found, else NULL.

Definition at line 2082 of file xmlutils.c.

{
  const gchar *stripped_name;
 
  if (!element)
    return NULL;
 
  stripped_name = strchr (name, ':');
  if (stripped_name)
    {
      element_t child;
 
      /* There was a namespace in the name.
       *
       * First try without the namespace, because libxml2 doesn't consider the
       * namespace in the name when the namespace is defined. */
 
      stripped_name++;
 
      if (*stripped_name == '\0')
        /* Don't search for child with empty stripped name, because we'll
         * find text nodes.  But search with just the namespace for glib
         * compatibility. */
        return find_child (element, name);
 
      child = find_child (element, stripped_name);
      if (child)
        return child;
 
      /* Didn't find anything. */
    }
 
  /* There was no namespace, or we didn't find anything without the namespace.
   *
   * Try with the full name. */
 
  return find_child (element, name);
}

References find_child().

Referenced by Ensure().

Here is the call graph for this function:

Here is the caller graph for this function:

element_first_child()

element_t element_first_child

(

element_t

element

)

Get the first child of an element.

Parameters

[in]

element

Element.

Returns

Child if there is one, else NULL.

Definition at line 2206 of file xmlutils.c.

{
  if (element)
    {
      element = element->children;
      while (element && (element->type != XML_ELEMENT_NODE))
        element = element->next;
      return element;
    }
  return NULL;
}

Referenced by Ensure(), and print_element_to_string().

Here is the caller graph for this function:

element_free()

void element_free

(

element_t

element

)

Free an entire element tree.

Beware that this frees the entire tree that element is part of, including any ancestors.

Parameters

[in]

element

Element.

Definition at line 2031 of file xmlutils.c.

{
  if (element)
    {
      assert (element->doc);
      xmlFreeDoc (element->doc);
    }
}

Referenced by Ensure().

Here is the caller graph for this function:

element_name()

const gchar* element_name

(

element_t

element

)

Get the name of an element.

Parameters

[in]

element

Element.

Returns

Element name.

Definition at line 2048 of file xmlutils.c.

{
  if (element && (element->type == XML_ELEMENT_NODE))
    return (const gchar *) element->name;
 
  return "";
}

Referenced by Ensure(), handle_end_element(), handle_start_element(), ignore_end_element(), ignore_start_element(), print_element_to_string(), xml_handle_end_element(), xml_handle_start_element(), and xml_search_handle_start_element().

Here is the caller graph for this function:

element_next()

element_t element_next

(

element_t

element

)

Get the next sibling of an element.

Parameters

[in]

element

Element.

Returns

Next sibling element if there is one, else NULL.

Definition at line 2226 of file xmlutils.c.

{
  if (element)
    {
      element = element->next;
      while (element && (element->type != XML_ELEMENT_NODE))
        element = element->next;
      return element;
    }
  return NULL;
}

Referenced by Ensure(), and print_element_to_string().

Here is the caller graph for this function:

element_text()

gchar* element_text

(

element_t

element

)

Get text of an element.

If element is not NULL then the return is guaranteed to be a string. So if the caller has NULL checked element then there is no need for the caller to NULL check the return.

Parameters

[in]

element

Element.

Returns

NULL if element is NULL, else the text. Caller must g_free.

Definition at line 2133 of file xmlutils.c.

{
  gchar *string;
 
  if (!element)
    return NULL;
 
  string =
    (gchar *) xmlNodeListGetString (element->doc, element->xmlChildrenNode, 1);
  if (string)
    return string;
  string = xmlMalloc (1);
  string[0] = '\0';
  return string;
}

Referenced by Ensure(), and print_element_to_string().

Here is the caller graph for this function:

element_to_string()

gchar* element_to_string

(

element_t

element

)

Output the XML element as a string.

The generated XML string will include namespace definitions from ancestor elements.

Parameters

[in]

element

The element to output as a string.

Returns

The newly allocated XML string.

Definition at line 2249 of file xmlutils.c.

{
  xmlBufferPtr buffer;
  char *xml_string;
 
  // Copy element to ensure XML namespaces are included
  element_t element_copy;
  element_copy = xmlCopyNode (element, 1);
 
  buffer = xmlBufferCreate ();
  xmlNodeDump (buffer, element_copy->doc, element_copy, 0, 0);
  xmlFreeNode (element_copy);
 
  xml_string = g_strdup ((char *) xmlBufferContent (buffer));
 
  xmlBufferFree (buffer);
  return xml_string;
}

entity_attribute()

const char* entity_attribute	(	entity_t	entity,
		const char *	name
	)

Get an attribute of an entity.

Parameters

[in]	entity	Entity.
[in]	name	Name of the attribute.

Returns

Attribute if found, else NULL.

Definition at line 216 of file xmlutils.c.

{
  if (!entity)
    return NULL;
 
  if (entity->attributes)
    return (const char *) g_hash_table_lookup (entity->attributes, name);
  return NULL;
}

References entity_s::attributes.

Referenced by check_response_c(), Ensure(), gmp_authenticate_info_ext(), gmp_authenticate_info_ext_c(), gmp_check_response(), gmp_get_report_ext(), gmp_get_tasks_ext(), gmp_ping(), gmp_ping_c(), gmp_read_create_response(), gmp_resume_task_report_c(), gmp_start_task_report_c(), osp_check_feed(), osp_delete_scan(), osp_get_performance_ext(), osp_get_scan_pop(), osp_get_scan_status_ext(), osp_get_scanner_details(), osp_get_vts_feed_info(), osp_get_vts_version(), osp_start_scan(), osp_start_scan_ext(), and osp_stop_scan().

Here is the caller graph for this function:

entity_child()

entity_t entity_child	(	entity_t	entity,
		const char *	name
	)

Get a child of an entity.

Parameters

[in]	entity	Entity.
[in]	name	Name of the child.

Returns

Entity if found, else NULL.

Definition at line 193 of file xmlutils.c.

{
  if (!entity)
    return NULL;
 
  if (entity->entities)
    {
      entities_t match =
        g_slist_find_custom (entity->entities, name, compare_entity_with_name);
      return match ? (entity_t) match->data : NULL;
    }
  return NULL;
}

References compare_entity_with_name(), and entity_s::entities.

Referenced by Ensure(), gmp_authenticate_info_ext(), gmp_authenticate_info_ext_c(), gmp_ping_c(), gmp_resume_task_report(), gmp_resume_task_report_c(), gmp_start_task_report(), gmp_start_task_report_c(), gmp_task_status(), osp_check_feed(), osp_get_scan_pop(), osp_get_scan_status_ext(), osp_get_scanner_details(), osp_get_version(), osp_get_vts_feed_info(), and osp_get_vts_version().

Here is the call graph for this function:

Here is the caller graph for this function:

entity_name()

char* entity_name

(

entity_t

entity

)

Get the name an entity.

Parameters

[in]

entity

Entity.

Returns

Entity name, which is freed by free_entity.

Definition at line 161 of file xmlutils.c.

{
  if (!entity)
    return NULL;
 
  return entity->name;
}

References entity_s::name.

Referenced by compare_entity_with_name(), and Ensure().

Here is the caller graph for this function:

entity_text()

char* entity_text

(

entity_t

entity

)

Get the text an entity.

Parameters

[in]

entity

Entity.

Returns

Entity text, which is freed by free_entity.

Definition at line 145 of file xmlutils.c.

{
  if (!entity)
    return NULL;
 
  return entity->text;
}

References entity_s::text.

Referenced by Ensure(), gmp_authenticate_info_ext(), gmp_authenticate_info_ext_c(), gmp_ping_c(), gmp_resume_task_report(), gmp_resume_task_report_c(), gmp_start_task_report(), gmp_start_task_report_c(), gmp_task_status(), osp_check_feed(), osp_get_performance_ext(), osp_get_scanner_details(), and osp_get_version().

Here is the caller graph for this function:

find_element_in_xml_file()

int find_element_in_xml_file	(	gchar *	file_path,
		gchar *	find_element,
		GHashTable *	find_attributes
	)

Tests if an XML file contains an element with given attributes.

Parameters

[in]	file_path	Path of the XML file.
[in]	find_element	Name of the element to find.
[in]	find_attributes	GHashTable of attributes to find.

Returns

1 if element was found, 0 if not.

Definition at line 1938 of file xmlutils.c.

{
  gchar buffer[XML_FILE_BUFFER_SIZE];
  FILE *file;
  int read_len;
  GMarkupParser xml_parser;
  GMarkupParseContext *xml_context;
  xml_search_data_t search_data;
  GError *error = NULL;
 
  search_data.find_element = find_element;
  search_data.find_attributes = find_attributes;
  search_data.found = 0;
 
  /* Create the XML parser. */
  xml_parser.start_element = xml_search_handle_start_element;
  xml_parser.end_element = NULL;
  xml_parser.text = NULL;
  xml_parser.passthrough = NULL;
  xml_parser.error = NULL;
  xml_context = g_markup_parse_context_new (&xml_parser, 0, &search_data, NULL);
 
  file = fopen (file_path, "r");
  if (file == NULL)
    {
      g_markup_parse_context_free (xml_context);
      g_warning ("%s: Failed to open '%s':", __func__, strerror (errno));
      return 0;
    }
 
  while ((read_len = fread (&buffer, sizeof (char), XML_FILE_BUFFER_SIZE, file))
         && g_markup_parse_context_parse (xml_context, buffer, read_len, &error)
         && error == NULL)
    {
    }
  g_markup_parse_context_end_parse (xml_context, &error);
 
  fclose (file);
 
  g_markup_parse_context_free (xml_context);
  return search_data.found;
}

References xml_search_data_t::find_attributes, xml_search_data_t::find_element, xml_search_data_t::found, XML_FILE_BUFFER_SIZE, and xml_search_handle_start_element().

Here is the call graph for this function:

first_entity()

entity_t first_entity

(

entities_t

entities

)

Return the first entity from an entities_t.

Parameters

[in]

entities

The list of entities.

Returns

The first entity.

Definition at line 82 of file xmlutils.c.

{
  if (entities)
    return (entity_t) entities->data;
  return NULL;
}

Referenced by Ensure(), and xml_count_entities().

Here is the caller graph for this function:

free_entity()

void free_entity

(

entity_t

entity

)

Free an entity, recursively.

Parameters

[in]

entity

The entity, can be NULL.

Definition at line 115 of file xmlutils.c.

{
  if (entity)
    {
      g_free (entity->name);
      g_free (entity->text);
      if (entity->attributes)
        g_hash_table_destroy (entity->attributes);
      if (entity->entities)
        {
          GSList *list = entity->entities;
          while (list)
            {
              free_entity (list->data);
              list = list->next;
            }
          g_slist_free (entity->entities);
        }
      g_free (entity);
    }
}

References entity_s::attributes, entity_s::entities, free_entity(), entity_s::name, and entity_s::text.

Referenced by check_response_c(), free_entity(), gmp_authenticate(), gmp_authenticate_info_ext(), gmp_authenticate_info_ext_c(), gmp_check_response(), gmp_delete_config_ext(), gmp_delete_lsc_credential_ext(), gmp_delete_port_list_ext(), gmp_delete_report(), gmp_delete_target_ext(), gmp_delete_task(), gmp_delete_task_ext(), gmp_get_report_ext(), gmp_get_tasks_ext(), gmp_modify_task_file(), gmp_ping(), gmp_ping_c(), gmp_read_create_response(), gmp_resume_task_report(), gmp_resume_task_report_c(), gmp_start_task_report(), gmp_start_task_report_c(), gmp_stop_task(), osp_check_feed(), osp_delete_scan(), osp_get_performance_ext(), osp_get_scan_pop(), osp_get_scan_status_ext(), osp_get_scanner_details(), osp_get_version(), osp_get_vts_feed_info(), osp_get_vts_version(), osp_start_scan(), osp_start_scan_ext(), osp_stop_scan(), parse_entity(), read_string(), try_read_entity_and_string(), and try_read_entity_and_string_s().

Here is the call graph for this function:

Here is the caller graph for this function:

next_entities()

entities_t next_entities

(

entities_t

entities

)

Return all the entities from an entities_t after the first.

Parameters

[in]

entities

The list of entities.

Returns

All the entities that follow the first.

Definition at line 67 of file xmlutils.c.

{
  if (entities)
    return (entities_t) entities->next;
  return NULL;
}

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

Here is the caller graph for this function:

parse_element()

int parse_element	(	const gchar *	string,
		element_t *	element
	)

Read an XML element tree from a string.

Caller must not free string until caller is finished using element.

Parameters

[in]	string	Input string.
[out]	element	Location for parsed element tree, or NULL if not required. If given, set to NULL on failure. Free with element_free.

Returns

0 success, -1 read error, -2 parse error, -3 XML ended prematurely, -4 setup error.

Definition at line 1999 of file xmlutils.c.

{
  xmlDocPtr doc;
 
  LIBXML_TEST_VERSION
 
  if (element)
    *element = NULL;
 
  if (xmlMemSetup (g_free, g_malloc, g_realloc, g_strdup))
    return -4;
 
  doc =
    xmlReadMemory (string, strlen (string), "noname.xml", NULL, XML_PARSE_HUGE);
  if (doc == NULL)
    return -2;
 
  if (element)
    *element = xmlDocGetRootElement (doc);
 
  return 0;
}

Referenced by Ensure().

Here is the caller graph for this function:

parse_entity()

int parse_entity	(	const char *	string,
		entity_t *	entity
	)

Read an XML entity tree from a string.

Parameters

[in]	string	Input string.
[out]	entity	Pointer to an entity tree.

Returns

0 success, -1 read error, -2 parse error, -3 XML ended prematurely.

Definition at line 1511 of file xmlutils.c.

{
  GMarkupParser xml_parser;
  GError *error = NULL;
  GMarkupParseContext *xml_context;
  context_data_t context_data;
 
  /* Create the XML parser. */
 
  xml_parser.start_element = handle_start_element;
  xml_parser.end_element = handle_end_element;
  xml_parser.text = handle_text;
  xml_parser.passthrough = NULL;
  xml_parser.error = handle_error;
 
  context_data.done = FALSE;
  context_data.first = NULL;
  context_data.current = NULL;
 
  /* Setup the XML context. */
 
  xml_context =
    g_markup_parse_context_new (&xml_parser, 0, &context_data, NULL);
 
  /* Parse the string. */
 
  g_markup_parse_context_parse (xml_context, string, strlen (string), &error);
  if (error)
    {
      g_error_free (error);
      if (context_data.first && context_data.first->data)
        {
          free_entity (context_data.first->data);
          g_slist_free_1 (context_data.first);
        }
      return -2;
    }
  if (context_data.done)
    {
      g_markup_parse_context_end_parse (xml_context, &error);
      if (error)
        {
          g_warning ("   End error: %s\n", error->message);
          g_error_free (error);
          if (context_data.first && context_data.first->data)
            {
              free_entity (context_data.first->data);
              g_slist_free_1 (context_data.first);
            }
          return -2;
        }
      *entity = (entity_t) context_data.first->data;
      g_slist_free_1 (context_data.first);
      return 0;
    }
  if (context_data.first && context_data.first->data)
    {
      free_entity (context_data.first->data);
      g_slist_free_1 (context_data.first);
    }
  return -3;
}

References context_data_t::current, context_data_t::done, context_data_t::first, free_entity(), handle_end_element(), handle_error(), handle_start_element(), and handle_text().

Referenced by Ensure().

Here is the call graph for this function:

Here is the caller graph for this function:

print_element_to_string()

void print_element_to_string	(	element_t	element,
		GString *	string
	)

Print an XML element tree to a GString, appending it if string is not.

empty.

Parameters

[in]	element	Element tree to print to string.
[in,out]	string	String to write to.

Definition at line 2276 of file xmlutils.c.

{
  gchar *text_escaped, *text;
  element_t ch;
  xmlAttr *attribute;
 
  text_escaped = NULL;
 
  g_string_append_printf (string, "<%s", element_name (element));
 
  attribute = element->properties;
  while (attribute)
    {
      xmlChar *value;
 
      value = xmlNodeListGetString (element->doc, attribute->children, 1);
 
      text_escaped = g_markup_escape_text ((gchar *) value, -1);
      g_string_append_printf (string, " %s=\"%s\"", attribute->name,
                              text_escaped);
      g_free (text_escaped);
 
      xmlFree (value);
 
      attribute = attribute->next;
    }
 
  g_string_append_printf (string, ">");
 
  text = element_text (element);
  text_escaped = g_markup_escape_text (text, -1);
  g_free (text);
  g_string_append_printf (string, "%s", text_escaped);
  g_free (text_escaped);
 
  ch = element_first_child (element);
  while (ch)
    {
      print_element_to_string (ch, string);
      ch = element_next (ch);
    }
 
  g_string_append_printf (string, "</%s>", element_name (element));
}

References element_first_child(), element_name(), element_next(), element_text(), and print_element_to_string().

Referenced by Ensure(), and print_element_to_string().

Here is the call graph for this function:

Here is the caller graph for this function:

print_entity()

void print_entity	(	FILE *	stream,
		entity_t	entity
	)

Print an XML entity.

Parameters

[in]	entity	The entity.
[in]	stream	The stream to which to print.

Definition at line 1659 of file xmlutils.c.

{
  gchar *text_escaped = NULL;
  fprintf (stream, "<%s", entity->name);
  if (entity->attributes && g_hash_table_size (entity->attributes))
    g_hash_table_foreach (entity->attributes, foreach_print_attribute, stream);
  fprintf (stream, ">");
  text_escaped = g_markup_escape_text (entity->text, -1);
  fprintf (stream, "%s", text_escaped);
  g_free (text_escaped);
  g_slist_foreach (entity->entities, foreach_print_entity, stream);
  fprintf (stream, "</%s>", entity->name);
  fflush (stream);
}

References entity_s::attributes, entity_s::entities, foreach_print_attribute(), foreach_print_entity(), entity_s::name, and entity_s::text.

Referenced by foreach_print_entity().

Here is the call graph for this function:

Here is the caller graph for this function:

print_entity_format()

void print_entity_format	(	entity_t	entity,
		gpointer	indent
	)

Print an XML entity to stdout, recursively printing its children.

Does very basic indentation for pretty printing.

This function is used as the (callback) GFunc in g_slist_foreach.

Parameters

[in]	entity	The entity.
[in]	indent	Indentation level, indentation width is 2 spaces. Use GINT_TO_POINTER to convert a integer value when passing this parameter.

Definition at line 1702 of file xmlutils.c.

{
  int i = 0;
  int indentation = GPOINTER_TO_INT (indent);
  gchar *text_escaped = NULL;
 
  for (i = 0; i < indentation; i++)
    printf ("  ");
 
  printf ("<%s", entity->name);
  if (entity->attributes && g_hash_table_size (entity->attributes))
    g_hash_table_foreach (entity->attributes, foreach_print_attribute_format,
                          indent);
  printf (">");
 
  text_escaped = g_markup_escape_text (entity->text, -1);
  printf ("%s", text_escaped);
  g_free (text_escaped);
 
  if (entity->entities)
    {
      printf ("\n");
      g_slist_foreach (entity->entities, (GFunc) print_entity_format,
                       GINT_TO_POINTER (indentation + 1));
      for (i = 0; i < indentation; i++)
        printf ("  ");
    }
 
  printf ("</%s>\n", entity->name);
}

References entity_s::attributes, entity_s::entities, foreach_print_attribute_format(), entity_s::name, print_entity_format(), and entity_s::text.

Referenced by print_entity_format().

Here is the call graph for this function:

Here is the caller graph for this function:

print_entity_to_string()

void print_entity_to_string	(	entity_t	entity,
		GString *	string
	)

Print an XML entity tree to a GString, appending it if string is not.

empty.

Parameters

[in]	entity	Entity tree to print to string.
[in,out]	string	String to write to.

Definition at line 1612 of file xmlutils.c.

{
  gchar *text_escaped = NULL;
  g_string_append_printf (string, "<%s", entity->name);
  if (entity->attributes && g_hash_table_size (entity->attributes))
    g_hash_table_foreach (entity->attributes, foreach_print_attribute_to_string,
                          string);
  g_string_append_printf (string, ">");
  text_escaped = g_markup_escape_text (entity->text, -1);
  g_string_append_printf (string, "%s", text_escaped);
  g_free (text_escaped);
  g_slist_foreach (entity->entities, foreach_print_entity_to_string, string);
  g_string_append_printf (string, "</%s>", entity->name);
}

References entity_s::attributes, entity_s::entities, foreach_print_attribute_to_string(), foreach_print_entity_to_string(), entity_s::name, and entity_s::text.

Referenced by foreach_print_entity_to_string(), and osp_get_scan_pop().

Here is the call graph for this function:

Here is the caller graph for this function:

read_entity()

int read_entity	(	gnutls_session_t *	session,
		entity_t *	entity
	)

Read an XML entity tree from the manager.

Parameters

[in]	session	Pointer to GNUTLS session.
[out]	entity	Pointer to an entity tree.

Returns

0 success, -1 read error, -2 parse error, -3 end of file.

Definition at line 1469 of file xmlutils.c.

{
  return try_read_entity (session, 0, entity);
}

References try_read_entity().

Referenced by gmp_check_response(), gmp_read_create_response(), and osp_send_command().

Here is the call graph for this function:

Here is the caller graph for this function:

read_entity_and_string()

int read_entity_and_string	(	gnutls_session_t *	session,
		entity_t *	entity,
		GString **	string_return
	)

Try read an XML entity tree from the manager.

Parameters

[in]	session	Pointer to GNUTLS session.
[out]	entity	Pointer to an entity tree.
[out]	string_return	An optional return location for the text read from the session. If NULL then it simply remains NULL. If a pointer to NULL then it points to a freshly allocated GString on successful return. Otherwise it points to an existing GString onto which the text is appended.

Returns

0 success, -1 read error, -2 parse error, -3 end of file.

Definition at line 1262 of file xmlutils.c.

{
  return try_read_entity_and_string (session, 0, entity, string_return);
}

References try_read_entity_and_string().

Referenced by read_entity_and_text(), and read_string().

Here is the call graph for this function:

Here is the caller graph for this function:

read_entity_and_string_c()

int read_entity_and_string_c	(	gvm_connection_t *	connection,
		entity_t *	entity,
		GString **	string_return
	)

Try read an XML entity tree from the manager.

Parameters

[in]	connection	Connection.
[out]	entity	Pointer to an entity tree.
[out]	string_return	An optional return location for the text read from the session. If NULL then it simply remains NULL. If a pointer to NULL then it points to a freshly allocated GString on successful return. Otherwise it points to an existing GString onto which the text is appended.

Returns

0 success, -1 read error, -2 parse error, -3 end of file.

Definition at line 1282 of file xmlutils.c.

{
  if (connection->tls)
    return try_read_entity_and_string (&connection->session, 0, entity,
                                       string_return);
  return try_read_entity_and_string_s (connection->socket, 0, entity,
                                       string_return);
}

References gvm_connection_t::session, gvm_connection_t::socket, gvm_connection_t::tls, try_read_entity_and_string(), and try_read_entity_and_string_s().

Referenced by read_entity_and_text_c(), and read_string_c().

Here is the call graph for this function:

Here is the caller graph for this function:

read_entity_and_text()

int read_entity_and_text	(	gnutls_session_t *	session,
		entity_t *	entity,
		char **	text
	)

Read an XML entity tree from the manager.

Parameters

[in]	session	Pointer to GNUTLS session.
[out]	entity	Pointer to an entity tree.
[out]	text	A pointer to a pointer, at which to store the address of a newly allocated string holding the text read from the session, if the text is required, else NULL.

Returns

0 success, -1 read error, -2 parse error, -3 end of file.

Definition at line 1305 of file xmlutils.c.

{
  if (text)
    {
      GString *string = NULL;
      int ret = read_entity_and_string (session, entity, &string);
      if (ret)
        {
          if (string)
            g_string_free (string, TRUE);
          return ret;
        }
      *text = g_string_free (string, FALSE);
      return 0;
    }
  return read_entity_and_string (session, entity, NULL);
}

References read_entity_and_string().

Here is the call graph for this function:

read_entity_and_text_c()

int read_entity_and_text_c	(	gvm_connection_t *	connection,
		entity_t *	entity,
		char **	text
	)

Read an XML entity tree from the manager.

Parameters

[in]	connection	Connection.
[out]	entity	Entity tree.
[out]	text	A pointer to a pointer, at which to store the address of a newly allocated string holding the text read from the session, if the text is required, else NULL.

Returns

0 success, -1 read error, -2 parse error, -3 end of file.

Definition at line 1336 of file xmlutils.c.

{
  if (text)
    {
      GString *string = NULL;
      int ret = read_entity_and_string_c (connection, entity, &string);
      if (ret)
        {
          if (string)
            g_string_free (string, TRUE);
          return ret;
        }
      *text = g_string_free (string, FALSE);
      return 0;
    }
  return read_entity_and_string_c (connection, entity, NULL);
}

References read_entity_and_string_c().

Here is the call graph for this function:

read_entity_c()

int read_entity_c	(	gvm_connection_t *	connection,
		entity_t *	entity
	)

Read an XML entity tree from the manager.

Parameters

[in]	connection	Connection.
[out]	entity	Pointer to an entity tree.

Returns

0 success, -1 read error, -2 parse error, -3 end of file.

Definition at line 1497 of file xmlutils.c.

{
  return try_read_entity_c (connection, 0, entity);
}

References try_read_entity_c().

Referenced by check_response_c(), gmp_resume_task_report_c(), and gmp_start_task_report_c().

Here is the call graph for this function:

Here is the caller graph for this function:

read_entity_s()

int read_entity_s	(	int	socket,
		entity_t *	entity
	)

Read an XML entity tree from the socket.

Parameters

[in]	socket	Socket to read from.
[out]	entity	Pointer to an entity tree.

Returns

0 success, -1 read error, -2 parse error, -3 end of file.

Definition at line 1483 of file xmlutils.c.

{
  return try_read_entity_and_string_s (socket, 0, entity, NULL);
}

References try_read_entity_and_string_s().

Referenced by osp_send_command().

Here is the call graph for this function:

Here is the caller graph for this function:

read_string()

int read_string	(	gnutls_session_t *	session,
		GString **	string
	)

Read entity and text. Free the entity immediately.

Parameters

[in]	session	Pointer to GNUTLS session to read from.
[out]	string	Return location for the string.

Returns

0 success, -1 read error, -2 parse error, -3 end of file.

Definition at line 1400 of file xmlutils.c.

{
  int ret = 0;
  entity_t entity;
 
  if (!(ret = read_entity_and_string (session, &entity, string)))
    free_entity (entity);
 
  return ret;
}

References free_entity(), and read_entity_and_string().

Here is the call graph for this function:

read_string_c()

int read_string_c	(	gvm_connection_t *	connection,
		GString **	string
	)

Read entity and text. Free the entity immediately.

Parameters

[in]	connection	Connection.
[out]	string	Return location for the string.

Returns

0 success, -1 read error, -2 parse error, -3 end of file.

Definition at line 1420 of file xmlutils.c.

{
  return read_entity_and_string_c (connection, NULL, string);
}

References read_entity_and_string_c().

Here is the call graph for this function:

read_text_c()

int read_text_c	(	gvm_connection_t *	connection,
		char **	text
	)

Read text from the server.

Parameters

[in]	connection	Connection.
[out]	text	A pointer to a pointer, at which to store the address of a newly allocated string holding the text read from the session.

Returns

0 success, -1 read error, -2 argument error.

Definition at line 1366 of file xmlutils.c.

{
  GString *string;
  int ret;
 
  if (text == NULL)
    return -2;
 
  string = NULL;
 
  if (connection->tls)
    ret = try_read_string (&connection->session, 0, &string);
  else
    ret = try_read_string_s (connection->socket, 0, &string);
 
  if (ret)
    {
      if (string)
        g_string_free (string, TRUE);
      return ret;
    }
  *text = g_string_free (string, FALSE);
  return 0;
}

References gvm_connection_t::session, gvm_connection_t::socket, gvm_connection_t::tls, try_read_string(), and try_read_string_s().

Referenced by osp_send_command_str().

Here is the call graph for this function:

Here is the caller graph for this function:

try_read_entity()

int try_read_entity	(	gnutls_session_t *	session,
		int	timeout,
		entity_t *	entity
	)

Try read an XML entity tree from the manager.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	timeout	Server idle time before giving up, in seconds. 0 to wait forever.
[out]	entity	Pointer to an entity tree.

Returns

0 success, -1 read error, -2 parse error, -3 end of file, -4 timeout.

Definition at line 1436 of file xmlutils.c.

{
  return try_read_entity_and_string (session, timeout, entity, NULL);
}

References try_read_entity_and_string().

Referenced by gmp_authenticate_info_ext(), gmp_get_report_ext(), gmp_get_tasks_ext(), gmp_ping(), and read_entity().

Here is the call graph for this function:

Here is the caller graph for this function:

try_read_entity_and_string()

int try_read_entity_and_string	(	gnutls_session_t *	session,
		int	timeout,
		entity_t *	entity,
		GString **	string_return
	)

Try read an XML entity tree from the manager.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	timeout	Server idle time before giving up, in seconds. 0 to wait forever.
[out]	entity	Pointer to an entity tree.
[out]	string_return	An optional return location for the text read from the session. If NULL then it simply remains NULL. If a pointer to NULL then it points to a freshly allocated GString on successful return. Otherwise it points to an existing GString onto which the text is appended.

Returns

0 success, -1 read error, -2 parse error, -3 end of file, -4 timeout, -5 null buffer.

Definition at line 501 of file xmlutils.c.

{
  GMarkupParser xml_parser;
  GError *error = NULL;
  GMarkupParseContext *xml_context;
  GString *string;
  int socket;
  time_t last_time;
 
  // Buffer for reading from the manager.
  char *buffer;
 
  /* Record the start time. */
 
  if (time (&last_time) == -1)
    {
      g_warning ("   failed to get current time: %s\n", strerror (errno));
      return -1;
    }
 
  if (timeout > 0)
    {
      /* Turn off blocking. */
 
      socket = GPOINTER_TO_INT (gnutls_transport_get_ptr (*session));
      if (fcntl (socket, F_SETFL, O_NONBLOCK) == -1)
        return -1;
    }
  else
    /* Quiet compiler. */
    socket = 0;
 
  buffer = g_malloc0 (BUFFER_SIZE);
  if (!buffer)
    return -5;
 
  /* Setup return arg. */
 
  if (string_return == NULL)
    string = NULL;
  else if (*string_return == NULL)
    string = g_string_new ("");
  else
    string = *string_return;
 
  /* Create the XML parser. */
 
  if (entity)
    {
      xml_parser.start_element = handle_start_element;
      xml_parser.end_element = handle_end_element;
      xml_parser.text = handle_text;
    }
  else
    {
      xml_parser.start_element = ignore_start_element;
      xml_parser.end_element = ignore_end_element;
      xml_parser.text = ignore_text;
    }
  xml_parser.passthrough = NULL;
  xml_parser.error = handle_error;
 
  context_data_t context_data;
  context_data.done = FALSE;
  context_data.first = NULL;
  context_data.current = NULL;
 
  /* Setup the XML context. */
 
  xml_context =
    g_markup_parse_context_new (&xml_parser, 0, &context_data, NULL);
 
  /* Read and parse, until encountering end of file or error. */
 
  while (1)
    {
      ssize_t count;
      int retries = 10;
      while (1)
        {
          g_debug ("   asking for %i\n", BUFFER_SIZE);
          count = gnutls_record_recv (*session, buffer, BUFFER_SIZE);
          if (count < 0)
            {
              if (count == GNUTLS_E_INTERRUPTED)
                /* Interrupted, try read again. */
                continue;
              if ((timeout > 0) && (count == GNUTLS_E_AGAIN))
                {
                  /* Server still busy, either timeout or try read again. */
                  if ((timeout - (time (NULL) - last_time)) <= 0)
                    {
                      g_warning ("   timeout\n");
                      if (fcntl (socket, F_SETFL, 0L) < 0)
                        g_warning ("%s :failed to set socket flag: %s",
                                   __func__, strerror (errno));
                      g_markup_parse_context_free (xml_context);
                      g_free (buffer);
                      return -4;
                    }
                  continue;
                }
              else if ((timeout == 0) && (count == GNUTLS_E_AGAIN))
                {
                  /* Server still busy, try read again.
                     If there is no timeout set and the server is still not
                     ready, it will try up to 10 times before closing the
                     socket.*/
                  if (retries > 0)
                    {
                      retries = retries - 1;
                      continue;
                    }
                }
 
              if (count == GNUTLS_E_REHANDSHAKE)
                /* Try again. TODO Rehandshake. */
                continue;
              if (context_data.first && context_data.first->data)
                {
                  free_entity (context_data.first->data);
                  g_slist_free_1 (context_data.first);
                }
              if (string && *string_return == NULL)
                g_string_free (string, TRUE);
              if (timeout > 0)
                {
                  if (fcntl (socket, F_SETFL, 0L) < 0)
                    g_warning ("%s :failed to set socket flag: %s", __func__,
                               strerror (errno));
                }
              g_markup_parse_context_free (xml_context);
              g_free (buffer);
              return -1;
            }
          if (count == 0)
            {
              /* End of file. */
              g_markup_parse_context_end_parse (xml_context, &error);
              if (error)
                {
                  g_warning ("   End error: %s\n", error->message);
                  g_error_free (error);
                }
              if (context_data.first && context_data.first->data)
                {
                  free_entity (context_data.first->data);
                  g_slist_free_1 (context_data.first);
                }
              if (string && *string_return == NULL)
                g_string_free (string, TRUE);
              if (timeout > 0)
                {
                  if (fcntl (socket, F_SETFL, 0L) < 0)
                    g_warning ("%s :failed to set socket flag: %s", __func__,
                               strerror (errno));
                }
              g_markup_parse_context_free (xml_context);
              g_free (buffer);
              return -3;
            }
          break;
        }
 
      g_debug ("<= %.*s\n", (int) count, buffer);
 
      if (string)
        g_string_append_len (string, buffer, count);
 
      g_markup_parse_context_parse (xml_context, buffer, count, &error);
      if (error)
        {
          g_error_free (error);
          if (context_data.first && context_data.first->data)
            {
              free_entity (context_data.first->data);
              g_slist_free_1 (context_data.first);
            }
          if (string && *string_return == NULL)
            g_string_free (string, TRUE);
          if (timeout > 0)
            {
              if (fcntl (socket, F_SETFL, 0L) < 0)
                g_warning ("%s :failed to set socket flag: %s", __func__,
                           strerror (errno));
            }
          g_markup_parse_context_free (xml_context);
          g_free (buffer);
          return -2;
        }
      if (context_data.done)
        {
          g_markup_parse_context_end_parse (xml_context, &error);
          if (error)
            {
              g_warning ("   End error: %s\n", error->message);
              g_error_free (error);
              if (context_data.first && context_data.first->data)
                {
                  free_entity (context_data.first->data);
                  g_slist_free_1 (context_data.first);
                }
              if (timeout > 0)
                fcntl (socket, F_SETFL, 0L);
              g_markup_parse_context_free (xml_context);
              g_free (buffer);
              return -2;
            }
          if (entity)
            *entity = (entity_t) context_data.first->data;
          if (string)
            *string_return = string;
          if (timeout > 0)
            fcntl (socket, F_SETFL, 0L);
          g_markup_parse_context_free (xml_context);
          g_free (buffer);
          return 0;
        }
 
      if ((timeout > 0) && (time (&last_time) == -1))
        {
          g_warning ("   failed to get current time (1): %s\n",
                     strerror (errno));
          if (fcntl (socket, F_SETFL, 0L) < 0)
            g_warning ("%s :failed to set socket flag: %s", __func__,
                       strerror (errno));
          g_markup_parse_context_free (xml_context);
          g_free (buffer);
          return -1;
        }
    }
}

References BUFFER_SIZE, context_data_t::current, context_data_t::done, context_data_t::first, free_entity(), handle_end_element(), handle_error(), handle_start_element(), handle_text(), ignore_end_element(), ignore_start_element(), and ignore_text().

Referenced by read_entity_and_string(), read_entity_and_string_c(), try_read_entity(), and try_read_entity_c().

Here is the call graph for this function:

Here is the caller graph for this function:

try_read_entity_c()

int try_read_entity_c	(	gvm_connection_t *	connection,
		int	timeout,
		entity_t *	entity
	)

Try read an XML entity tree from the manager.

Parameters

[in]	connection	Connection.
[in]	timeout	Server idle time before giving up, in seconds. 0 to wait forever.
[out]	entity	Pointer to an entity tree.

Returns

0 success, -1 read error, -2 parse error, -3 end of file, -4 timeout.

Definition at line 1452 of file xmlutils.c.

{
  if (connection->tls)
    return try_read_entity_and_string (&connection->session, 0, entity, NULL);
  return try_read_entity_and_string_s (connection->socket, timeout, entity,
                                       NULL);
}

References gvm_connection_t::session, gvm_connection_t::socket, gvm_connection_t::tls, try_read_entity_and_string(), and try_read_entity_and_string_s().

Referenced by gmp_authenticate_info_ext_c(), gmp_ping_c(), and read_entity_c().

Here is the call graph for this function:

Here is the caller graph for this function:

xml_count_entities()

int xml_count_entities

(

entities_t

entities

)

Count the number of entities.

Parameters

[in]

entities

Entities.

Returns

Number of entities.

Definition at line 1826 of file xmlutils.c.

{
  int count = 0;
  while (first_entity (entities))
    {
      entities = next_entities (entities);
      count++;
    }
  return count;
}

References first_entity(), and next_entities().

Here is the call graph for this function:

xml_handle_end_element()

void xml_handle_end_element	(	context_data_t *	context,
		const gchar *	element_name
	)

Handle the end of an XML element.

Parameters

[in]	context	Parser context.
[in]	element_name	XML element name.

Definition at line 402 of file xmlutils.c.

{
  handle_end_element (NULL, element_name, context, NULL);
}

References element_name(), and handle_end_element().

Here is the call graph for this function:

xml_handle_start_element()

void xml_handle_start_element	(	context_data_t *	context,
		const gchar *	element_name,
		const gchar **	attribute_names,
		const gchar **	attribute_values
	)

Handle the start of an OMP XML element.

Parameters

[in]	context	Parser context.
[in]	element_name	XML element name.
[in]	attribute_names	XML attribute name.
[in]	attribute_values	XML attribute values.

Definition at line 326 of file xmlutils.c.

{
  handle_start_element (NULL, element_name, attribute_names, attribute_values,
                        context, NULL);
}

References element_name(), and handle_start_element().

Here is the call graph for this function:

xml_handle_text()

void xml_handle_text	(	context_data_t *	context,
		const gchar *	text,
		gsize	text_len
	)

Handle additional text of an XML element.

Parameters

[in]	context	Parser context.
[in]	text	The text.
[in]	text_len	Length of the text.

Definition at line 464 of file xmlutils.c.

{
  handle_text (NULL, text, text_len, context, NULL);
}

References handle_text().

Here is the call graph for this function:

xml_string_append()

void xml_string_append	(	GString *	xml,
		const char *	format,
			...
	)

Append formatted escaped XML to a string.

Parameters

[in]	xml	XML string.
[in]	format	Format string.
[in]	...	Arguments for format string.

Definition at line 1845 of file xmlutils.c.

{
  gchar *piece;
  va_list args;
 
  va_start (args, format);
  piece = g_markup_vprintf_escaped (format, args);
  va_end (args);
  g_string_append (xml, piece);
  g_free (piece);
}

Referenced by credential_append_as_xml(), gmp_get_system_reports_ext(), osp_start_scan_ext(), target_append_as_xml(), vt_group_append_as_xml(), vt_single_append_as_xml(), and vt_value_append_as_xml().

Here is the caller graph for this function: