lib/eggdrop/xml.c File Reference

#include <eggdrop/eggdrop.h>

Go to the source code of this file.

Functions
const char *	xml_last_error (void)
void	xml_set_error (const char *err)
xml_node_t *	xml_node_new ()
	Get a new, blank node.
xml_node_t *	xml_node_new_named (const char *name)
	Get a new, named node.
void	xml_node_free (xml_node_t *node)
	Free all memory associated with a node.
void	xml_node_unlink (xml_node_t *node)
	Unlinks a XML node from a tree.
void	xml_node_delete (xml_node_t *node)
	Deletes a node.
void	xml_node_delete_callbacked (xml_node_t *node, void(*callback)(void *))
	Deletes a node and executes a callback function.
void	xml_doc_delete (xml_node_t *root)
	Deletes an entire tree.
xml_node_t *	xml_node_vlookup (xml_node_t *root, va_list args, int create)
xml_node_t *	xml_node_lookup (xml_node_t *root, int create,...)
xml_node_t *	xml_node_path_lookup (xml_node_t *root, const char *path, int index, int create)
	Get a child of a node by its name.
char *	xml_node_fullname (xml_node_t *thenode)
int	xml_node_get_int (int *value, xml_node_t *node,...)
int	xml_node_int (xml_node_t *node, int def)
	Get an int or the default value from a node.
int	xml_node_get_str (char **str, xml_node_t *node,...)
char *	xml_node_str (xml_node_t *node, char *def)
	Get a string or the default value from a node.
int	xml_node_set_int (int value, xml_node_t *node,...)
int	xml_node_set_str (const char *str, xml_node_t *node,...)
int	xml_node_get_vars (xml_node_t *node, const char *fmt,...)
int	xml_node_set_vars (xml_node_t *node, const char *fmt,...)
xml_node_t *	xml_root_element (xml_node_t *node)
void	xml_node_append (xml_node_t *parent, xml_node_t *child)
	Attaches a node to a parent.
xml_attr_t *	xml_attr_new (char *name, char *value)
	Create a new attribute.
void	xml_attr_free (xml_attr_t *attr)
	Frees a node's attribute.
int	xml_node_append_attr (xml_node_t *node, xml_attr_t *attr)
	Append an attribute to a node.
xml_attr_t *	xml_attr_lookup (xml_node_t *node, const char *name)
	Searches for an attribute with a given name.
int	xml_attr_int (xml_node_t *node, const char *name, int def)
	Get an int or the default value from an attribute of a node.
char *	xml_attr_str (xml_node_t *node, const char *name, char *def)
	Get a string or the default value from an attribute of a node.
Variables
static const char	rcsid [] = "$Id: xml.c,v 1.27 2007-08-19 19:49:17 sven Exp $"
static char *	last_error = NULL

---

Function Documentation

void xml_attr_free

(

xml_attr_t *

attr

)

Frees a node's attribute.

This will delete an attribute and free all it's memory.

Parameters:

attr

The attribute to free.

Definition at line 557 of file xml.c.

References xml_attr_t::name, and xml_attr_t::value.

Referenced by xml_node_free().

{
  if (attr->name) free(attr->name);
  if (attr->value) free(attr->value);
  free(attr);
}

int xml_attr_int	(	xml_node_t *	node,
		const char *	name,
		int	def
	)

Get an int or the default value from an attribute of a node.

Will return the int value of the text of a given attribute of a node. If the node does not have an attribute of the given name or the attribute does not contain text, a default value will be returned.

Parameters:

	node	The node to return the int from.
	name	The name of the attribute.
	def	The default value to return in case no text is available.

Returns:

Either the value of the attribute or the default value.

Definition at line 616 of file xml.c.

References xml_attr_t::value, and xml_attr_lookup().

{
  xml_attr_t *attr = xml_attr_lookup(node, name);
  if (attr && attr->value) return atoi(attr->value);
  else return(def);
}

xml_attr_t* xml_attr_lookup	(	xml_node_t *	node,
		const char *	name
	)

Searches for an attribute with a given name.

Searches all attributes of a node for a given name. If an attribute with that name is found, it's returned.

Parameters:

	node	The node to search.
	name	The name of the attribute to search for.

Returns:

The attribute if found, otherwise NULL.

Definition at line 592 of file xml.c.

References xml_node::attributes, xml_attr_t::name, xml_node::nattributes, and NULL.

Referenced by xml_attr_int(), and xml_attr_str().

{
  int i;

  for (i = 0; i < node->nattributes; i++) {
    if (!strcasecmp(node->attributes[i]->name, name)) return(node->attributes[i]);
  }
  return(NULL);
}

xml_attr_t* xml_attr_new	(	char *	name,
		char *	value
	)

Create a new attribute.

Creates a new attribute and fills its fields. The strings used as parameters to this function will not be dup'd but used as is. The parameters must not be NULL.

Parameters:

	name	The name of the attribute.
	value	The value of the attribute. An empty string is fine, NULL is not.

Returns:

The new attribute.

Definition at line 538 of file xml.c.

References xml_attr_t::len, xml_attr_t::name, and xml_attr_t::value.

Referenced by read_attributes().

{
  xml_attr_t *attr;

  attr = malloc(sizeof(*attr));
  attr->name = name;
  attr->value = value;
  attr->len = strlen(value);
  return(attr);
}

char* xml_attr_str	(	xml_node_t *	node,
		const char *	name,
		char *	def
	)

Get a string or the default value from an attribute of a node.

Will return the text of a given attribute of a node as a string. If the node does not have an attribute of the given name or the attribute does not contain text, a default value will be returned.

Parameters:

	node	The node to return the string from.
	name	The name of the attribute.
	def	The default value to return in case no text is available.

Returns:

Either the value of the attribute or the default value.

Definition at line 637 of file xml.c.

References xml_attr_t::value, and xml_attr_lookup().

{
  xml_attr_t *attr = xml_attr_lookup(node, name);
  if (attr && attr->value) return(attr->value);
  else return(def);
}

void xml_doc_delete

(

xml_node_t *

root

)

Deletes an entire tree.

This function will delete the entire tree a node is in. The node does not have to be the root of that tree, any node of the tree will do.

Parameters:

root

Any node in the tree that will be deleted. Does not really have to be the root node.

Definition at line 174 of file xml.c.

References xml_node::parent, and xml_node_delete().

Referenced by user_load().

{
  while (root->parent) root = root->parent;
  xml_node_delete(root);
}

const char* xml_last_error

(

void

)

Definition at line 28 of file xml.c.

References last_error.

Referenced by channel_load(), config_load(), config_save(), and user_load().

{
  return last_error;
}

void xml_node_append	(	xml_node_t *	parent,
		xml_node_t *	child
	)

Attaches a node to a parent.

Sets a node as a child of a parent node. This node must not have a parent! If it does, use xml_node_unlink() first!

Parameters:

	parent	The node that will be the parent.
	child	The node that will be attached to the parent.

Definition at line 498 of file xml.c.

References xml_node::children, xml_node::last_child, xml_node::name, xml_node::nchildren, xml_node::next, xml_node::next_sibling, xml_node::parent, xml_node::prev, and xml_node::prev_sibling.

Referenced by channel_save(), save_walker(), xml_node_path_lookup(), and xml_parse_node().

{ 
  xml_node_t *node;

  child->parent = parent;
  parent->nchildren++;

  if (!parent->children) {
    parent->children = child;
  }
  else {
    parent->last_child->next = child;
    child->prev = parent->last_child;
  }

  parent->last_child = child;

  if (!child->name) return;
  for (node = child->prev; node; node = node->prev) {
    if (node->name && !strcasecmp(node->name, child->name)) {
      node->next_sibling = child;
      child->prev_sibling = node;
      break;
    }
  }
}

int xml_node_append_attr	(	xml_node_t *	node,
		xml_attr_t *	attr
	)

Append an attribute to a node.

Parameters:

	node	The node to appand the attribute to.
	attr	The attribute to append.

Returns:

Always 0.

Definition at line 573 of file xml.c.

References xml_node::attributes, and xml_node::nattributes.

Referenced by read_attributes().

{
  node->attributes = realloc(node->attributes, sizeof(*node->attributes) * (node->nattributes+1));
  node->attributes[node->nattributes++] = attr;
  return(0);
}

void xml_node_delete

(

xml_node_t *

node

)

Deletes a node.

This function is a wrapper for xml_node_delete_callbacked() without a callback.

Todo:

Might be better as a macro.

Parameters:

node

The node to delete.

Definition at line 131 of file xml.c.

References NULL, and xml_node_delete_callbacked().

Referenced by botnet_really_delete(), channel_free(), channel_load(), channel_save(), got_newbot(), got_nlinked(), got_version(), help_parse_file(), party_help(), user_really_delete(), user_save(), and xml_doc_delete().

{
  xml_node_delete_callbacked(node, NULL);
}

void xml_node_delete_callbacked	(	xml_node_t *	node,
		void(*)(void *)	callback
	)

Deletes a node and executes a callback function.

This function deletes a node and all of its children and attributes. For every deleted node the callback function is executed.

Parameters:

	node	The node to delete.
	callback	The callback function to execute. May be NULL.

Definition at line 146 of file xml.c.

References xml_node::children, xml_node::client_data, xml_node::next, NULL, xml_node::parent, xml_node_delete_callbacked(), xml_node_free(), and xml_node_unlink().

Referenced by config_delete_root(), config_destroy(), config_unlink_table(), xml_node_delete(), and xml_node_delete_callbacked().

{
  xml_node_t *child, *child_next;

  if (node->client_data && callback) callback(node->client_data);

  xml_node_unlink(node);

  /* Delete children. */
  for (child = node->children; child; child = child_next) {
    child_next = child->next;
    child->parent = NULL;
    xml_node_delete_callbacked(child, callback);
  }

  /* Free memory taken by node. */
  xml_node_free(node);
}

void xml_node_free

(

xml_node_t *

node

)

Free all memory associated with a node.

Parameters:

node

The node to be free'd.

Definition at line 74 of file xml.c.

References xml_node::attributes, xml_node::name, xml_node::nattributes, xml_node::text, and xml_attr_free().

Referenced by xml_node_delete_callbacked(), and xml_parse_node().

{
  xml_attr_t *attr;
  int i;

  if (node->name) free(node->name);
  if (node->text) free(node->text);
  for (i = 0; i < node->nattributes; i++) {
    attr = node->attributes[i];
    xml_attr_free(attr);
  }
  if (node->attributes) free(node->attributes);
  free(node);
}

char* xml_node_fullname

(

xml_node_t *

thenode

)

Definition at line 291 of file xml.c.

References xml_node::name, and xml_node::parent.

Referenced by channel_set(), config_set_int(), and config_set_str().

{
  xml_node_t *node;
  char *name, *name2;
  int len, total_len;

  len = total_len = 0;
  name = calloc(1, 1);
  for (node = thenode; node; node = node->parent) {
    if (!node->name) continue;

    /* Length of name plus the dot. */
    len = strlen(node->name) + 1;

    /* Name plus the null. */
    name2 = malloc(len + total_len + 1);

    /* Create new name. */
    sprintf(name2, "%s.%s", node->name, name);
    free(name);
    name = name2;
    total_len += len;
  }
  if (total_len > 0) name[total_len-1] = 0;
  return(name);
}

int xml_node_get_int	(	int *	value,
		xml_node_t *	node,
			...
	)

Definition at line 318 of file xml.c.

References NULL, xml_node::text, and xml_node_vlookup().

Referenced by channel_get_int(), config_get_int(), and xml_node_get_vars().

{
  va_list args;

  va_start(args, node);
  node = xml_node_vlookup(node, args, 0);
  va_end(args);
  if (node && node->text) {
    *value = strtol(node->text, NULL, 0);
    return(0);
  }
  *value = 0;
  return(-1);
}

int xml_node_get_str	(	char **	str,
		xml_node_t *	node,
			...
	)

Definition at line 357 of file xml.c.

References NULL, xml_node::text, and xml_node_vlookup().

Referenced by botnet_get_info(), channel_get(), channel_set(), config_get_str(), help_lookup_entry(), user_get_setting(), and xml_node_get_vars().

{
  va_list args;

  va_start(args, node);
  node = xml_node_vlookup(node, args, 0);
  va_end(args);
  if (node) {
    *str = node->text;
    return(0);
  }
  *str = NULL;
  return(-1);
}

int xml_node_get_vars	(	xml_node_t *	node,
		const char *	fmt,
			...
	)

Definition at line 420 of file xml.c.

References xml_node_get_int(), xml_node_get_str(), and xml_node_path_lookup().

Referenced by channel_load(), help_parse_file(), help_parse_syntax(), help_summarize_entry(), party_help(), and user_load().

{
  va_list args;
  char *name, **strptr;
  int *intptr;
  xml_node_t **nodeptr;

  va_start(args, fmt);
  while (*fmt) {
    name = va_arg(args, char *);
    switch (*fmt) {
      case 's':
        strptr = va_arg(args, char **);
        xml_node_get_str(strptr, node, name, 0, 0);
        break;
      case 'i':
        intptr = va_arg(args, int *);
        xml_node_get_int(intptr, node, name, 0, 0);
        break;
      case 'n':
        nodeptr = va_arg(args, xml_node_t **);
        *nodeptr = xml_node_path_lookup(node, name, 0, 0);
        break;
    }
    fmt++;
  }
  va_end(args);
  return(0);
}

int xml_node_int	(	xml_node_t *	node,
		int	def
	)

Get an int or the default value from a node.

Will convert the text of a given node to an int and return the value. If no node was given or the node does not contain text, a default value will be returned.

Parameters:

	node	The node to extract the int from.
	def	The default value to return in case the node does not contain text.

Returns:

Either the value from the node or the default value.

Definition at line 346 of file xml.c.

References xml_node::text.

{
  int value;
  char *ptr;

  if (!node || !node->text) return(def);
  value = strtol(node->text, &ptr, 0);
  if (!ptr || *ptr) return(def);
  else return(value);
}

xml_node_t* xml_node_lookup	(	xml_node_t *	root,
		int	create,
			...
	)

Definition at line 194 of file xml.c.

References xml_node_vlookup().

Referenced by channel_load(), config_link_table(), config_unlink_table(), config_update_table(), find_setting(), help_lookup_entry(), and user_load().

{
  va_list args;
  xml_node_t *node;

  va_start(args, create);
  node = xml_node_vlookup(root, args, create);
  va_end(args);
  return(node);
}

xml_node_t* xml_node_new

(

void

)

Get a new, blank node.

Returns:

The new, empty node.

Definition at line 44 of file xml.c.

Referenced by append_setting(), botnet_new(), channel_probe(), channel_save(), got_newbot(), got_nlinked(), got_version(), recving_login(), save_walker(), sending_login(), user_new(), user_save(), xml_node_new_named(), xml_node_path_lookup(), xml_parse_file(), and xml_parse_node().

{
  xml_node_t *node;

  node = calloc(sizeof(*node), 1);
  
  return node;
}

xml_node_t* xml_node_new_named

(

const char *

name

)

Get a new, named node.

Parameters:

name

The name of the node.

Returns:

The new, empty node.

Definition at line 61 of file xml.c.

References xml_node::name, and xml_node_new().

{
  xml_node_t *node = xml_node_new();
  node->name = strdup(name);
  return(node);
}

xml_node_t* xml_node_path_lookup	(	xml_node_t *	root,
		const char *	path,
		int	index,
		int	create
	)

Get a child of a node by its name.

This function searches a tree beginning with a given node and its children for a child by a given name.

This name can be very complex with serveral layers of the tree seperated by '.' and an index with "[x]. Example: "layer1.layer2[3].layer3".

Parameters:

	root	The node to start searching from.
	path	The name or path of the child to search for.
	index	Added to the index of every layer. Best used for a simple query without multiple layers.
	create	If this is non-zero and the node was not found it will be created.

Returns:

The node searched for or, if it was not found and create was zero, NULL.

Definition at line 222 of file xml.c.

References xml_node::children, xml_node::name, xml_node::next, xml_node::next_sibling, NULL, xml_node::type, XML_ELEMENT, xml_node_append(), and xml_node_new().

Referenced by xml_node_get_vars(), and xml_node_vlookup().

{
  int thisindex, len;
  xml_node_t *child;
  const char *next;
  char *name, *sep, buf[512];

  for (; root && path; path = next) {
    /* Get the next path element. */
    sep = strchr(path, '.');
    if (sep) {
      next = sep+1;
      len = sep - path;
    }
    else {
      next = NULL;
      len = strlen(path);
    }

    /* If it's empty, skip it, otherwise copy it. */
    if (!len) continue;
    else if (len > sizeof(buf) - 10) {
      name = malloc(len+1);
    }
    else {
      name = buf;
    }
    memcpy(name, path, len);
    name[len] = 0;

    /* Ok, now see if there's an [index] at the end. The length
     * has to be at least 4, because it's like "a[x]" at least. */
    thisindex = 0;
    if (len > 3 && name[len-1] == ']') {
      sep = strrchr(name, '[');
      if (sep) {
        *sep = 0;
        name[len-1] = 0;
        thisindex = atoi(sep+1);
      }
    }

    /* If it's the last path element, add the index param. */
    if (!next) thisindex += index;

    for (child = root->children; child; child = child->next) {
      if (child->name && !strcasecmp(child->name, name)) break;
    }

    while (child && thisindex > 0) {
      thisindex--;
      child = child->next_sibling;
    }

    if (!child && create) {
      do {    
        child = xml_node_new();
        child->type = XML_ELEMENT;
        child->name = strdup(name);
        xml_node_append(root, child);
      } while (thisindex-- > 0);
    }
    if (name != buf) free(name);

    root = child;
  }
  return(root);
}

int xml_node_set_int	(	int	value,
		xml_node_t *	node,
			...
	)

Definition at line 390 of file xml.c.

References str_redup(), xml_node::text, and xml_node_vlookup().

Referenced by botnet_set_info_int(), channel_save(), config_set_int(), got_newbot(), got_nlinked(), got_version(), recving_login(), save_walker(), sending_login(), user_save(), and xml_node_set_vars().

{
  char buf[32];
  va_list args;

  va_start(args, node);
  node = xml_node_vlookup(node, args, 1);
  va_end(args);
  if (!node) return(-1);

  snprintf(buf, sizeof(buf), "%d", value);
  str_redup(&node->text, buf);

  return(0);
}

int xml_node_set_str	(	const char *	str,
		xml_node_t *	node,
			...
	)

Definition at line 406 of file xml.c.

References str_redup(), xml_node::text, and xml_node_vlookup().

Referenced by botnet_set_info(), channel_save(), channel_set(), config_set_str(), got_newbot(), got_nlinked(), got_version(), recving_login(), save_walker(), sending_login(), user_set_setting(), and xml_node_set_vars().

{
  va_list args;

  va_start(args, node);
  node = xml_node_vlookup(node, args, 1);
  va_end(args);
  if (!node) return(-1);

  str_redup(&node->text, str);

  return(0);
}

int xml_node_set_vars	(	xml_node_t *	node,
		const char *	fmt,
			...
	)

Definition at line 450 of file xml.c.

References xml_node_set_int(), and xml_node_set_str().

{
  va_list args;
  char *name, *strval;
  int intval;

  va_start(args, fmt);
  while (*fmt) {
    name = va_arg(args, char *);
    switch (*fmt) {
      case 's':
        strval = va_arg(args, char *);
        xml_node_set_str(strval, node, name, 0, 0);
        break;
      case 'i':
        intval = va_arg(args, int);
        xml_node_set_int(intval, node, name, 0, 0);
        break;
    }
    fmt++;
  }
  va_end(args);
  return(0);
}

char* xml_node_str	(	xml_node_t *	node,
		char *	def
	)

Get a string or the default value from a node.

Will return the text of a given node as a string. If no node was given or the node does not contain text, a default value will be returned.

Parameters:

	node	The node to return the string from.
	def	The default value to return in case the node does not contain text.

Returns:

Either the value from the node or the default value.

Definition at line 384 of file xml.c.

References xml_node::text.

Referenced by party_help(), and user_load().

{
  if (!node || !node->text) return(def);
  else return(node->text);
}

void xml_node_unlink

(

xml_node_t *

node

)

Unlinks a XML node from a tree.

Removes a node from a tree. Unlinks the node from its parent and siblings, but all nodes descending from this one will still be attached.

Parameters:

node

The node to unlink.

Definition at line 98 of file xml.c.

References xml_node::children, xml_node::last_child, xml_node::nchildren, xml_node::next, xml_node::next_sibling, NULL, xml_node::parent, xml_node::prev, and xml_node::prev_sibling.

Referenced by append_setting(), channel_load(), channel_save(), help_lookup_entry(), unlink_walker(), and xml_node_delete_callbacked().

{
  xml_node_t *parent = node->parent;

  /* Unlink from parent. */
  if (parent) {
    parent->nchildren--;
    if (parent->children == node) parent->children = node->next;
    if (parent->last_child == node) parent->last_child = node->prev;

    node->parent = NULL;
  }

  /* Unlink from node list. */
  if (node->prev) node->prev->next = node->next;
  if (node->next) node->next->prev = node->prev;

  /* Unlink from sibling list. */
  if (node->prev_sibling) node->prev_sibling->next_sibling = node->next_sibling;
  if (node->next_sibling) node->next_sibling->prev_sibling = node->prev_sibling;
}

xml_node_t* xml_node_vlookup	(	xml_node_t *	root,
		va_list	args,
		int	create
	)

Definition at line 180 of file xml.c.

References xml_node_path_lookup().

Referenced by channel_get(), channel_get_int(), channel_get_node(), channel_set(), config_exists(), config_get_int(), config_get_str(), config_link_table(), config_lookup_section(), config_set_int(), config_set_str(), config_unlink_table(), config_update_table(), xml_node_get_int(), xml_node_get_str(), xml_node_lookup(), xml_node_set_int(), and xml_node_set_str().

{
  char *path;
  int index;

  for (; root;) {
    path = va_arg(args, char *);
    if (!path) break;
    index = va_arg(args, int);
    root = xml_node_path_lookup(root, path, index, create);
  }
  return(root);
}

xml_node_t* xml_root_element

(

xml_node_t *

node

)

Definition at line 475 of file xml.c.

References xml_node::children, xml_node::next, NULL, xml_node::parent, xml_node::type, and XML_ELEMENT.

Referenced by xml_parse_file().

{
   if (node == NULL) return NULL;

   /* Zoom up to the document. */
   while (node && node->parent) node = node->parent;

   /* Find first element. */
   node = node->children;
   while (node && node->type != XML_ELEMENT) node = node->next;
   return node;
}

void xml_set_error

(

const char *

err

)

Definition at line 33 of file xml.c.

References last_error, and str_redup().

Referenced by xml_parse_file(), xml_parse_node(), xml_save_file(), and xml_write_node().

{
  str_redup(&last_error, err);
}

---

Variable Documentation

char* last_error = NULL [static]

Definition at line 26 of file xml.c.

Referenced by xml_last_error(), and xml_set_error().

const char rcsid[] = "$Id: xml.c,v 1.27 2007-08-19 19:49:17 sven Exp $" [static]

Definition at line 21 of file xml.c.