<?php
/**
 * Implementation of the Kolab XML format.
 *
 * $Horde: framework/Kolab_Format/lib/Horde/Kolab/Format/XML.php,v 1.5.2.9 2008/11/07 12:53:03 wrobel Exp $
 *
 * @package Kolab_Format
 */

/** We need the DOM library for XML access. */
require_once 'Horde/DOM.php';

/** We need the String library for string conversions. */
require_once 'Horde/String.php';

/** We need the NLS library for language support. */
require_once 'Horde/NLS.php';

/** Kolab date handling functions. */
require_once 'Horde/Kolab/Format/Date.php';

/**
 * Defines a XML value that should get a default value if missing
 */
define('HORDE_KOLAB_XML_PRODUCT_ID', 'Horde::Kolab');

/**
 * Defines a XML value that should get a default value if missing
 */
define('HORDE_KOLAB_XML_VALUE_DEFAULT', 0);

/**
 * Defines a XML value that may be missing
 */
define('HORDE_KOLAB_XML_VALUE_MAYBE_MISSING', 1);

/**
 * Defines a XML value that may not be missing
 */
define('HORDE_KOLAB_XML_VALUE_NOT_EMPTY', 2);

/**
 * Defines a XML value that will be calculated by its own function
 */
define('HORDE_KOLAB_XML_VALUE_CALCULATED', 3);

/**
 * Defines a XML value as string type
 */
define('HORDE_KOLAB_XML_TYPE_STRING', 0);

/**
 * Defines a XML value as integer type
 */
define('HORDE_KOLAB_XML_TYPE_INTEGER', 1);

/**
 * Defines a XML value as boolean type
 */
define('HORDE_KOLAB_XML_TYPE_BOOLEAN', 2);

/**
 * Defines a XML value as date type
 */
define('HORDE_KOLAB_XML_TYPE_DATE', 3);

/**
 * Defines a XML value as datetime type
 */
define('HORDE_KOLAB_XML_TYPE_DATETIME', 4);

/**
 * Defines a XML value as date or datetime type
 */
define('HORDE_KOLAB_XML_TYPE_DATE_OR_DATETIME', 5);

/**
 * Defines a XML value as color type
 */
define('HORDE_KOLAB_XML_TYPE_COLOR', 6);

/**
 * Defines a XML value as composite value type
 */
define('HORDE_KOLAB_XML_TYPE_COMPOSITE', 7);

/**
 * Defines a XML value as array type
 */
define('HORDE_KOLAB_XML_TYPE_MULTIPLE', 8);

/**
 * Kolab XML to array hash converter.
 *
 * For implementing a new format type you will have to inherit this
 * class and provide a _load/_save function.
 *
 * $Horde: framework/Kolab_Format/lib/Horde/Kolab/Format/XML.php,v 1.5.2.9 2008/11/07 12:53:03 wrobel Exp $
 *
 * Copyright 2007-2008 The Horde Project (http://www.horde.org/)
 *
 * See the enclosed file COPYING for license information (LGPL). If you
 * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
 *
 * @since   Horde 3.2
 * @author  Thomas Jarosch <thomas.jarosch@intra2net.com>
 * @author  Gunnar Wrobel <wrobel@pardus.de>
 * @package Kolab_Format
 */
class Horde_Kolab_Format_XML
{
    /**
     * Requested version of the data array to return
     *
     * @var int
     */
    var $_version = 1;

    /**
     * The name of the resulting document.
     *
     * @var string
     */
    var $_name = 'kolab.xml';

    /**
     * The XML document this driver works with.
     *
     * @var Horde_DOM_Document
     */
        var $_xmldoc = null;

    /**
     * The name of the root element.
     *
     * @var string
     */
    var $_root_name = 'kolab';

    /**
     * Kolab format version of the root element.
     *
     * @var string
     */
    var $_root_version = '1.0';

    /**
     * Basic fields in any Kolab object
     *
     * @var array
     */
    var $_fields_basic;

    /**
     * Automatically create categories if they are missing?
     *
     * @var boolean
     */
    var $_create_categories = true;

    /**
     * Fields for a simple person
     *
     * @var array
     */
    var $_fields_simple_person = array(
        'type'    => HORDE_KOLAB_XML_TYPE_COMPOSITE,
        'value'   => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
        'array'   => array(
            'display-name' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                'default' => '',
            ),
            'smtp-address' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                'default' => '',
            ),
            'uid' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                'default' => '',
            ),
        ),
    );

    /**
     * Fields for an attendee
     *
     * @var array
     */
    var $_fields_attendee = array(
        'type'    => HORDE_KOLAB_XML_TYPE_MULTIPLE,
        'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
        'default' => array(),
        'array'   => array(
            'type'    => HORDE_KOLAB_XML_TYPE_COMPOSITE,
            'value'   => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
            'array'   => array(
                'display-name' => array(
                    'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                    'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                    'default' => '',
                ),
                'smtp-address' => array(
                    'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                    'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                    'default' => '',
                ),
                'status' => array(
                    'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                    'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                    'default' => 'none',
                ),
                'request-response' => array(
                    'type'    => HORDE_KOLAB_XML_TYPE_BOOLEAN,
                    'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                    'default' => true,
                ),
                'role' => array(
                    'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                    'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                    'default' => 'required',
                ),
            ),
        ),
    );

    /**
     * Fields for a recurrence
     *
     * @var array
     */
    var $_fields_recurrence = array(
        // Attribute on root node: cycle
        // Attribute on root node: type
        'interval' => array(
            'type'    => HORDE_KOLAB_XML_TYPE_INTEGER,
            'value'   => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
        ),
        'day' => array(
            'type'    => HORDE_KOLAB_XML_TYPE_MULTIPLE,
            'value'   => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
            'array'   => array(
                'type' => HORDE_KOLAB_XML_TYPE_STRING,
                'value' => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
            ),
        ),
        'daynumber' => array(
            'type'    => HORDE_KOLAB_XML_TYPE_INTEGER,
            'value'   => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
        ),
        'month' => array(
            'type'    => HORDE_KOLAB_XML_TYPE_STRING,
            'value'   => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
        ),
        // Attribute on range: type
        'range' => array(
            'type'    => HORDE_KOLAB_XML_TYPE_STRING,
            'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
            'default' => '',
        ),
        'exclusion' => array(
            'type'    => HORDE_KOLAB_XML_TYPE_MULTIPLE,
            'value'   => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
            'array'   => array(
                'type' => HORDE_KOLAB_XML_TYPE_STRING,
                'value' => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
            ),
        ),
        'complete' => array(
            'type'    => HORDE_KOLAB_XML_TYPE_MULTIPLE,
            'value'   => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
            'array'   => array(
                'type' => HORDE_KOLAB_XML_TYPE_STRING,
                'value' => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
            ),
        ),
    );

   /**
     * Constructor
     *
     * @param array       $params        Any additional options
     */
    function Horde_Kolab_Format_XML($params = null)
    {
        if (is_array($params) && isset($params['version'])) {
            $this->_version = $params['version'];
        } else {
            $this->_version = 1;
        }

        /* Generic fields, in kolab format specification order */
        $this->_fields_basic = array(
            'uid' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                'value'   => HORDE_KOLAB_XML_VALUE_NOT_EMPTY,
            ),
            'body' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                'default' => '',
            ),
            'categories' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                'default' => '',
            ),
            'creation-date' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_DATETIME,
                'value'   => HORDE_KOLAB_XML_VALUE_CALCULATED,
                'load'    => 'CreationDate',
                'save'    => 'CreationDate',
            ),
            'last-modification-date' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_DATETIME,
                'value'   => HORDE_KOLAB_XML_VALUE_CALCULATED,
                'load'    => 'ModificationDate',
                'save'    => 'ModificationDate',
            ),
            'sensitivity' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                'value'   => HORDE_KOLAB_XML_VALUE_DEFAULT,
                'default' => 'public',
            ),
            'inline-attachment' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_MULTIPLE,
                'value'   => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
                'array'   => array(
                    'type'  => HORDE_KOLAB_XML_TYPE_STRING,
                    'value' => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
                ),
            ),
            'link-attachment' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_MULTIPLE,
                'value'   => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
                'array'   => array(
                    'type'  => HORDE_KOLAB_XML_TYPE_STRING,
                    'value' => HORDE_KOLAB_XML_VALUE_MAYBE_MISSING,
                ),
            ),
            'product-id' => array(
                'type'    => HORDE_KOLAB_XML_TYPE_STRING,
                'value'   => HORDE_KOLAB_XML_VALUE_CALCULATED,
                'load'    => 'ProductId',
                'save'    => 'ProductId',
            ),
        );
    }

    /**
     * Attempts to return a concrete Horde_Kolab_Format_XML instance.
     * based on $object_type.
     *
     * @param string    $object_type    The object type that should be handled.
     * @param array     $params         Any additional parameters.
     *
     * @return Horde_Kolab_Format_XML|PEAR_Error The newly created concrete
     *                                           Horde_Kolab_Format_XML
     *                                           instance.
     */
    function &factory($object_type = '', $params = null)
    {
        $object_type = str_replace('-', '', $object_type);
        @include_once dirname(__FILE__) . '/XML/' . $object_type . '.php';
        $class = 'Horde_Kolab_Format_XML_' . $object_type;

        if (class_exists($class)) {
            $driver = &new $class($params);
        } else {
            return PEAR::raiseError(sprintf(_("Failed to load Kolab XML driver %s"), $object_type));
        }

        return $driver;
    }

    /**
     * Return the name of the resulting document.
     *
     * @return string The name that may be used as filename.
     */
    function getName()
    {
        return $this->_name;
    }

    /**
     * Return the mime type of the resulting document.
     *
     * @return string The mime type of the result.
     */
    function getMimeType()
    {
        return 'application/x-vnd.kolab.' . $this->_root_name;
    }

    /**
     * Return the disposition of the resulting document.
     *
     * @return string The disportion of this document.
     */
    function getDisposition()
    {
        return 'attachment';
    }

    /**
     * Load an object based on the given XML string.
     *
     * @param string $xmltext  The XML of the message as string.
     *
     * @return array|PEAR_Error The data array representing the object.
     */
    function load(&$xmltext)
    {
        $noderoot = $this->_parseXml($xmltext);
        if ($noderoot === false) {
            return false;
        }

        if (!$noderoot->has_child_nodes()) {
            return PEAR::raiseError(_("No or unreadable content in Kolab XML object"));
        }

        $children = $noderoot->child_nodes();

        // fresh object data
        $object = array();

        $result = $this->_loadArray($children, $this->_fields_basic);
        if (is_a($result, 'PEAR_Error')) {
            return $result;
        }
        $object = array_merge($object, $result);
        $this->_loadMultipleCategories($object);

        $result = $this->_load($children);
        if (is_a($result, 'PEAR_Error')) {
            return $result;
        }
        $object = array_merge($object, $result);

        // uid is vital
        if (!isset($object['uid'])) {
            return PEAR::raiseError(_("UID not found in Kolab XML object"));
        }

        return $object;
    }

    /**
     * Load the groupware object based on the specifc XML values.
     *
     * @access protected
     *
     * @param array $children An array of XML nodes.
     *
     * @return array|PEAR_Error The data array representing the object.
     *
     */
    function _load(&$children)
    {
        if (!empty($this->_fields_specific)) {
            return $this->_loadArray($children, $this->_fields_specific);
        } else {
            return array();
        }
    }

    /**
     * Load an array with data from the XML nodes.
     *
     * @access private
     *
     * @param array $object   The resulting data array.
     * @param array $children An array of XML nodes.
     * @param array $fields   The fields to populate in the object array.
     *
     * @return boolean|PEAR_Error True on success.
     */
    function _loadArray(&$children, $fields)
    {
        $object = array();

        // basic fields below the root node
        foreach($fields as $field => $params) {
            $result = $this->_getXmlData($children, $field, $params);
            if (is_a($result, 'PEAR_Error')) {
                return $result;
            }
            if (isset($result)) {
                $object[$field] = $result;
            }
        }
        return $object;
    }

    /**
     * Get the text content of the named data node among the specified
     * children.
     *
     * @access private
     *
     * @param array  $children     The children to search.
     * @param string $name         The name of the node to return.
     * @param array  $params       Parameters for the data conversion.
     *
     * @return string|PEAR_Error The content of the specified node or an empty
     *                           string.
     */
    function _getXmlData($children, $name, $params)
    {
        $value = null;
        $missing = false;

        // identify the child node
        $child = $this->_findNode($children, $name);

        // Handle empty values
        if (!$child) {
            if ($params['value'] == HORDE_KOLAB_XML_VALUE_MAYBE_MISSING) {
                // 'MAYBE_MISSING' means we should return null
                return null;
            } elseif ($params['value'] == HORDE_KOLAB_XML_VALUE_NOT_EMPTY) {
                // May not be empty. Return an error
                return PEAR::raiseError(sprintf(_("Data value for %s is empty in Kolab XML object!"), $name));
            } elseif ($params['value'] == HORDE_KOLAB_XML_VALUE_DEFAULT) {
                // Return the default
                return $params['default'];
            } elseif ($params['value'] == HORDE_KOLAB_XML_VALUE_CALCULATED) {
                $missing = true;
            }
        }

        // Do we need to calculate the value?
        if ($params['value'] == HORDE_KOLAB_XML_VALUE_CALCULATED && isset($params['load'])) {
            if (method_exists($this, '_load' . $params['load'])) {
                $value = call_user_func(array($this, '_load' . $params['load']),
                                        $child, $missing);
            } else {
                return PEAR::raiseError(sprintf("Kolab XML: Missing function %s!", $params['load']));
            }
        } elseif ($params['type'] == HORDE_KOLAB_XML_TYPE_COMPOSITE) {
            return $this->_loadArray($child->child_nodes(), $params['array']);
        } elseif ($params['type'] == HORDE_KOLAB_XML_TYPE_MULTIPLE) {
            $result = array();
            foreach($children as $child) {
                if ($child->type == XML_ELEMENT_NODE && $child->tagname == $name) {
                    $value = $this->_getXmlData(array($child), $name, $params['array']);
                    if (is_a($value, 'PEAR_Error')) {
                        return $value;
                    }
                    $result[] = $value;
                }
            }
            return $result;
        } else {
            return $this->_loadDefault($child, $params);
        }

        // Nothing specified. Return the value as it is.
        return $value;
    }

    /**
     * Parse the XML string. The root node is returned on success.
     *
     * @access private
     *
     * @param string $xmltext  The XML of the message as string.
     *
     * @return Horde_DOM_Node|PEAR_Error  The root node of the document.
     */
    function _parseXml(&$xmltext)
    {
        $params = array(
            'xml' => $xmltext,
            'options' => HORDE_DOM_LOAD_REMOVE_BLANKS,
        );

        $result = Horde_DOM_Document::factory($params);
        if (is_a($result, 'PEAR_Error')) {
            return $result;
        }
        $this->_xmldoc = $result;
        return $this->_xmldoc->document_element();
    }

    /**
     * Convert the data to a XML string.
     *
     * @param array $attributes  The data array representing the note.
     *
     * @return string|PEAR_Error The data as XML string.
     */
    function save($object)
    {
        $root = $this->_prepareSave();

        $this->_saveMultipleCategories($object);
        $result = $this->_saveArray($root, $object, $this->_fields_basic);
        if (is_a($result, 'PEAR_Error')) {
            return $result;
        }

        $result = $this->_save($root, $object);
        if (is_a($result, 'PEAR_Error')) {
            return $result;
        }

        return $this->_xmldoc->dump_mem(true);
    }

    /**
     * Save the specific XML values.
     *
     * @access protected
     *
     * @param array $root     The XML document root.
     * @param array $object   The resulting data array.
     *
     * @return boolean|PEAR_Error True on success.
     */
    function _save($root, $object)
    {
        if (!empty($this->_fields_specific)) {
            $result = $this->_saveArray($root, $object, $this->_fields_specific);
            if (is_a($result, 'PEAR_Error')) {
                return $result;
            }
        }
        return true;
    }

    /**
     * Creates a new XML document if necessary.
     *
     * @access private
     *
     * @param string $xmltext  The XML of the message as string.
     *
     * @return Horde_DOM_Node The root node of the document.
     */
    function _prepareSave()
    {
        if ($this->_xmldoc != null) {
            $root = $this->_xmldoc->document_element();
        } else {
            // create new XML
            $this->_xmldoc = Horde_DOM_Document::factory();
            $root = $this->_xmldoc->create_element($this->_root_name);
            $root = $this->_xmldoc->append_child($root);
            $root->set_attribute("version", $this->_root_version);
        }

        return $root;
    }

    /**
     * Save a data array to XML nodes.
     *
     * @access private
     *
     * @param array   $root     The XML document root.
     * @param array   $object   The data array.
     * @param array   $fields   The fields to write into the XML object.
     * @param boolean $append   Should the nodes be appended?
     *
     * @return boolean|PEAR_Error True on success.
     */
    function _saveArray($root, $object, $fields, $append = false)
    {
        // basic fields below the root node
        foreach($fields as $field => $params) {
            $result = $this->_updateNode($root, $object, $field, $params, $append);
            if (is_a($result, 'PEAR_Error')) {
                return $result;
            }
        }
        return true;
    }

    /**
     * Update the specified node.
     *
     * @access private
     *
     * @param Horde_DOM_Node $parent_node  The parent node of the node that
     *                                     should be updated.
     * @param array          $attributes   The data array that holds all
     *                                     attribute values.
     * @param string         $name         The name of the the attribute
     *                                     to be updated.
     * @param array          $params       Parameters for saving the node
     * @param boolean        $append       Should the node be appended?
     *
     * @return Horde_DOM_Node|PEAR_Error The new/updated child node.
     */
    function _updateNode($parent_node, $attributes, $name, $params, $append = false)
    {
        $value = null;
        $missing = false;

        // Handle empty values
        if (!isset($attributes[$name])) {
            // Do we have information if this may be empty?
            if ($params['value'] == HORDE_KOLAB_XML_VALUE_DEFAULT) {
                // Use the default
                $value = $params['default'];
            } elseif ($params['value'] == HORDE_KOLAB_XML_VALUE_NOT_EMPTY) {
                // May not be empty. Return an error
                return PEAR::raiseError(sprintf(_("Data value for %s is empty in Kolab XML object!"), $name));
            } elseif ($params['value'] == HORDE_KOLAB_XML_VALUE_MAYBE_MISSING) {
                /**
                 * 'MAYBE_MISSING' means we should not create an XML
                 * node here
                 */
                $this->_removeNodes($parent_node, $name);
                return false;
            } elseif ($params['value'] == HORDE_KOLAB_XML_VALUE_CALCULATED) {
                $missing = true;
            }
        } else {
            $value = $attributes[$name];
        }

        if ($params['value'] == HORDE_KOLAB_XML_VALUE_CALCULATED) {
            // Calculate the value
            if (method_exists($this, '_save' . $params['save'])) {
                return call_user_func(array($this, '_save' . $params['save']),
                                      $parent_node, $name, $value, $missing);
            } else {
                return PEAR::raiseError(sprintf("Kolab XML: Missing function %s!", $params['save']));
            }
        } elseif ($params['type'] == HORDE_KOLAB_XML_TYPE_COMPOSITE) {
            // Possibly remove the old node first
            if (!$append) {
                $this->_removeNodes($parent_node, $name);
            }

            // Create a new complex node
            $composite_node = $this->_xmldoc->create_element($name);
            $composite_node = $parent_node->append_child($composite_node);
            return $this->_saveArray($composite_node, $value, $params['array']);
        } elseif ($params['type'] == HORDE_KOLAB_XML_TYPE_MULTIPLE) {
            // Remove the old nodes first
            $this->_removeNodes($parent_node, $name);

            // Add the new nodes
            foreach($value as $add_node) {
                $result = $this->_saveArray($parent_node,
                                           array($name => $add_node),
                                           array($name => $params['array']),
                                           true);
                if (is_a($result, 'PEAR_Error')) {
                    return $result;
                }
            }
            return true;
        } else {
            return $this->_saveDefault($parent_node, $name, $value, $params, $append);
        }
    }

    /**
     * Create a text node.
     *
     * @access private
     *
     * @param Horde_DOM_Node  $parent   The parent of the new node.
     * @param string          $name     The name of the child node to create.
     * @param string          $value    The value of the child node to create.
     *
     * @return Horde_DOM_Node The new node.
     */
    function _createTextNode($parent, $name, $value)
    {
        $value = String::convertCharset($value, NLS::getCharset(), 'utf-8');

        $node = $this->_xmldoc->create_element($name);

        $node = $parent->append_child($node);

        // content
        $text = $this->_xmldoc->create_text_node($value);
        $text = $node->append_child($text);

        return $node;
    }

    /**
     * Return the named node among a list of nodes.
     *
     * @access private
     *
     * @param array  $nodes  The list of nodes.
     * @param string $name   The name of the node to return.
     *
     * @return mixed The named Horde_DOM_Node or false if no node was found.
     */
    function _findNode($nodes, $name)
    {
        foreach($nodes as $node)
            if ($node->type == XML_ELEMENT_NODE && $node->tagname == $name) {
                return $node;
            }

        return false;
    }

    /**
     * Retrieve a named child from a named parent if it has the given
     * value.
     *
     * @access private
     *
     * @param array  $nodes       The list of nodes.
     * @param string $parent_name The name of the parent node.
     * @param string $child_name  The name of the child node.
     * @param string $value       The value of the child node
     *
     * @return mixed The specified Horde_DOM_Node or false if no node was found.
     */
    function _findNodeByChildData($nodes, $parent_name, $child_name, $value)
    {
        foreach($nodes as $node)
        {
            if ($node->type == XML_ELEMENT_NODE && $node->tagname == $parent_name) {
                $children = $node->child_nodes();
                foreach($children as $child)
                    if ($child->type == XML_ELEMENT_NODE && $child->tagname == $child_name && $child->get_content() == $value) {
                        return $node;
                    }
            }
        }

        return false;
    }

    /**
     * Retrieve the content of a Horde_DOM_Node.
     *
     * @access private
     *
     * @param Horde_DOM_Node  $nodes  The node that should be read.
     *
     * @return string|PEAR_Error The content of the node.
     */
    function _getNodeContent($node)
    {
        $value = String::convertCharset($node->get_content(), 'utf-8');
        if (is_a($value, 'PEAR_Error')) {
            return $value;
        }
        return $value;
    }


    /**
     * Create a new named node on a parent node.
     *
     * @access private
     *
     * @param Horde_DOM_Node $parent  The parent node.
     * @param string         $name    The name of the new child node.
     *
     * @return Horde_DOM_Node The new child node.
     */
    function _createChildNode($parent, $name)
    {
        $node = $this->_xmldoc->createElement($name);
        $node = $parent->appendChild($node);

        return $node;
    }

    /**
     * Remove named nodes from a parent node.
     *
     * @access private
     *
     * @param Horde_DOM_Node $parent  The parent node.
     * @param string         $name    The name of the children to be removed.
     */
    function _removeNodes($parent_node, $name)
    {
        while ($old_node = $this->_findNode($parent_node->child_nodes(), $name)) {
            $parent_node->remove_child($old_node);
        }
    }

    /**
     * Create a new named node on a parent node if it is not already
     * present in the given children.
     *
     * @access private
     *
     * @param Horde_DOM_Node $parent    The parent node.
     * @param array          $children  The children that might already
     *                                  contain the node.
     * @param string         $name      The name of the new child node.
     *
     * @return Horde_DOM_Node The new or already existing child node.
     */
    function _createOrFindChildNode($parent, $children, $name)
    {
        // look for existing node
        $old_node = $this->_findNode($children, $name);
        if ($old_node !== false) {
            return $old_node;
        }

        // create new parent node
        return $this->_createChildNode($parent, $name);
    }

    /**
     * Load the different XML types.
     *
     * @access private
     *
     * @param string $node    The node to load the data from
     * @param array  $params  Parameters for loading the value
     *
     * @return string|PEAR_Error The loaded value.
     */
    function _loadDefault($node, $params)
    {
        $content = $this->_getNodeContent($node);
        if (is_a($content, 'PEAR_Error')) {
            return $content;
        }

        switch($params['type']) {
        case HORDE_KOLAB_XML_TYPE_DATE:
            return Horde_Kolab_Format_Date::decodeDate($content);

        case HORDE_KOLAB_XML_TYPE_DATETIME:
            return Horde_Kolab_Format_Date::decodeDateTime($content);

        case HORDE_KOLAB_XML_TYPE_DATE_OR_DATETIME:
            return Horde_Kolab_Format_Date::decodeDateOrDateTime($content);

        case HORDE_KOLAB_XML_TYPE_INTEGER:
            return (int) $content;

        case HORDE_KOLAB_XML_TYPE_BOOLEAN:
            return (bool) $content;

        default:
            // Strings and colors are returned as they are
            return $content;
        }
    }

    /**
     * Save a data array as a XML node attached to the given parent node.
     *
     * @access private
     *
     * @param Horde_DOM_Node $parent_node The parent node to attach
     *                                    the child to
     * @param string         $name        The name of the node
     * @param mixed          $value       The value to store
     * @param boolean        $missing     Has the value been missing?
     * @param boolean        $append      Should the node be appended?
     *
     * @return Horde_DOM_Node The new child node.
     */
    function _saveDefault($parent_node, $name, $value, $params, $append = false)
    {
        if (!$append) {
            $this->_removeNodes($parent_node, $name);
        }

        switch ($params['type']) {
        case HORDE_KOLAB_XML_TYPE_DATE:
            $value = Horde_Kolab_Format_Date::encodeDate($value);
            break;

        case HORDE_KOLAB_XML_TYPE_DATETIME:
        case HORDE_KOLAB_XML_TYPE_DATE_OR_DATETIME:
            $value = Horde_Kolab_Format_Date::encodeDateTime($value);
            break;

        case HORDE_KOLAB_XML_TYPE_INTEGER:
            $value = (string) $value;
            break;

        case HORDE_KOLAB_XML_TYPE_BOOLEAN:
            if ($value) {
                $value = 'true';
            } else {
                $value = 'false';
            }

            break;
        }

        // create the node
        return $this->_createTextNode($parent_node, $name, $value);
    }

    /**
     * Handle loading of categories. Preserve multiple categories in a hidden
     * object field. Optionally creates categories unknown to the Horde user.
     *
     * @access private
     *
     * @param array  $object Array of strings, containing the 'categories' field.
     */
    function _loadMultipleCategories(&$object)
    {
        global $prefs;

        if (empty($object['categories'])) {
            return;
        }

        // Create horde category if needed
        @include_once 'Horde/Prefs/CategoryManager.php';
        if ($this->_create_categories
            && class_exists('Prefs_CategoryManager')
            && isset($prefs) && is_a($prefs, 'Prefs')) {
            $cManager = new Prefs_CategoryManager();
            $horde_categories = $cManager->get();
        } else {
            $cManager = null;
            $horde_categories = null;
        }

        $kolab_categories = explode (',', $object['categories']);

        $primary_category = '';
        foreach ($kolab_categories as $kolab_category) {
            $kolab_category = trim($kolab_category);

            $valid_category = true;
            if ($cManager && 
                array_search($kolab_category, $horde_categories) === false) {
                // Unknown category -> Add
                if ($cManager->add($kolab_category) === false) {
                    // categories might be locked
                    $valid_category = false;
                }
            }

            // First valid category becomes primary category
            if ($valid_category && empty($primary_category)) {
                $primary_category = $kolab_category;
            }
        }

        // Backup multiple categories
        if (count($kolab_categories) > 1) {
            $object['_categories_all'] = $object['categories'];
            $object['_categories_primary'] = $primary_category;
        }
        // Make default category visible to Horde
        $object['categories'] = $primary_category;
    }

    /**
     * Preserve multiple categories on save if "categories" didn't change.
     * The name "categories" currently refers to one primary category.
     *
     * @access private
     *
     * @param array  $object Array of strings, containing the 'categories' field.
     */
    function _saveMultipleCategories(&$object)
    {
        // Check for multiple categories.
        if (!isset($object['_categories_all']) || !isset($object['_categories_primary'])
            || !isset($object['categories']))
        {
            return;
        }

        // Preserve multiple categories if "categories" didn't change
        if ($object['_categories_primary'] == $object['categories']) {
            $object['categories'] = $object['_categories_all'];
        }
    }

    /**
     * Load the object creation date.
     *
     * @access private
     *
     * @param Horde_DOM_Node  $node    The original node if set.
     * @param boolean         $missing Has the node been missing?
     *
     * @return string|PEAR_Error The creation date.
     */
    function _loadCreationDate($node, $missing)
    {
        if ($missing) {
            // Be gentle and accept a missing creation date.
            return time();
        }
        return $this->_loadDefault($node,
                                   array('type' => HORDE_KOLAB_XML_TYPE_DATETIME));
    }

    /**
     * Save the object creation date.
     *
     * @access private
     *
     * @param Horde_DOM_Node $parent_node The parent node to attach the child
     *                                    to.
     * @param string         $name        The name of the node.
     * @param mixed          $value       The value to store.
     * @param boolean        $missing     Has the value been missing?
     *
     * @return Horde_DOM_Node The new child node.
     */
    function _saveCreationDate($parent_node, $name, $value, $missing)
    {
        // Only create the creation date if it has not been set before
        if ($missing) {
            $value = time();
        }
        return $this->_saveDefault($parent_node,
                                   $name,
                                   $value,
                                   array('type' => HORDE_KOLAB_XML_TYPE_DATETIME));
    }

    /**
     * Load the object modification date.
     *
     * @access private
     *
     * @param Horde_DOM_Node  $node    The original node if set.
     * @param boolean         $missing Has the node been missing?
     *
     * @return string The last modification date.
     */
    function _loadModificationDate($node, $missing)
    {
        if ($missing) {
            // Be gentle and accept a missing modification date.
            return time();
        }
        return $this->_loadDefault($node,
                                   array('type' => HORDE_KOLAB_XML_TYPE_DATETIME));
    }

    /**
     * Save the object modification date.
     *
     * @access private
     *
     * @param Horde_DOM_Node $parent_node The parent node to attach
     *                                    the child to.
     * @param string         $name        The name of the node.
     * @param mixed          $value       The value to store.
     * @param boolean        $missing     Has the value been missing?
     *
     * @return Horde_DOM_Node The new child node.
     */
    function _saveModificationDate($parent_node, $name, $value, $missing)
    {
        // Always store now as modification date
        return $this->_saveDefault($parent_node,
                                   $name,
                                   time(),
                                   array('type' => HORDE_KOLAB_XML_TYPE_DATETIME));
    }

    /**
     * Load the name of the last client that modified this object
     *
     * @access private
     *
     * @param Horde_DOM_Node  $node    The original node if set.
     * @param boolean         $missing Has the node been missing?
     *
     * @return string The last modification date.
     */
    function _loadProductId($node, $missing)
    {
        if ($missing) {
            // Be gentle and accept a missing product id
            return '';
        }
        return $this->_getNodeContent($node);
    }

    /**
     * Save the name of the last client that modified this object.
     *
     * @access private
     *
     * @param Horde_DOM_Node $parent_node The parent node to attach
     *                                    the child to.
     * @param string         $name        The name of the node.
     * @param mixed          $value       The value to store.
     * @param boolean        $missing     Has the value been missing?
     *
     * @return Horde_DOM_Node The new child node.
     */
    function _saveProductId($parent_node, $name, $value, $missing)
    {
        // Always store now as modification date
        return $this->_saveDefault($parent_node,
                                   $name,
                                   HORDE_KOLAB_XML_PRODUCT_ID,
                                   array('type' => HORDE_KOLAB_XML_TYPE_STRING));
    }

    /**
     * Load recurrence information.
     *
     * @access private
     *
     * @param Horde_DOM_Node  $node    The original node if set.
     * @param boolean         $missing Has the node been missing?
     *
     * @return array|PEAR_Error The recurrence information.
     */
    function _loadRecurrence($node, $missing)
    {
        if ($missing) {
            return null;
        }

        // Collect all child nodes
        $children = $node->child_nodes();

        $recurrence = $this->_loadArray($children, $this->_fields_recurrence);

        // Get the cycle type (must be present)
        $recurrence['cycle'] = $node->get_attribute('cycle');
        // Get the sub type (may be present)
        $recurrence['type']  = $node->get_attribute('type');

        // Exclusions.
        if (isset($recurrence['exclusion'])) {
            $exceptions = array();
            foreach($recurrence['exclusion'] as $exclusion) {
                if (!empty($exclusion)) {
                    list($year, $month, $mday) = sscanf($exclusion, '%04d-%02d-%02d');
                    $exceptions[] = sprintf('%04d%02d%02d', $year, $month, $mday);
                }
            }
            $recurrence['exceptions'] = $exceptions;
        }

        // Completed dates.
        if (isset($recurrence['complete'])) {
            $completions = array();
            foreach($recurrence['complete'] as $complete) {
                if (!empty($complete)) {
                    list($year, $month, $mday) = sscanf($complete, '%04d-%02d-%02d');
                    $completions[] = sprintf('%04d%02d%02d', $year, $month, $mday);
                }
            }
            $recurrence['completions'] = $completions;
        }

        // Range is special
        foreach($children as $child) {
            if ($child->tagname == "range") {
                $recurrence['range-type'] = $child->get_attribute('type');
            }
        }

        if (isset($recurrence['range']) && isset($recurrence['range-type'])
            && $recurrence['range-type'] == 'date') {
            $recurrence['range'] = Horde_Kolab_Format_Date::decodeDate($recurrence['range']);
        }

        // Sanity check
        $valid = $this->_validateRecurrence($recurrence);
        if (is_a($valid, 'PEAR_Error')) {
            return $valid;
        }

        return $recurrence;
    }

    /**
     * Validate recurrence hash information.
     *
     * @access private
     *
     * @param array  $recurrence  Recurrence hash loaded from XML.
     *
     * @return boolean|PEAR_Error True on success.
     */
    function _validateRecurrence(&$recurrence)
    {
        if (!isset($recurrence['cycle'])) {
              return PEAR::raiseError('recurrence tag error: cycle attribute missing');
        }

        if (!isset($recurrence['interval'])) {
              return PEAR::raiseError('recurrence tag error: interval tag missing');
        }
        $interval = $recurrence['interval'];
        if ($interval < 0) {
            return PEAR::raiseError('recurrence tag error: interval cannot be below zero: ' . $interval);
        }

        if ($recurrence['cycle'] == 'weekly') {
            // Check for <day>
            if (!isset($recurrence['day']) || count($recurrence['day']) == 0) {
                return PEAR::raiseError('recurrence tag error: day tag missing for weekly recurrence');
            }
        }

        // The code below is only for monthly or yearly recurrences
        if ($recurrence['cycle'] != 'monthly' && $recurrence['cycle'] != 'yearly')
            return true;

        if (!isset($recurrence['type'])) {
            return PEAR::raiseError('recurrence tag error: type attribute missing');
        }

        if (!isset($recurrence['daynumber'])) {
            return PEAR::raiseError('recurrence tag error: daynumber tag missing');
        }
        $daynumber = $recurrence['daynumber'];
        if ($daynumber < 0) {
            return PEAR::raiseError('recurrence tag error: daynumber cannot be below zero: ' . $daynumber);
        }

        if ($recurrence['type'] == 'daynumber') {
            if ($recurrence['cycle'] == 'yearly' && $daynumber > 366) {
                return PEAR::raiseError('recurrence tag error: daynumber cannot be larger than 366 for yearly recurrences: ' . $daynumber);
            } else if ($recurrence['cycle'] == 'monthly' && $daynumber > 31) {
                return PEAR::raiseError('recurrence tag error: daynumber cannot be larger than 31 for monthly recurrences: ' . $daynumber);
            }
        } else if ($recurrence['type'] == 'weekday') {
            // daynumber is the week of the month
            if ($daynumber > 5) {
                return PEAR::raiseError('recurrence tag error: daynumber cannot be larger than 5 for type weekday: ' . $daynumber);
            }

            // Check for <day>
            if (!isset($recurrence['day']) || count($recurrence['day']) == 0) {
                return PEAR::raiseError('recurrence tag error: day tag missing for type weekday');
            }
        }

        if (($recurrence['type'] == 'monthday' || $recurrence['type'] == 'yearday')
            && $recurrence['cycle'] == 'monthly')
        {
            return PEAR::raiseError('recurrence tag error: type monthday/yearday is only allowed for yearly recurrences');
        }

        if ($recurrence['cycle'] == 'yearly') {
            if ($recurrence['type'] == 'monthday') {
                // daynumber and month
                if (!isset($recurrence['month'])) {
                    return PEAR::raiseError('recurrence tag error: month tag missing for type monthday');
                }
                if ($daynumber > 31) {
                    return PEAR::raiseError('recurrence tag error: daynumber cannot be larger than 31 for type monthday: ' . $daynumber);
                }
            } else if ($recurrence['type'] == 'yearday') {
                if ($daynumber > 366) {
                    return PEAR::raiseError('recurrence tag error: daynumber cannot be larger than 366 for type yearday: ' . $daynumber);
                }
            }
        }

        return true;
    }

    /**
     * Save recurrence information.
     *
     * @access private
     *
     * @param Horde_DOM_Node $parent_node The parent node to attach
     *                                    the child to.
     * @param string         $name        The name of the node.
     * @param mixed          $value       The value to store.
     * @param boolean        $missing     Has the value been missing?
     *
     * @return Horde_DOM_Node The new child node.
     */
    function _saveRecurrence($parent_node, $name, $value, $missing)
    {
        $this->_removeNodes($parent_node, $name);

        if (empty($value)) {
            return false;
        }

        // Exclusions.
        if (isset($value['exceptions'])) {
            $exclusions = array();
            foreach($value['exceptions'] as $exclusion) {
                if (!empty($exclusion)) {
                    list($year, $month, $mday) = sscanf($exclusion, '%04d%02d%02d');
                    $exclusions[] = "$year-$month-$mday";
                }
            }
            $value['exclusion'] = $exclusions;
        }

        // Completed dates.
        if (isset($value['completions'])) {
            $completions = array();
            foreach($value['completions'] as $complete) {
                if (!empty($complete)) {
                    list($year, $month, $mday) = sscanf($complete, '%04d%02d%02d');
                    $completions[] = "$year-$month-$mday";
                }
            }
            $value['complete'] = $completions;
        }

        if (isset($value['range'])
            && isset($value['range-type']) && $value['range-type'] == 'date') {
            $value['range'] = Horde_Kolab_Format_Date::encodeDate($value['range']);
        }

        $r_node = $this->_xmldoc->create_element($name);
        $r_node = $parent_node->append_child($r_node);

        // Save normal fields
        $result = $this->_saveArray($r_node, $value, $this->_fields_recurrence);
        if (is_a($result, 'PEAR_Error')) {
            return $result;
        }

        // Add attributes
        $r_node->set_attribute("cycle", $value['cycle']);
        if (isset($value['type'])) {
            $r_node->set_attribute("type", $value['type']);
        }

        $child = $this->_findNode($r_node->child_nodes(), "range");
        if ($child) {
            $child->set_attribute("type", $value['range-type']);
        }

        return $r_node;
    }
}
