xmlutils.c File Reference

Simple XML reader. More...

#include "xmlutils.h"
#include <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <glib.h>
#include <glib/gtypes.h>
#include <libxml/parser.h>
#include <libxml/tree.h>
#include <string.h>
#include <time.h>
#include <unistd.h>

Include dependency graph for xmlutils.c:

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

Go to the source code of this file.

Data Structures
struct	xml_file_iterator_struct
	Opaque data structure for XML file iterator. More...

Macros
#define	G_LOG_DOMAIN   "libgvm util"
	GLib logging domain.
#define	BUFFER_SIZE   1048576
	Size of the buffer for reading from the manager.
#define	XML_FILE_BUFFER_SIZE   1048576
#define	XML_FILE_ITERATOR_BUFFER_SIZE   8192
	File read buffer size for an XML file iterator.

Functions
static entity_t	make_entity (const char *name, const char *text)
	Create an entity.
entities_t	next_entities (entities_t entities)
	Return all the entities from an entities_t after the first.
entity_t	first_entity (entities_t entities)
	Return the first entity from an entities_t.
entity_t	add_entity (entities_t *entities, const char *name, const char *text)
	Add an XML entity to a tree of entities.
void	free_entity (entity_t entity)
	Free an entity, recursively.
char *	entity_text (entity_t entity)
	Get the text an entity.
char *	entity_name (entity_t entity)
	Get the name an entity.
static int	compare_entity_with_name (gconstpointer entity, gconstpointer name)
	Compare a given name with the name of a given entity.
entity_t	entity_child (entity_t entity, const char *name)
	Get a child of an entity.
const char *	entity_attribute (entity_t entity, const char *name)
	Get an attribute of an entity.
static void	add_attributes (entity_t entity, const gchar **names, const gchar **values)
	Add attributes from an XML callback to an entity.
static void	ignore_start_element (GMarkupParseContext *context, const gchar *element_name, const gchar **attribute_names, const gchar **attribute_values, gpointer user_data, GError **error)
	Handle the start of an OMP XML element.
static void	handle_start_element (GMarkupParseContext *context, const gchar *element_name, const gchar **attribute_names, const gchar **attribute_values, gpointer user_data, GError **error)
	Handle the start of an OMP XML 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.
static void	ignore_end_element (GMarkupParseContext *context, const gchar *element_name, gpointer user_data, GError **error)
	Handle the end of an XML element.
static void	handle_end_element (GMarkupParseContext *context, const gchar *element_name, gpointer user_data, GError **error)
	Handle the end of an XML element.
void	xml_handle_end_element (context_data_t *context, const gchar *element_name)
	Handle the end of an XML element.
static void	ignore_text (GMarkupParseContext *context, const gchar *text, gsize text_len, gpointer user_data, GError **error)
	Handle additional text of an XML element.
static void	handle_text (GMarkupParseContext *context, const gchar *text, gsize text_len, gpointer user_data, GError **error)
	Handle additional text of an XML element.
void	xml_handle_text (context_data_t *context, const gchar *text, gsize text_len)
	Handle additional text of an XML element.
static void	handle_error (GMarkupParseContext *context, GError *error, gpointer user_data)
	Handle an OMP XML parsing error.
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.
static int	try_read_string (gnutls_session_t *session, int timeout, GString **string_return)
	Try read a response from a TLS session.
static int	try_read_string_s (int socket, int timeout, GString **string_return)
	Try read an XML entity tree from the socket.
static int	try_read_entity_and_string_s (int socket, int timeout, entity_t *entity, GString **string_return)
	Try read an XML entity tree from the socket.
int	read_entity_and_string (gnutls_session_t *session, entity_t *entity, GString **string_return)
	Try read an XML entity tree from the manager.
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.
int	read_entity_and_text (gnutls_session_t *session, entity_t *entity, char **text)
	Read an XML entity tree from the manager.
int	read_entity_and_text_c (gvm_connection_t *connection, entity_t *entity, char **text)
	Read an XML entity tree from the manager.
int	read_text_c (gvm_connection_t *connection, char **text)
	Read text from the server.
int	read_string (gnutls_session_t *session, GString **string)
	Read entity and text. Free the entity immediately.
int	read_string_c (gvm_connection_t *connection, GString **string)
	Read entity and text. Free the entity immediately.
int	try_read_entity (gnutls_session_t *session, int timeout, entity_t *entity)
	Try read an XML entity tree from the manager.
int	try_read_entity_c (gvm_connection_t *connection, int timeout, entity_t *entity)
	Try read an XML entity tree from the manager.
int	read_entity (gnutls_session_t *session, entity_t *entity)
	Read an XML entity tree from the manager.
int	read_entity_s (int socket, entity_t *entity)
	Read an XML entity tree from the socket.
int	read_entity_c (gvm_connection_t *connection, entity_t *entity)
	Read an XML entity tree from the manager.
int	parse_entity (const char *string, entity_t *entity)
	Read an XML entity tree from a string.
static void	foreach_print_entity_to_string (gpointer entity, gpointer string)
	Print an XML entity for g_slist_foreach to a GString.
static void	foreach_print_attribute_to_string (gpointer name, gpointer value, gpointer string)
	Print an XML attribute for g_hash_table_foreach to a GString.
void	print_entity_to_string (entity_t entity, GString *string)
	Print an XML entity tree to a GString, appending it if string is not.
static void	foreach_print_entity (gpointer entity, gpointer stream)
	Print an XML entity for g_slist_foreach.
static void	foreach_print_attribute (gpointer name, gpointer value, gpointer stream)
	Print an XML attribute for g_hash_table_foreach.
void	print_entity (FILE *stream, entity_t entity)
	Print an XML entity.
static void	foreach_print_attribute_format (gpointer name, gpointer value, gpointer none)
	Print an XML attribute for g_hash_table_foreach to stdout.
void	print_entity_format (entity_t entity, gpointer indent)
	Print an XML entity to stdout, recursively printing its children.
static gboolean	compare_find_attribute (gpointer key, gpointer value, gpointer attributes2)
	Look for a key-value pair in a hash table.
int	compare_entities (entity_t entity1, entity_t entity2)
	Compare two XML entity.
int	xml_count_entities (entities_t entities)
	Count the number of entities.
void	xml_string_append (GString *xml, const char *format,...)
	Append formatted escaped XML to a string.
static void	xml_search_handle_start_element (GMarkupParseContext *ctx, const gchar *element_name, const gchar **attribute_names, const gchar **attribute_values, gpointer data, GError **error)
	Handle the opening tag of an element in an XML search.
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.
int	parse_element (const gchar *string, element_t *element)
	Read an XML element tree from a string.
void	element_free (element_t element)
	Free an entire element tree.
const gchar *	element_name (element_t element)
	Get the name of an element.
static element_t	find_child (element_t element, const gchar *name)
	Find child in an element.
element_t	element_child (element_t element, const gchar *name)
	Get a child of an element.
gchar *	element_text (element_t element)
	Get text of an element.
gchar *	element_attribute (element_t element, const gchar *name)
	Get an attribute of an element.
element_t	element_first_child (element_t element)
	Get the first child of an element.
element_t	element_next (element_t element)
	Get the next sibling of an element.
gchar *	element_to_string (element_t element)
	Output the XML element as a 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.
static void	xml_file_iterator_start_element_ns (void *ctx, const xmlChar *localname, const xmlChar *prefix, const xmlChar *URI, int nb_namespaces, const xmlChar **namespaces, int nb_attributes, int nb_defaulted, const xmlChar **attributes)
	XML file iterator parser callback for element start.
static void	xml_file_iterator_end_element_ns (void *ctx, const xmlChar *localname, const xmlChar *prefix, const xmlChar *URI)
	XML file iterator parser callback for element end.
static void	xml_file_iterator_internal_subset (void *ctx, const xmlChar *name, const xmlChar *ExternalID, const xmlChar *SystemID)
	XML file iterator parser callback for internal subset declaration.
static void	xml_file_iterator_external_subset (void *ctx, const xmlChar *name, const xmlChar *ExternalID, const xmlChar *SystemID)
	XML file iterator parser callback for external subset declaration.
static int	xml_file_iterator_is_standalone (void *ctx)
	XML file iterator parser callback for checking if doc is standalone.
static int	xml_file_iterator_has_internal_subset (void *ctx)
	XML file iterator parser callback for checking if doc has an internal subset.
static int	xml_file_iterator_has_external_subset (void *ctx)
	XML file iterator parser callback for checking if doc has an external subset.
static xmlParserInputPtr	xml_file_iterator_resolve_entity (void *ctx, const xmlChar *publicId, const xmlChar *systemId)
	XML file iterator parser callback for resolving an entity.
static xmlEntityPtr	xml_file_iterator_get_entity (void *ctx, const xmlChar *name)
	XML file iterator parser callback for getting an entity by name.
static xmlEntityPtr	xml_file_iterator_get_parameter_entity (void *ctx, const xmlChar *name)
	XML file iterator parser callback for getting a parameter entity by name.
static void	xml_file_iterator_entity_decl (void *ctx, const xmlChar *name, int type, const xmlChar *publicId, const xmlChar *systemId, xmlChar *content)
	XML file iterator parser callback for when an entity definition has been parsed.
static void	xml_file_iterator_attribute_decl (void *ctx, const xmlChar *elem, const xmlChar *fullname, int type, int def, const xmlChar *defaultValue, xmlEnumerationPtr tree)
	XML file iterator parser callback for when an attribute definition has been parsed.
static void	xml_file_iterator_element_decl (void *ctx, const xmlChar *name, int type, xmlElementContentPtr content)
	XML file iterator parser callback for when an element definition has been parsed.
static void	xml_file_iterator_notation_decl (void *ctx, const xmlChar *name, const xmlChar *publicId, const xmlChar *systemId)
	XML file iterator parser callback for when a notation definition has been parsed.
static void	xml_file_iterator_unparsed_entity_decl (void *ctx, const xmlChar *name, const xmlChar *publicId, const xmlChar *systemId, const xmlChar *notationName)
	XML file iterator parser callback for when an unparsed entity declaration has been parsed.
static void	xml_file_iterator_set_document_locator (void *ctx, xmlSAXLocatorPtr loc)
	XML file iterator parser callback for setting the document locator.
static void	xml_file_iterator_start_document (void *ctx)
	XML file iterator parser callback at the document start.
static void	xml_file_iterator_end_document (void *ctx)
	XML file iterator parser callback at the document end.
static void	xml_file_iterator_characters (void *ctx, const xmlChar *ch, int len)
	XML file iterator parser callback when receiving some chars from the parser.
static void	xml_file_iterator_cdata_block (void *ctx, const xmlChar *ch, int len)
	XML file iterator parser callback when a cdata block has been parsed.
static void	xml_file_iterator_processing_instruction (void *ctx, const xmlChar *target, const xmlChar *data)
	XML file iterator parser callback when a processing instruction has been parsed.
static void	xml_file_iterator_comment (void *ctx, const xmlChar *value)
	XML file iterator parser callback when a comment has been parsed.
static void	xml_file_iterator_init_sax_handler (xmlSAXHandlerPtr hdlr)
	Initializes a xmlSAXHandler data structure for SAX version 2 parsing, assigning all the XML file iterator callback functions.
xml_file_iterator_t	xml_file_iterator_new (void)
	Allocates a new, uninitialized XML file iterator.
int	xml_file_iterator_init_from_file_path (xml_file_iterator_t iterator, const char *file_path, int output_depth)
	Initializes an XML file iterator to read from a given path.
void	xml_file_iterator_free (xml_file_iterator_t iterator)
	Frees an XML file iterator and all of its internal data structures.
int	xml_file_iterator_rewind (xml_file_iterator_t iterator)
	Rewinds an XML file iterator by rewinding the file and creating a new XML parser context.
element_t	xml_file_iterator_next (xml_file_iterator_t iterator, gchar **error)
	Get the next subelement from a XML file iterator.

Detailed Description

Simple XML reader.

This is a generic XML interface. The key function is read_entity.

There are examples of using this interface in omp.c.

Definition in file xmlutils.c.

Macro Definition Documentation

BUFFER_SIZE

#define BUFFER_SIZE   1048576

Size of the buffer for reading from the manager.

Definition at line 37 of file xmlutils.c.

Referenced by try_read_entity_and_string(), try_read_entity_and_string_s(), try_read_string(), and try_read_string_s().

G_LOG_DOMAIN

#define G_LOG_DOMAIN   "libgvm util"

GLib logging domain.

Definition at line 32 of file xmlutils.c.

XML_FILE_BUFFER_SIZE

#define XML_FILE_BUFFER_SIZE   1048576

Definition at line 1931 of file xmlutils.c.

Referenced by find_element_in_xml_file().

XML_FILE_ITERATOR_BUFFER_SIZE

#define XML_FILE_ITERATOR_BUFFER_SIZE   8192

File read buffer size for an XML file iterator.

Definition at line 2990 of file xmlutils.c.

Referenced by xml_file_iterator_next().

Function Documentation

add_attributes()

void add_attributes ( entity_t entity, const gchar ** names, const gchar ** values )

static

Add attributes from an XML callback to an entity.

Parameters

[in]	entity	The entity.
[in]	names	List of attribute names.
[in]	values	List of attribute values.

Definition at line 234 of file xmlutils.c.

{
  if (names && values && *names && *values)
    {
      if (entity->attributes == NULL)
        entity->attributes =
          g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
      while (*names && *values)
        {
          if (*values)
            g_hash_table_insert (entity->attributes, g_strdup (*names),
                                 g_strdup (*values));
          names++;
          values++;
        }
    }
}

References entity_s::attributes.

Referenced by handle_start_element().

Here is the caller graph for this function:

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 1765 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:

compare_entity_with_name()

int compare_entity_with_name ( gconstpointer entity, gconstpointer name )

static

Compare a given name with the name of a given entity.

Parameters

[in]	entity	Entity.
[in]	name	Name.

Returns

Zero if entity name matches name, otherwise a positive or negative number as from strcmp.

Definition at line 179 of file xmlutils.c.

{
  return strcmp (entity_name ((entity_t) entity), (char *) name);
}

References entity_name().

Referenced by entity_child().

Here is the call graph for this function:

Here is the caller graph for this function:

compare_find_attribute()

gboolean compare_find_attribute ( gpointer key, gpointer value, gpointer attributes2 )

static

Look for a key-value pair in a hash table.

Parameters

[in]	key	Key.
[in]	value	Value.
[in]	attributes2	The hash table.

Returns

FALSE if found, TRUE otherwise.

Definition at line 1747 of file xmlutils.c.

{
  gchar *value2 = g_hash_table_lookup (attributes2, key);
  if (value2 && strcmp (value, value2) == 0)
    return FALSE;
  g_debug ("  compare failed attribute: %s\n", (char *) value);
  return TRUE;
}

Referenced by compare_entities().

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 2162 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(), Ensure(), and 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 2086 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(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), and 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 2210 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 2035 of file xmlutils.c.

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

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

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 2052 of file xmlutils.c.

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

Referenced by Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), 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 2230 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 2137 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(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), 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 2253 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(), Ensure(), Ensure(), Ensure(), 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(), Ensure(), Ensure(), Ensure(), Ensure(), 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(), Ensure(), Ensure(), Ensure(), 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_child()

element_t find_child ( element_t element, const gchar * name )

static

Find child in an element.

Parameters

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

Returns

Child if found, else NULL.

Definition at line 2069 of file xmlutils.c.

{
  for (xmlNode *node = element->children; node; node = node->next)
    if (xmlStrcmp (node->name, (const xmlChar *) name) == 0)
      return node;
  return NULL;
}

Referenced by element_child().

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 1942 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:

foreach_print_attribute()

void foreach_print_attribute ( gpointer name, gpointer value, gpointer stream )

static

Print an XML attribute for g_hash_table_foreach.

Parameters

[in]	name	The attribute name.
[in]	value	The attribute value.
[in]	stream	The stream to which to print.

Definition at line 1651 of file xmlutils.c.

{
  fprintf ((FILE *) stream, " %s=\"%s\"", (char *) name, (char *) value);
}

Referenced by print_entity().

Here is the caller graph for this function:

foreach_print_attribute_format()

void foreach_print_attribute_format ( gpointer name, gpointer value, gpointer none )

static

Print an XML attribute for g_hash_table_foreach to stdout.

Parameters

[in]	name	The attribute name.
[in]	value	The attribute value.
[in]	none	(ignored).

Definition at line 1688 of file xmlutils.c.

{
  (void) none;
  printf (" %s=\"%s\"", (char *) name, (char *) value);
}

Referenced by print_entity_format().

Here is the caller graph for this function:

foreach_print_attribute_to_string()

void foreach_print_attribute_to_string ( gpointer name, gpointer value, gpointer string )

static

Print an XML attribute for g_hash_table_foreach to a GString.

Parameters

[in]	name	The attribute name.
[in]	value	The attribute value.
[in]	string	The string to which to print.

Definition at line 1598 of file xmlutils.c.

{
  gchar *text_escaped;
  text_escaped = g_markup_escape_text ((gchar *) value, -1);
  g_string_append_printf ((GString *) string, " %s=\"%s\"", (char *) name,
                          text_escaped);
  g_free (text_escaped);
}

Referenced by print_entity_to_string().

Here is the caller graph for this function:

foreach_print_entity()

void foreach_print_entity ( gpointer entity, gpointer stream )

static

Print an XML entity for g_slist_foreach.

Parameters

[in]	entity	The entity, as a gpointer.
[in]	stream	The stream to which to print, as a gpointer.

Definition at line 1638 of file xmlutils.c.

{
  print_entity ((FILE *) stream, (entity_t) entity);
}

References print_entity().

Referenced by print_entity().

Here is the call graph for this function:

Here is the caller graph for this function:

foreach_print_entity_to_string()

void foreach_print_entity_to_string ( gpointer entity, gpointer string )

static

Print an XML entity for g_slist_foreach to a GString.

Parameters

[in]	entity	The entity, as a gpointer.
[in]	string	The stream to which to print, as a gpointer.

Definition at line 1585 of file xmlutils.c.

{
  print_entity_to_string ((entity_t) entity, (GString *) string);
}

References print_entity_to_string().

Referenced by print_entity_to_string().

Here is the call graph for this function:

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(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), 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:

handle_end_element()

void handle_end_element ( GMarkupParseContext * context, const gchar * element_name, gpointer user_data, GError ** error )

static

Handle the end of an XML element.

Parameters

[in]	context	Parser context.
[in]	element_name	XML element name.
[in]	user_data	Dummy parameter.
[in]	error	Error parameter.

Definition at line 366 of file xmlutils.c.

{
  context_data_t *data = (context_data_t *) user_data;
 
  (void) context;
  (void) error;
  (void) element_name;
  assert (data->current && data->first);
  if (data->current == data->first)
    {
      assert (strcmp (element_name,
                      /* The name of the very first entity. */
                      ((entity_t) (data->first->data))->name)
              == 0);
      data->done = TRUE;
      /* "Pop" the element. */
      data->current = g_slist_next (data->current);
    }
  else if (data->current)
    {
      GSList *front;
      /* "Pop" and free the element. */
      front = data->current;
      data->current = g_slist_next (data->current);
      g_slist_free_1 (front);
    }
}

References context_data_t::current, context_data_t::done, element_name(), and context_data_t::first.

Referenced by parse_entity(), try_read_entity_and_string(), try_read_entity_and_string_s(), and xml_handle_end_element().

Here is the call graph for this function:

Here is the caller graph for this function:

handle_error()

void handle_error ( GMarkupParseContext * context, GError * error, gpointer user_data )

static

Handle an OMP XML parsing error.

Parameters

[in]	context	Parser context.
[in]	error	The error.
[in]	user_data	Dummy parameter.

Definition at line 477 of file xmlutils.c.

{
  (void) context;
  (void) user_data;
  g_message ("   Error: %s\n", error->message);
}

Referenced by parse_entity(), try_read_entity_and_string(), and try_read_entity_and_string_s().

Here is the caller graph for this function:

handle_start_element()

void handle_start_element ( GMarkupParseContext * context, const gchar * element_name, const gchar ** attribute_names, const gchar ** attribute_values, gpointer user_data, GError ** error )

static

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.
[in]	user_data	Dummy parameter.
[in]	error	Error parameter.

Definition at line 290 of file xmlutils.c.

{
  entity_t entity;
  context_data_t *data = (context_data_t *) user_data;
 
  (void) context;
  (void) error;
  if (data->current)
    {
      entity_t current = (entity_t) data->current->data;
      entity = add_entity (&current->entities, element_name, NULL);
    }
  else
    entity = add_entity (NULL, element_name, NULL);
 
  add_attributes (entity, attribute_names, attribute_values);
 
  /* "Push" the element. */
  if (data->first == NULL)
    data->current = data->first = g_slist_prepend (NULL, entity);
  else
    data->current = g_slist_prepend (data->current, entity);
}

References add_attributes(), add_entity(), context_data_t::current, element_name(), entity_s::entities, and context_data_t::first.

Referenced by parse_entity(), try_read_entity_and_string(), try_read_entity_and_string_s(), and xml_handle_start_element().

Here is the call graph for this function:

Here is the caller graph for this function:

handle_text()

void handle_text ( GMarkupParseContext * context, const gchar * text, gsize text_len, gpointer user_data, GError ** error )

static

Handle additional text of an XML element.

Parameters

[in]	context	Parser context.
[in]	text	The text.
[in]	text_len	Length of the text.
[in]	user_data	Dummy parameter.
[in]	error	Error parameter.

Definition at line 437 of file xmlutils.c.

{
  context_data_t *data = (context_data_t *) user_data;
 
  (void) context;
  (void) text_len;
  (void) error;
  entity_t current = (entity_t) data->current->data;
  if (current->text)
    {
      gchar *old = current->text;
      current->text = g_strconcat (current->text, text, NULL);
      g_free (old);
    }
  else
    current->text = g_strdup (text);
}

References context_data_t::current, and entity_s::text.

Referenced by parse_entity(), try_read_entity_and_string(), try_read_entity_and_string_s(), and xml_handle_text().

Here is the caller graph for this function:

ignore_end_element()

void ignore_end_element ( GMarkupParseContext * context, const gchar * element_name, gpointer user_data, GError ** error )

static

Handle the end of an XML element.

Parameters

[in]	context	Parser context.
[in]	element_name	XML element name.
[in]	user_data	Dummy parameter.
[in]	error	Error parameter.

Definition at line 343 of file xmlutils.c.

{
  context_data_t *data = (context_data_t *) user_data;
 
  (void) context;
  (void) element_name;
  (void) error;
 
  data->current = GINT_TO_POINTER (GPOINTER_TO_INT (data->current) - 1);
  if (data->current == NULL)
    data->done = TRUE;
}

References context_data_t::current, context_data_t::done, and element_name().

Referenced by 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:

ignore_start_element()

void ignore_start_element ( GMarkupParseContext * context, const gchar * element_name, const gchar ** attribute_names, const gchar ** attribute_values, gpointer user_data, GError ** error )

static

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.
[in]	user_data	Dummy parameter.
[in]	error	Error parameter.

Definition at line 263 of file xmlutils.c.

{
  context_data_t *data = (context_data_t *) user_data;
 
  (void) context;
  (void) element_name;
  (void) attribute_names;
  (void) attribute_values;
  (void) error;
 
  data->current = GINT_TO_POINTER (GPOINTER_TO_INT (data->current) + 1);
}

References context_data_t::current, and element_name().

Referenced by 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:

ignore_text()

void ignore_text ( GMarkupParseContext * context, const gchar * text, gsize text_len, gpointer user_data, GError ** error )

static

Handle additional text of an XML element.

Parameters

[in]	context	Parser context.
[in]	text	The text.
[in]	text_len	Length of the text.
[in]	user_data	Dummy parameter.
[in]	error	Error parameter.

Definition at line 417 of file xmlutils.c.

{
  (void) context;
  (void) text;
  (void) text_len;
  (void) user_data;
  (void) error;
}

Referenced by try_read_entity_and_string(), and try_read_entity_and_string_s().

Here is the caller graph for this function:

make_entity()

entity_t make_entity ( const char * name, const char * text )

static

Create an entity.

Parameters

[in]	name	Name of the entity. Copied, freed by free_entity.
[in]	text	Text of the entity. Copied, freed by free_entity.

Returns

A newly allocated entity.

Definition at line 48 of file xmlutils.c.

{
  entity_t entity;
  entity = g_malloc (sizeof (*entity));
  entity->name = g_strdup (name ? name : "");
  entity->text = g_strdup (text ? text : "");
  entity->entities = NULL;
  entity->attributes = NULL;
  return entity;
}

References entity_s::attributes, entity_s::entities, entity_s::name, and entity_s::text.

Referenced by add_entity().

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 2003 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(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), Ensure(), and 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);
        }
      g_markup_parse_context_free (xml_context);
      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);
            }
          g_markup_parse_context_free (xml_context);
          return -2;
        }
      *entity = (entity_t) context_data.first->data;
      g_slist_free_1 (context_data.first);
      g_markup_parse_context_free (xml_context);
      return 0;
    }
  if (context_data.first && context_data.first->data)
    {
      free_entity (context_data.first->data);
      g_slist_free_1 (context_data.first);
    }
  g_markup_parse_context_free (xml_context);
  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(), Ensure(), Ensure(), Ensure(), Ensure(), and 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 2280 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 1663 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 1706 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 1616 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_and_string_s()

int try_read_entity_and_string_s ( int socket, int timeout, entity_t * entity, GString ** string_return )

static

Try read an XML entity tree from the socket.

Parameters

[in]	socket	Socket to read from.
[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 1030 of file xmlutils.c.

{
  GMarkupParser xml_parser;
  GError *error = NULL;
  GMarkupParseContext *xml_context;
  GString *string;
  time_t last_time;
  /* Buffer for reading from the socket. */
  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. */
 
      if (fcntl (socket, F_SETFL, O_NONBLOCK) == -1)
        return -1;
    }
 
  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)
    {
      int count;
      while (1)
        {
          g_debug ("   asking for %i\n", BUFFER_SIZE);
          count = read (socket, buffer, BUFFER_SIZE);
          if (count < 0)
            {
              if (errno == EINTR)
                /* Interrupted, try read again. */
                continue;
              if (timeout > 0)
                {
                  if (errno == EAGAIN)
                    {
                      /* 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);
                          if (string && *string_return == NULL)
                            g_string_free (string, TRUE);
                          return -4;
                        }
                    }
                  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)
                fcntl (socket, F_SETFL, 0L);
              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);
          // FIX there may be multiple entries in list
          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);
              if (string && *string_return == NULL)
                g_string_free (string, TRUE);
              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_slist_free (context_data.first);
          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 server socket flag: %s", __func__,
                       strerror (errno));
          g_markup_parse_context_free (xml_context);
          g_free (buffer);
          if (string && *string_return == NULL)
            g_string_free (string, TRUE);
          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_c(), read_entity_s(), 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:

try_read_string()

int try_read_string ( gnutls_session_t * session, int timeout, GString ** string_return )

static

Try read a response from a TLS session.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	timeout	Server idle time before giving up, in seconds. 0 to wait forever.
[out]	string_return	An optional return location for the text read from the session.

If string_return is NULL then it simply remains NULL. If it is pointer to NULL then it points to a freshly allocated GString on successful return. Otherwise it must point to an existing GString onto which the text is appended.

Returns

0 success, -1 read error, -4 timeout, -5 null buffer.

Definition at line 752 of file xmlutils.c.

{
  GString *string;
  int socket;
  time_t last_time;
  char *buffer; // Buffer for reading from the server.
 
  /* 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;
 
  /* Read 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_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 (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_free (buffer);
              return -1;
            }
          if (count == 0)
            {
              /* End of file. */
              if (timeout > 0)
                {
                  if (fcntl (socket, F_SETFL, 0L) < 0)
                    g_warning ("%s :failed to set socket flag: %s", __func__,
                               strerror (errno));
                }
              if (string)
                *string_return = string;
              g_free (buffer);
              return 0;
            }
          break;
        }
 
      g_debug ("<= %.*s\n", (int) count, buffer);
 
      if (string)
        g_string_append_len (string, buffer, count);
 
      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_free (buffer);
          return -1;
        }
    }
}

References BUFFER_SIZE.

Referenced by read_text_c().

Here is the caller graph for this function:

try_read_string_s()

int try_read_string_s ( int socket, int timeout, GString ** string_return )

static

Try read an XML entity tree from the socket.

Parameters

[in]	socket	Socket to read from.
[in]	timeout	Server idle time before giving up, in seconds. 0 to wait forever.
[out]	string_return	An optional return location for the text read from the socket. 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 900 of file xmlutils.c.

{
  GString *string;
  time_t last_time;
  /* Buffer for reading from the socket. */
  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. */
 
      if (fcntl (socket, F_SETFL, O_NONBLOCK) == -1)
        return -1;
    }
 
  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_sized_new (8192);
  else
    string = *string_return;
 
  /* Read until encountering end of file or error. */
 
  while (1)
    {
      int count;
      while (1)
        {
          g_debug ("   asking for %i\n", BUFFER_SIZE);
          count = read (socket, buffer, BUFFER_SIZE);
          if (count < 0)
            {
              if (errno == EINTR)
                /* Interrupted, try read again. */
                continue;
              if (timeout > 0)
                {
                  if (errno == EAGAIN)
                    {
                      /* 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_free (buffer);
                          if (string && *string_return == NULL)
                            g_string_free (string, TRUE);
                          return -4;
                        }
                    }
                  continue;
                }
              if (string && *string_return == NULL)
                g_string_free (string, TRUE);
              if (timeout > 0)
                fcntl (socket, F_SETFL, 0L);
              g_free (buffer);
              return -1;
            }
          if (count == 0)
            {
              /* End of file. */
              if (timeout > 0)
                {
                  if (fcntl (socket, F_SETFL, 0L) < 0)
                    g_warning ("%s :failed to set socket flag: %s", __func__,
                               strerror (errno));
                }
              if (string)
                *string_return = string;
              g_free (buffer);
              return 0;
            }
          break;
        }
 
      g_debug ("<= %.*s\n", (int) count, buffer);
 
      if (string)
        g_string_append_len (string, buffer, count);
 
      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 server socket flag: %s", __func__,
                       strerror (errno));
          g_free (buffer);
          if (string && *string_return == NULL)
            g_string_free (string, TRUE);
          return -1;
        }
    }
}

References BUFFER_SIZE.

Referenced by read_text_c().

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 1830 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_file_iterator_attribute_decl()

void xml_file_iterator_attribute_decl ( void * ctx, const xmlChar * elem, const xmlChar * fullname, int type, int def, const xmlChar * defaultValue, xmlEnumerationPtr tree )

static

XML file iterator parser callback for when an attribute definition has been parsed.

This is just a wrapper for the libXML xmlSAX2AttributeDecl getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	name	the name of the element
[in]	fullname	the attribute name
[in]	type	the attribute type
[in]	def	the type of default value
[in]	defaultValue	the attribute default value
[in]	tree	the tree of enumerated value set

Definition at line 2615 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2AttributeDecl (iterator->parser_ctxt, elem, fullname, type, def,
                        defaultValue, tree);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_cdata_block()

void xml_file_iterator_cdata_block ( void * ctx, const xmlChar * ch, int len )

static

XML file iterator parser callback when a cdata block has been parsed.

This is just a wrapper for the libXML xmlSAX2CDataBlock getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	ch	The cdata content
[in]	len	the block length

Definition at line 2768 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2CDataBlock (iterator->parser_ctxt, ch, len);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_characters()

void xml_file_iterator_characters ( void * ctx, const xmlChar * ch, int len )

static

XML file iterator parser callback when receiving some chars from the parser.

This is just a wrapper for the libXML xmlSAX2Characters getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	ch	a xmlChar string
[in]	len	the number of xmlChar

Definition at line 2750 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2Characters (iterator->parser_ctxt, ch, len);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_comment()

void xml_file_iterator_comment ( void * ctx, const xmlChar * value )

static

XML file iterator parser callback when a comment has been parsed.

This is just a wrapper for the libXML xmlSAX2Comment getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	value	the comment content

Definition at line 2803 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2Comment (iterator->parser_ctxt, value);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_element_decl()

void xml_file_iterator_element_decl ( void * ctx, const xmlChar * name, int type, xmlElementContentPtr content )

static

XML file iterator parser callback for when an element definition has been parsed.

This is just a wrapper for the libXML xmlSAX2ElementDecl getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	name	the element name
[in]	type	the element type
[in]	def	the type of default value
[in]	defaultValue	the attribute default value
[in]	content	the element value tree

Definition at line 2640 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2ElementDecl (iterator->parser_ctxt, name, type, content);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_end_document()

void xml_file_iterator_end_document ( void * ctx )

static

XML file iterator parser callback at the document end.

This is just a wrapper for the libXML xmlSAX2EndDocument getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]

ctx

parser context data / iterator data structure

Definition at line 2732 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2EndDocument (iterator->parser_ctxt);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_end_element_ns()

void xml_file_iterator_end_element_ns ( void * ctx, const xmlChar * localname, const xmlChar * prefix, const xmlChar * URI )

static

XML file iterator parser callback for element end.

This uses xmlSAX2EndElementNs to finish parsing the element to the document in the libXML parser context of the iterator. If the element is at the output tree depth defined in the iterator then it is removed from the document and added to the element queue of the iterator.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	localname	the local name of the element
[in]	prefix	the element namespace prefix if available
[in]	URI	the element namespace name if available

Definition at line 2390 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2EndElementNs (iterator->parser_ctxt, localname, prefix, URI);
  iterator->stack_depth--;
  if (iterator->stack_depth == iterator->output_depth)
    {
      xmlNodePtr parent, child;
      parent = iterator->parser_ctxt->node;
 
      child = parent->children;
      while (child)
        {
          if (child->type == XML_ELEMENT_NODE)
            {
              xmlDocPtr new_doc = xmlNewDoc ((const xmlChar *) "1.0");
              element_t child_copy;
              child_copy = xmlCopyNode (child, 1);
              xmlDocSetRootElement (new_doc, child_copy);
 
              if (child_copy)
                {
                  g_queue_push_tail (iterator->element_queue, child_copy);
                }
            }
 
          xmlUnlinkNode (child);
          xmlFreeNode (child);
 
          child = parent->children;
        }
    }
}

References xml_file_iterator_struct::element_queue, xml_file_iterator_struct::output_depth, xml_file_iterator_struct::parser_ctxt, and xml_file_iterator_struct::stack_depth.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_entity_decl()

void xml_file_iterator_entity_decl ( void * ctx, const xmlChar * name, int type, const xmlChar * publicId, const xmlChar * systemId, xmlChar * content )

static

XML file iterator parser callback for when an entity definition has been parsed.

This is just a wrapper for the libXML xmlSAX2EntityDecl getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	name	the entity name
[in]	type	the entity type
[in]	publicId	The public ID of the entity
[in]	systemId	The system ID of the entity
[in]	content	the entity value (without processing)

Definition at line 2590 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2EntityDecl (iterator->parser_ctxt, name, type, publicId, systemId,
                     content);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_external_subset()

void xml_file_iterator_external_subset ( void * ctx, const xmlChar * name, const xmlChar * ExternalID, const xmlChar * SystemID )

static

XML file iterator parser callback for external subset declaration.

This is just a wrapper for the libXML xmlSAX2ExternalSubset getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	name	the root element name
[in]	ExternalID	the external ID
[in]	SystemID	the SYSTEM ID (e.g. filename or URL)

Definition at line 2457 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2ExternalSubset (iterator->parser_ctxt, name, ExternalID, SystemID);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_free()

void xml_file_iterator_free

(

xml_file_iterator_t

iterator

)

Frees an XML file iterator and all of its internal data structures.

Parameters

[in]

iterator

The XML file iterator to free.

Definition at line 2919 of file xmlutils.c.

{
  if (iterator == NULL)
    return;
 
  if (iterator->file)
    {
      fclose (iterator->file);
    }
 
  g_free (iterator->file_path);
 
  if (iterator->element_queue)
    {
      g_queue_free_full (iterator->element_queue,
                         (GDestroyNotify) (element_free));
    }
 
  if (iterator->parser_ctxt)
    {
      if (iterator->parser_ctxt->myDoc)
        xmlFreeDoc (iterator->parser_ctxt->myDoc);
      xmlFreeParserCtxt (iterator->parser_ctxt);
    }
 
  g_free (iterator);
}

References element_free(), xml_file_iterator_struct::element_queue, xml_file_iterator_struct::file, xml_file_iterator_struct::file_path, and xml_file_iterator_struct::parser_ctxt.

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

Here is the call graph for this function:

Here is the caller graph for this function:

xml_file_iterator_get_entity()

xmlEntityPtr xml_file_iterator_get_entity ( void * ctx, const xmlChar * name )

static

XML file iterator parser callback for getting an entity by name.

This is just a wrapper for the libXML xmlSAX2GetEntity getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	name	The entity name

Returns

the xmlEntityPtr if found

Definition at line 2550 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  return xmlSAX2GetEntity (iterator->parser_ctxt, name);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_get_parameter_entity()

xmlEntityPtr xml_file_iterator_get_parameter_entity ( void * ctx, const xmlChar * name )

static

XML file iterator parser callback for getting a parameter entity by name.

This is just a wrapper for the libXML xmlSAX2GetParameterEntity getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	name	The entity name

Returns

the xmlEntityPtr if found

Definition at line 2569 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  return xmlSAX2GetParameterEntity (iterator->parser_ctxt, name);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_has_external_subset()

int xml_file_iterator_has_external_subset ( void * ctx )

static

XML file iterator parser callback for checking if doc has an external subset.

This is just a wrapper for the libXML xmlSAX2HasExternalSubset getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]

ctx

parser context data / iterator data structure

Returns

1 if true

Definition at line 2512 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  return xmlSAX2HasExternalSubset (iterator->parser_ctxt);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_has_internal_subset()

int xml_file_iterator_has_internal_subset ( void * ctx )

static

XML file iterator parser callback for checking if doc has an internal subset.

This is just a wrapper for the libXML xmlSAX2HasInternalSubset getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]

ctx

parser context data / iterator data structure

Returns

1 if true

Definition at line 2494 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  return xmlSAX2HasInternalSubset (iterator->parser_ctxt);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_init_from_file_path()

int xml_file_iterator_init_from_file_path	(	xml_file_iterator_t	iterator,
		const char *	file_path,
		int	output_depth )

Initializes an XML file iterator to read from a given path.

Parameters

[in]	iterator	Pointer to the iterator to initialize.
[in]	file_path	Path to the file to read from.
[in]	output_depth	XML tree depth at which to return elements.

Returns

-1 error, 0 success, 1 already initialized, 2 error opening file (errno is set to reason), 3 error creating parser context

Definition at line 2876 of file xmlutils.c.

{
  if (iterator == NULL)
    return -1;
 
  if (iterator->initialized)
    return 1;
 
  memset (iterator, 0, sizeof (struct xml_file_iterator_struct));
 
  LIBXML_TEST_VERSION
 
  if (output_depth < 0)
    output_depth = 0;
  iterator->output_depth = output_depth;
 
  iterator->file = fopen (file_path, "rb");
  if (iterator->file == NULL)
    return 2;
 
  iterator->element_queue = g_queue_new ();
 
  iterator->file_path = g_strdup (file_path);
 
  xml_file_iterator_init_sax_handler (&(iterator->sax_handler));
  iterator->parser_ctxt = xmlCreatePushParserCtxt (
    &(iterator->sax_handler), iterator, NULL, 0, iterator->file_path);
  if (iterator->parser_ctxt == NULL)
    return 3;
 
  iterator->initialized = 1;
  iterator->stack_depth = 0;
 
  return 0;
}

References xml_file_iterator_struct::element_queue, xml_file_iterator_struct::file, xml_file_iterator_struct::file_path, xml_file_iterator_struct::initialized, xml_file_iterator_struct::output_depth, xml_file_iterator_struct::parser_ctxt, xml_file_iterator_struct::sax_handler, xml_file_iterator_struct::stack_depth, and xml_file_iterator_init_sax_handler().

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

Here is the call graph for this function:

Here is the caller graph for this function:

xml_file_iterator_init_sax_handler()

void xml_file_iterator_init_sax_handler ( xmlSAXHandlerPtr hdlr )

static

Initializes a xmlSAXHandler data structure for SAX version 2 parsing, assigning all the XML file iterator callback functions.

Parameters

[in]

hdlr

The xmlSAXHandler to initialize

Definition at line 2816 of file xmlutils.c.

{
  hdlr->startElementNs = xml_file_iterator_start_element_ns;
  hdlr->endElementNs = xml_file_iterator_end_element_ns;
  hdlr->error = NULL;
  hdlr->initialized = XML_SAX2_MAGIC;
  hdlr->startElement = NULL;
  hdlr->endElement = NULL;
  hdlr->internalSubset = xml_file_iterator_internal_subset;
  hdlr->externalSubset = xml_file_iterator_external_subset;
  hdlr->isStandalone = xml_file_iterator_is_standalone;
  hdlr->hasInternalSubset = xml_file_iterator_has_internal_subset;
  hdlr->hasExternalSubset = xml_file_iterator_has_external_subset;
  hdlr->resolveEntity = xml_file_iterator_resolve_entity;
  hdlr->getEntity = xml_file_iterator_get_entity;
  hdlr->getParameterEntity = xml_file_iterator_get_parameter_entity;
  hdlr->entityDecl = xml_file_iterator_entity_decl;
  hdlr->attributeDecl = xml_file_iterator_attribute_decl;
  hdlr->elementDecl = xml_file_iterator_element_decl;
  hdlr->notationDecl = xml_file_iterator_notation_decl;
  hdlr->unparsedEntityDecl = xml_file_iterator_unparsed_entity_decl;
  hdlr->setDocumentLocator = xml_file_iterator_set_document_locator;
  hdlr->startDocument = xml_file_iterator_start_document;
  hdlr->endDocument = xml_file_iterator_end_document;
  hdlr->reference = NULL;
  hdlr->characters = xml_file_iterator_characters;
  hdlr->cdataBlock = xml_file_iterator_cdata_block;
  hdlr->ignorableWhitespace = xml_file_iterator_characters;
  hdlr->processingInstruction = xml_file_iterator_processing_instruction;
  hdlr->comment = xml_file_iterator_comment;
  hdlr->warning = xmlParserWarning;
  hdlr->error = xmlParserError;
  hdlr->fatalError = xmlParserError;
}

References xml_file_iterator_attribute_decl(), xml_file_iterator_cdata_block(), xml_file_iterator_characters(), xml_file_iterator_comment(), xml_file_iterator_element_decl(), xml_file_iterator_end_document(), xml_file_iterator_end_element_ns(), xml_file_iterator_entity_decl(), xml_file_iterator_external_subset(), xml_file_iterator_get_entity(), xml_file_iterator_get_parameter_entity(), xml_file_iterator_has_external_subset(), xml_file_iterator_has_internal_subset(), xml_file_iterator_internal_subset(), xml_file_iterator_is_standalone(), xml_file_iterator_notation_decl(), xml_file_iterator_processing_instruction(), xml_file_iterator_resolve_entity(), xml_file_iterator_set_document_locator(), xml_file_iterator_start_document(), xml_file_iterator_start_element_ns(), and xml_file_iterator_unparsed_entity_decl().

Referenced by xml_file_iterator_init_from_file_path().

Here is the call graph for this function:

Here is the caller graph for this function:

xml_file_iterator_internal_subset()

void xml_file_iterator_internal_subset ( void * ctx, const xmlChar * name, const xmlChar * ExternalID, const xmlChar * SystemID )

static

XML file iterator parser callback for internal subset declaration.

This is just a wrapper for the libXML xmlSAX2InternalSubset getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	name	the root element name
[in]	ExternalID	the external ID
[in]	SystemID	the SYSTEM ID (e.g. filename or URL)

Definition at line 2437 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2InternalSubset (iterator->parser_ctxt, name, ExternalID, SystemID);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_is_standalone()

int xml_file_iterator_is_standalone ( void * ctx )

static

XML file iterator parser callback for checking if doc is standalone.

This is just a wrapper for the libXML xmlSAX2IsStandalone getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]

ctx

parser context data / iterator data structure

Returns

1 if true

Definition at line 2476 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  return xmlSAX2IsStandalone (iterator->parser_ctxt);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_new()

xml_file_iterator_t xml_file_iterator_new

(

void

)

Allocates a new, uninitialized XML file iterator.

Free with xml_file_iterator_free.

Returns

Opaque pointer to the XML file iterator data structure.

Definition at line 2859 of file xmlutils.c.

{
  return g_malloc0 (sizeof (struct xml_file_iterator_struct));
}

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

Here is the caller graph for this function:

xml_file_iterator_next()

element_t xml_file_iterator_next	(	xml_file_iterator_t	iterator,
		gchar **	error )

Get the next subelement from a XML file iterator.

Parameters

[in]	iterator	The XML file iterator to get the element from.
[out]	error	Error message output, set to NULL on success / EOF

Returns

The next subelement (free with element_free) or NULL if finished or on error.

Definition at line 3002 of file xmlutils.c.

{
  gboolean continue_read = TRUE;
 
  if (error)
    *error = NULL;
 
  if (iterator->initialized == 0)
    {
      if (error)
        *error = g_strdup ("iterator not initialized");
      return NULL;
    }
 
  while (continue_read && g_queue_is_empty (iterator->element_queue))
    {
      int chars_read;
      char buffer[XML_FILE_ITERATOR_BUFFER_SIZE];
 
      chars_read =
        fread (buffer, 1, XML_FILE_ITERATOR_BUFFER_SIZE, iterator->file);
      if (chars_read == 0)
        {
          if (feof (iterator->file))
            {
              continue_read = FALSE;
            }
          else if (ferror (iterator->file))
            {
              if (error)
                *error = g_strdup ("error reading file");
              return NULL;
            }
        }
      else
        {
          int ret;
          ret = xmlParseChunk (iterator->parser_ctxt, buffer, chars_read,
                               continue_read == 0);
          if (ret)
            {
              if (error)
                {
                  const xmlError *xml_error;
                  xml_error = xmlCtxtGetLastError (iterator->parser_ctxt);
                  *error = g_strdup_printf ("error parsing XML"
                                            " (line %d column %d): %s",
                                            xml_error->line, xml_error->int2,
                                            xml_error->message);
                }
 
              return NULL;
            }
        }
    }
 
  if (!g_queue_is_empty (iterator->element_queue))
    {
      return g_queue_pop_head (iterator->element_queue);
    }
 
  return NULL;
}

References xml_file_iterator_struct::element_queue, xml_file_iterator_struct::file, xml_file_iterator_struct::initialized, xml_file_iterator_struct::parser_ctxt, and XML_FILE_ITERATOR_BUFFER_SIZE.

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

Here is the caller graph for this function:

xml_file_iterator_notation_decl()

void xml_file_iterator_notation_decl ( void * ctx, const xmlChar * name, const xmlChar * publicId, const xmlChar * systemId )

static

XML file iterator parser callback for when a notation definition has been parsed.

This is just a wrapper for the libXML xmlSAX2NotationDecl getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	name	The name of the notation
[in]	publicId	The public ID of the entity
[in]	systemId	The system ID of the entity

Definition at line 2660 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2NotationDecl (iterator->parser_ctxt, name, publicId, systemId);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_processing_instruction()

void xml_file_iterator_processing_instruction ( void * ctx, const xmlChar * target, const xmlChar * data )

static

XML file iterator parser callback when a processing instruction has been parsed.

This is just a wrapper for the libXML xmlSAX2ProcessingInstruction getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	target	The target name
[in]	data	the PI data

Definition at line 2786 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2ProcessingInstruction (iterator->parser_ctxt, target, data);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_resolve_entity()

xmlParserInputPtr xml_file_iterator_resolve_entity ( void * ctx, const xmlChar * publicId, const xmlChar * systemId )

static

XML file iterator parser callback for resolving an entity.

This is just a wrapper for the libXML xmlSAX2ResolveEntity getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	publicId	The public ID of the entity
[in]	systemId	The systemID of the entity

Returns

the xmlParserInputPtr if inlined or NULL for DOM behaviour

Definition at line 2531 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  return xmlSAX2ResolveEntity (iterator->parser_ctxt, publicId, systemId);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_rewind()

int xml_file_iterator_rewind

(

xml_file_iterator_t

iterator

)

Rewinds an XML file iterator by rewinding the file and creating a new XML parser context.

Parameters

[in]

iterator

The XML file iterator to rewind.

Returns

0 success, 1 error creating new parser context

Definition at line 2956 of file xmlutils.c.

{
  if (iterator == NULL)
    return 0;
 
  if (iterator->file)
    {
      rewind (iterator->file);
    }
 
  if (iterator->element_queue)
    {
      g_queue_clear_full (iterator->element_queue,
                          (GDestroyNotify) (element_free));
    }
 
  if (iterator->parser_ctxt)
    {
      if (iterator->parser_ctxt->myDoc)
        xmlFreeDoc (iterator->parser_ctxt->myDoc);
      xmlFreeParserCtxt (iterator->parser_ctxt);
      iterator->parser_ctxt = xmlCreatePushParserCtxt (
        &(iterator->sax_handler), iterator, NULL, 0, iterator->file_path);
      if (iterator->parser_ctxt == NULL)
        return 1;
    }
  iterator->stack_depth = 0;
 
  return 0;
}

References element_free(), xml_file_iterator_struct::element_queue, xml_file_iterator_struct::file, xml_file_iterator_struct::file_path, xml_file_iterator_struct::parser_ctxt, xml_file_iterator_struct::sax_handler, and xml_file_iterator_struct::stack_depth.

Referenced by Ensure().

Here is the call graph for this function:

Here is the caller graph for this function:

xml_file_iterator_set_document_locator()

void xml_file_iterator_set_document_locator ( void * ctx, xmlSAXLocatorPtr loc )

static

XML file iterator parser callback for setting the document locator.

This is just a wrapper for the libXML xmlSAX2SetDocumentLocator getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	loc	A SAX Locator

Definition at line 2702 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2SetDocumentLocator (iterator->parser_ctxt, loc);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_start_document()

void xml_file_iterator_start_document ( void * ctx )

static

XML file iterator parser callback at the document start.

This is just a wrapper for the libXML xmlSAX2StartDocument getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]

ctx

parser context data / iterator data structure

Definition at line 2717 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2StartDocument (iterator->parser_ctxt);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_start_element_ns()

void xml_file_iterator_start_element_ns ( void * ctx, const xmlChar * localname, const xmlChar * prefix, const xmlChar * URI, int nb_namespaces, const xmlChar ** namespaces, int nb_attributes, int nb_defaulted, const xmlChar ** attributes )

static

XML file iterator parser callback for element start.

This is just a wrapper for the libXML xmlSAX2StartElementNs getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	localname	the local name of the element
[in]	prefix	the element namespace prefix if available
[in]	URI	the element namespace name if available
[in]	nb_namespaces	number of namespace definitions on that node
[in]	namespaces	pointer to the array of prefix/URI pairs namespace definitions
[in]	nb_attributes	the number of attributes on that node
[in]	nb_defaulted	the number of defaulted attributes
[in]	attributes	pointer to the array of (localname/prefix/URI/value/end) attribute values

Definition at line 2361 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2StartElementNs (iterator->parser_ctxt, localname, prefix, URI,
                         nb_namespaces, namespaces, nb_attributes, nb_defaulted,
                         attributes);
  iterator->stack_depth++;
}

References xml_file_iterator_struct::parser_ctxt, and xml_file_iterator_struct::stack_depth.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller graph for this function:

xml_file_iterator_unparsed_entity_decl()

void xml_file_iterator_unparsed_entity_decl ( void * ctx, const xmlChar * name, const xmlChar * publicId, const xmlChar * systemId, const xmlChar * notationName )

static

XML file iterator parser callback for when an unparsed entity declaration has been parsed.

This is just a wrapper for the libXML xmlSAX2UnparsedEntityDecl getting the libXML parser context from the iterator struct passed as user data.

Parameters

[in]	ctx	parser context data / iterator data structure
[in]	name	The name of the notation
[in]	publicId	The public ID of the entity
[in]	systemId	The system ID of the entity
[in]	notationName	The name of the notation

Definition at line 2682 of file xmlutils.c.

{
  xml_file_iterator_t iterator = (xml_file_iterator_t) ctx;
  xmlSAX2UnparsedEntityDecl (iterator->parser_ctxt, name, publicId, systemId,
                             notationName);
}

References xml_file_iterator_struct::parser_ctxt.

Referenced by xml_file_iterator_init_sax_handler().

Here is the caller 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_search_handle_start_element()

void xml_search_handle_start_element ( GMarkupParseContext * ctx, const gchar * element_name, const gchar ** attribute_names, const gchar ** attribute_values, gpointer data, GError ** error )

static

Handle the opening tag of an element in an XML search.

Parameters

[in]	ctx	The parse context.
[in]	element_name	The name of the element.
[in]	attribute_names	NULL-terminated array of attribute names.
[in]	attribute_values	NULL-terminated array of attribute values.
[in]	data	The search data struct.
[out]	error	Pointer to error output location.

Definition at line 1874 of file xmlutils.c.

{
  (void) ctx;
  (void) error;
 
  xml_search_data_t *search_data = ((xml_search_data_t *) data);
 
  if (strcmp (element_name, search_data->find_element) == 0
      && search_data->found == 0)
    {
      g_debug ("%s: Found element <%s>", __func__, element_name);
 
      if (search_data->find_attributes
          && g_hash_table_size (search_data->find_attributes))
        {
          int index;
          GHashTable *found_attributes;
          found_attributes =
            g_hash_table_new_full (g_str_hash, g_str_equal, NULL, NULL);
          index = 0;
          while (attribute_names[index])
            {
              gchar *searched_value;
              searched_value = g_hash_table_lookup (
                search_data->find_attributes, attribute_names[index]);
              if (searched_value
                  && strcmp (searched_value, attribute_values[index]) == 0)
                {
                  g_debug ("%s: Found attribute %s=\"%s\"", __func__,
                           attribute_names[index], searched_value);
                  g_hash_table_add (found_attributes, searched_value);
                }
              index++;
            }
          g_debug ("%s: Found %d of %d attributes", __func__,
                   g_hash_table_size (found_attributes),
                   g_hash_table_size (search_data->find_attributes));
 
          if (g_hash_table_size (found_attributes)
              == g_hash_table_size (search_data->find_attributes))
            {
              search_data->found = 1;
            }
 
          g_hash_table_destroy (found_attributes);
        }
      else
        {
          search_data->found = 1;
        }
    }
}

References element_name(), xml_search_data_t::find_attributes, xml_search_data_t::find_element, and xml_search_data_t::found.

Referenced by find_element_in_xml_file().

Here is the call graph for this function:

Here is the caller 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 1849 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: