QOF 0.7.5

qsf-xml.h File Reference

Private QSF header - not for use by applications. More...

#include <stdio.h>
#include <stdlib.h>
#include <regex.h>
#include <time.h>
#include "qof.h"
#include <libintl.h>

Go to the source code of this file.

Data Structures

struct  QsfObject_s
 Holds a description of the QofObject. More...
struct  QsfMetadata_s
 QSF Parameters. More...
struct  QsfValidates_s
 Validation metadata. More...
struct  QsfNodeIterate
 One iterator, two typedefs. More...

Defines

#define _(String)   dgettext (GETTEXT_PACKAGE, String)
#define QSF_QOF_VERSION   QOF_OBJECT_VERSION
#define QSF_XSD_TIME   QOF_UTC_DATE_FORMAT
#define QSF_XML_BOOLEAN_TEST   "true"
#define QSF_OBJECT_SCHEMA   "qsf-object.xsd.xml"
#define QSF_MAP_SCHEMA   "qsf-map.xsd.xml"
QSF Object XML
#define QSF_ROOT_TAG   "qof-qsf"
#define QSF_DEFAULT_NS   "http://qof.sourceforge.net/"
#define QSF_DATE_LENGTH   MAX_DATE_LENGTH
#define QSF_BOOK_TAG   "book"
#define QSF_BOOK_GUID   "book-guid"
#define QSF_BOOK_COUNT   "count"
#define QSF_OBJECT_TAG   "object"
#define QSF_OBJECT_TYPE   "type"
#define QSF_OBJECT_COUNT   "count"
#define QSF_XML_VERSION   "1.0"
Representing KVP as XML

<kvp type="kvp" path="/from-sched-xaction" value="guid">c858b9a3235723b55bc1179f0e8c1322</kvp> A kvp type KVP parameter located at $path containing a GUID $value.

The relevance of type="kvp" won't be evident in GnuCash, they all use "kvp".

A non-GnuCash example helps: <kvp type="pilot_addr_kvp" path="/user/name" value="guid">c858b9a3235723b55bc1179f0e8c1322</kvp> A pilot_addr_kvp type KVP parameter located at /user/name containing a guid value.

#define QSF_OBJECT_KVP   "path"
#define QSF_OBJECT_VALUE   "value"
QSF Map XML
#define MAP_ROOT_TAG   "qsf-map"
#define MAP_DEFINITION_TAG   "definition"
#define MAP_DEFINE_TAG   "define"
#define MAP_ITERATE_ATTR   "foreach"
#define MAP_DEFAULT_TAG   "default"
#define MAP_OBJECT_TAG   "object"
#define MAP_CALCULATE_TAG   "calculate"
#define MAP_QOF_VERSION   "qof_version"
#define MAP_NAME_ATTR   "name"
#define MAP_TYPE_ATTR   "type"
#define MAP_VALUE_ATTR   "value"
#define MAP_OBJECT_ATTR   "object"
#define MAP_E_TYPE   "e_type"
#define MAP_ENUM_TYPE   "enum"
#define QSF_BOOLEAN_DEFAULT   "boolean"
 A specific boolean default for this map.
#define QSF_CONDITIONAL   "if"
#define QSF_CONDITIONAL_SET   "set"
#define QSF_CONDITIONAL_ELSE   "else"
#define QSF_OPTION   "option"
#define QSF_FORMATTING_OPTION   "format"

Typedefs

typedef struct QsfObject_s QsfObject
 Holds a description of the QofObject.
typedef struct QsfMetadata_s QsfParam
 QSF Parameters.
typedef struct QsfValidates_s QsfValidator
 Validation metadata.

Enumerations

enum  QsfType {
  QSF_UNDEF = 0, IS_QSF_MAP, IS_QSF_OBJ, HAVE_QSF_MAP,
  OUR_QSF_OBJ
}
enum  QsfStatus {
  QSF_NO_OBJECT = 0, QSF_DEFINED_OBJECT, QSF_REGISTERED_OBJECT, QSF_CALCULATED_OBJECT,
  QSF_INVALID_OBJECT
}
 

Status of various object during mapping.

More...

Functions

gint qsf_compare_tag_strings (const xmlChar *node_name, gchar *tag_name)
 shorthand function
gint qsf_strings_equal (const xmlChar *node_name, gchar *tag_name)
 shorthand function
gint qsf_is_element (xmlNodePtr a, xmlNsPtr ns, gchar *c)
 shorthand function
gint qsf_check_tag (QsfParam *params, gchar *qof_type)
 shorthand function
void qsf_object_validation_handler (xmlNodePtr child, xmlNsPtr ns, QsfValidator *valid)
 Checks all incoming objects for QOF registration.
gboolean qsf_is_valid (const gchar *schema_dir, const gchar *schema_filename, xmlDocPtr doc)
 Compares an xmlDoc in memory against the schema file.
GList ** qsf_map_prepare_list (GList **maps)
 Prepare the default list of maps.
void qsf_book_node_handler (xmlNodePtr child, xmlNsPtr qsf_ns, QsfParam *params)
 Book and book-guid node handler.
KvpValuestring_to_kvp_value (const gchar *content, KvpValueType type)
 Convert a string value into KvpValue.
void qsf_valid_foreach (xmlNodePtr parent, QsfValidCB cb, struct QsfNodeIterate *qsfiter, QsfValidator *valid)
void qsf_node_foreach (xmlNodePtr parent, QsfNodeCB cb, struct QsfNodeIterate *qsfiter, QsfParam *params)
xmlDocPtr qsf_object_convert (xmlDocPtr mapDoc, xmlNodePtr qsf_root, QsfParam *params)
 Convert between QSF objects.
void qsf_object_node_handler (xmlNodePtr child, xmlNsPtr qsf_ns, QsfParam *params)

Why two sets of functions and typedefs?

These functions are in pairs, one to use in an existing session and one to use when deciding which backend should be selected for a new session.

  • When there is an existing QofSession, the qsf_param context will be available, so set error codes in the backend. Use the *_be functions.
  • When just determining the type of file, qsf_param is not necessary and no backend is available (it has not been selected yet). Use the twin function. e.g. in ::qsf_file_type()

typedef void(* QsfNodeCB )(xmlNodePtr, xmlNsPtr, QsfParam *)
 map and qsf object callback
typedef void(* QsfValidCB )(xmlNodePtr, xmlNsPtr, QsfValidator *)
 validator callback
gboolean is_qsf_object_be (QsfParam *params)
 Validate a QSF file and identify a suitable QSF map.
gboolean is_qsf_object (const gchar *path)
 Validate a QSF file and identify a suitable QSF map.
gboolean is_our_qsf_object_be (QsfParam *params)
 Validate a QSF file and determine type.
gboolean is_our_qsf_object (const gchar *path)
 Validate a QSF file.
gboolean is_qsf_map_be (QsfParam *params)
 Validate a QSF map file.
gboolean is_qsf_map (const gchar *path)
 Validate a QSF map file.
gboolean is_qsf_object_with_map_be (gchar *map_path, QsfParam *params)
 Validate a QSF file and a selected QSF map.
gboolean is_qsf_object_with_map (const gchar *path, gchar *map_file)
 Validate a QSF file and a selected QSF map.

Detailed Description

Private QSF header - not for use by applications.

Author:
Copyright (C) 2004-2005 Neil Williams <linux@codehelp.co.uk>

Definition in file qsf-xml.h.


Define Documentation

#define MAP_CALCULATE_TAG   "calculate"

One calculation for every parameter that needs to be set.

QSF follows the same rule as qof_book_merge. Only if a getter and a setter function are defined for a parameter is it available to QSF. If a QofAccessFunc and QofSetterFunc are both defined for any QofObject parameter, that parameter MUST be calculated in any map that defines that object.

Definition at line 248 of file qsf-xml.h.

#define MAP_DEFAULT_TAG   "default"

User editable defaults for data not available within the available QSF objects.

Some defaults will relate to how to format descriptive dates, whether discount should be considered, which account to use for certain QSF data from applications that do not use accounts.

Some defaults are pre-defined and cannot be over-written:

  • qsf_time_now
  • qsf_time_string

Attributes (All are mandatory):

name The text name for this default. Certain pre-defined defaults exist but user- or map-defined defaults can have any unique text name. Spaces are NOT allowed, use undersccores instead. The value of name must not duplicate any existing default, define, object or parameter unless the special type, enum, is used.

type QOF_TYPE - must be one of the recognised QOF data types for the qof_version in use or the special type, enum.

value Text representation of the required value. For numeric, use the format [0-9]?/[0-9]?

Attention:
Using boolean defaults

A boolean default is not output in the QSF directly, instead the value is used in the calculations to modify certain values. If the boolean default is set to true, the if statement containing the boolean name will be evaluated. If the boolean default is set to false, the corresponding else will be evaluted. Make sure your calculations contain an appropriate else statement so that the boolean value can be adjusted without invalidating the map!

QSF deals with partial QofBooks - each object is fully described but the book does not have to contain any specific object types or have any particular structure. To merge partial books into usual QofBook data sources, the map must deal with entities that need to be referenced in the target QofBook but which simply do not exist in the QofBook used to generate the QSF. e.g. pilot-link knows nothing of Accounts yet when QSF creates a gncInvoice from qof-datebook, gncInvoice needs to know the GUID of certain accounts in the target QofBook. This is handled in the map by specifying the name of the account as a default for that map. When imported, the QSF QofBackend looks up the object required using the name of the parameter to obtain the parameter type. This is the only situation where QSF converts between QOF data types. A string description of the required object is converted to the GUID for that specific entity. The map cannot contain the GUID as it is generic and used by multiple users.

Attention:
Using enumerators
  • enum types are the only defaults that are allowed to use the same name value more than once.
  • enum types are used to increase the readability of a QSF map.
  • The enum name acts to group the enum values together - in a similar fashion to radio buttons in HTML forms.
  • enum types are used only where the QOF object itself uses an enum type.

e.g. the tax_included enum type allows maps to use the full name of the enum value GNC_TAXINCLUDED_YES, instead of the cryptic digit value, 1.

Definition at line 226 of file qsf-xml.h.

#define MAP_DEFINE_TAG   "define"

defines each object supported by this QSF map

Attributes: e_type Copied directly from the QofObject definition. Content: The full QofObject description for the defined QOF object.

Definition at line 151 of file qsf-xml.h.

#define MAP_DEFINITION_TAG   "definition"

Second level container for defined objects

Attributes: qof_version - Taken from the QOF_OBJECT_VERSION macro in QOF. At the time of QSF development, QOF_OBJECT_VERSION is defined as 3. All QSF maps and QSF objects must use the same qof_version which in turn must match the QOF_OBJECT_VERSION for the QOF library in use by the calling process.

No text content allowed.

Definition at line 144 of file qsf-xml.h.

#define MAP_E_TYPE   "e_type"

Validates the objects defined in the map

The e_type will be used to match incoming QSF objects with the relevant QSF map. The value of the e_type must be the value of the e_type for that object in the originating QOF application. The define tag must contain the value of the description of the same object in the same originating QOF application.

Definition at line 300 of file qsf-xml.h.

#define MAP_ENUM_TYPE   "enum"
Todo:
enum is an attempt to make enumerator values descriptive in the maps and QSF (possibly). Not working yet.

Definition at line 304 of file qsf-xml.h.

#define MAP_ITERATE_ATTR   "foreach"

Dictate which object type is the basis for iteration in a hierarchical object set.

Definition at line 155 of file qsf-xml.h.

#define MAP_NAME_ATTR   "name"

The name of the default setting.

Use this name to refer to the value of this default in the map calculations.

Make sure that the type of this default matches the type of the parameter being set by the parent calculation!

Definition at line 267 of file qsf-xml.h.

#define MAP_OBJECT_ATTR   "object"

The object to use to provide the data being set using the map.

Definition at line 290 of file qsf-xml.h.

#define MAP_OBJECT_TAG   "object"

Contains all the calculations to make one object from others.

Note that creating an object for the import application can involve using data from more than one QSF object, as well as defaults and lookups in the import application itself. Conditionals, simple arithmetic and date/time formatting options are also available.

Definition at line 237 of file qsf-xml.h.

#define MAP_QOF_VERSION   "qof_version"

This is the QOF_OBJECT_VERSION from QOF.

QSF maps may need to be updated if QOF itself is upgraded. This setting is coded into QOF and maps for one version cannot necessarily be used by other versions. At the first release of QSF, QOF_OBJECT_VERSION = 3.

Definition at line 257 of file qsf-xml.h.

#define MAP_ROOT_TAG   "qsf-map"

Top level root tag for QSF Maps

Definition at line 133 of file qsf-xml.h.

#define MAP_TYPE_ATTR   "type"

QSF will NOT convert between QOF types.

QSF will allow a conditional to use a parameter of one type to determine the value from a parameter of another type, but the final value assigned MUST be of the same type as the parent calculation.

Definition at line 276 of file qsf-xml.h.

#define MAP_VALUE_ATTR   "value"

The value of the tag, used in defaults and calculations.

The value of a default is a string representation of the value to be inserted into the calculation where the default is used.

The value of a calculation is the name of the parameter that will be set by that calculation.

Definition at line 286 of file qsf-xml.h.

#define QSF_BOOK_COUNT   "count"

Sequential counter of each book in this file

Definition at line 96 of file qsf-xml.h.

#define QSF_BOOK_GUID   "book-guid"

QOF GUID tag for the QofBook described by this QSF object file

Definition at line 94 of file qsf-xml.h.

#define QSF_BOOK_TAG   "book"

First level child: book tag - the QofBook.

Definition at line 91 of file qsf-xml.h.

#define QSF_CONDITIONAL   "if"

child of calculate.

Conditionals can reference objects as if within the original application. In operation, the map is overlaid across both sets of defined objects, an import object in the source application and an output object for the destination object. The current import and output QSF objects are therefore always available to the map. Conditionals can reference parameter as well as object values.

Definition at line 319 of file qsf-xml.h.

#define QSF_CONDITIONAL_ELSE   "else"

Alternative

if(){} else{} is also supported. Nesting of conditionals causes problems for validating the final map against any sensible XML Schema and a map that does not validate will be rejected. When editing conditionals in a QSF map, ALWAYS validate the map using xmllint. If necessary, define a variable at the foot of the definitions block, using a similar syntax to a default, then use that variable in another conditional

variable name="my_rate" type="numeric" value="0/1"

The syntax for xmllint is:

xmllint --schema <schema file> <qsf-file>

Use the qsf-object.xsd.xml schema for objects and qsf-map.xsd.xml for map files.

e.g. xmllint --schema qsf-object.xsd.xml --noout qof-qsf.xml

Definition at line 355 of file qsf-xml.h.

#define QSF_CONDITIONAL_SET   "set"

Assignment statement

Map assignments can use the native values within the output object. The output object must support setting the relevant parameter using the value exactly as given in the map because the relevant set() function will be called using this value. This may reduce the readability of the map but the relevant application could also be modified to support a more readable set function.

Definition at line 331 of file qsf-xml.h.

#define QSF_DATE_LENGTH   MAX_DATE_LENGTH

Max length of QSF_XSD_TIME.

MAX_DATE_LENGTH itself is defined in qof-time.h

Definition at line 88 of file qsf-xml.h.

#define QSF_DEFAULT_NS   "http://qof.sourceforge.net/"

Default namespace for QSF root tag

The map namespace is not included as maps are not currently written out by QOF.

Definition at line 84 of file qsf-xml.h.

#define QSF_FORMATTING_OPTION   "format"

How to format dates/times

When the QSF map uses a date/time value as a string, the formatting can be adjusted to personal preference. format will only be evaluated if the calculated parameter is a QOF_TYPE_STRING - any format attributes on other data types will be ignored.

Definition at line 373 of file qsf-xml.h.

#define QSF_MAP_SCHEMA   "qsf-map.xsd.xml"

Name of the QSF Map Schema.

Definition at line 420 of file qsf-xml.h.

#define QSF_OBJECT_COUNT   "count"

Sequential counter for each QSF object in this file

Definition at line 102 of file qsf-xml.h.

#define QSF_OBJECT_KVP   "path"

The path to this KVP value in the entity frame.

Definition at line 124 of file qsf-xml.h.

#define QSF_OBJECT_SCHEMA   "qsf-object.xsd.xml"

Name of the QSF Object Schema.

Definition at line 417 of file qsf-xml.h.

#define QSF_OBJECT_TAG   "object"

Second level child: object tag

Definition at line 98 of file qsf-xml.h.

#define QSF_OBJECT_TYPE   "type"

QSF parameter name for object type specifiers

Definition at line 100 of file qsf-xml.h.

#define QSF_OBJECT_VALUE   "value"

The KVP Value.

Definition at line 126 of file qsf-xml.h.

#define QSF_OPTION   "option"

enum operator

Not implemented yet - may need to change once work starts. Theoretically, option will specify when an enumerator value is in use - it is quite possible that it will be unnecessary.

Definition at line 363 of file qsf-xml.h.

#define QSF_QOF_VERSION   QOF_OBJECT_VERSION

QOF Version check.

Make sure the same version of QOF is in use in both applications.

Definition at line 70 of file qsf-xml.h.

#define QSF_ROOT_TAG   "qof-qsf"

The top level root tag

Definition at line 78 of file qsf-xml.h.

#define QSF_XML_BOOLEAN_TEST   "true"

needs to be lowercase for XML validation

Definition at line 414 of file qsf-xml.h.

#define QSF_XML_VERSION   "1.0"

The current XML version.

Definition at line 104 of file qsf-xml.h.

#define QSF_XSD_TIME   QOF_UTC_DATE_FORMAT

xsd:dateTime format in coordinated universal time, UTC.

You can reproduce the string from the GNU/Linux command line using the date utility:

date -u +Y-m-dTH:M:SZ

2004-12-12T23:39:11Z

The datestring must be timezone independent and include all specified fields.

Remember to use gmtime() NOT localtime()!. From the command line, use the -u switch with the date command: date -u

To generate a timestamp based on a real time, use the qsf_time_now and qsf_time_string defaults.

qsf_time_now : Format: QOF_TYPE_DATE. The current time taken from the moment the default is read into a QSF object at runtime.

qsf_time_string : Format: QOF_TYPE_STRING. The current timestamp taken from the moment the default is read into a QSF object at runtime. This form is used when the output parameter needs a formatted date string, not an actual date object. The format is determined by the optional format attribute of the set tag which takes the same operators as the GNU C Library for strftime() and output may therefore be dependent on the locale of the calling process - take care. Default value is F, used when qsf_time_string is set without the format attribute.

Both defaults use UTC.

Definition at line 411 of file qsf-xml.h.


Typedef Documentation

typedef void(* QsfNodeCB)(xmlNodePtr, xmlNsPtr, QsfParam *)

map and qsf object callback

This callback cannot do both the map and the validation tasks because validation sometimes needs to be done without qsf_params.

e.g. when selecting which backend should be used for a particular data source where two or more backends share the same access_method.

Definition at line 674 of file qsf-xml.h.

typedef struct QsfObject_s QsfObject

Holds a description of the QofObject.

Used when converting QOF objects from another application. The incoming, unknown, objects need to be stored prior to conversion. This allows many-to-many conversions where an invoice can receive data from an incoming expense AND datebook and use data from an incoming contacts object to lookup the customer for the invoice.

typedef struct QsfMetadata_s QsfParam

QSF Parameters.

This struct is a catch-all for all parameters required for various stages of the process. There are lots of elements here that will finally be removed.

typedef struct QsfValidates_s QsfValidator

Validation metadata.

The validation is a separate parse with separate data. This is used to determine which backend should load the data.

typedef void(* QsfValidCB)(xmlNodePtr, xmlNsPtr, QsfValidator *)

validator callback

Todo:
The need for separate metadata means a separate callback typedef is needed for the validator, but this should be fixed to only need one.

Definition at line 681 of file qsf-xml.h.


Enumeration Type Documentation

enum QsfStatus

Status of various object during mapping.

When handling a map, the incoming QSF objects are not registered with this instance of QOF - they originate from another QOF user. Each object in a map needs to be defined. If the object is registered, the map is checked to locate a calculation that can be used to generate this object. If the object is not registered, the incoming QSF is checked to ensure it provides the object data for the calculation. If anything goes wrong, QSF_INVALID_OBJECT is used.

Maps can be unidirectional or bidirectional so QOF registration is used to determine which calculations should be used and which should be ignored.

All QSF_REGISTERED_OBJECT types need a calculation - if any types remain tagged as QSF_REGISTERED_OBJECT when the map validation is complete, the validation must fail. The only acceptable end values for QsfStatus are QSF_DEFINED_OBJECT, QSF_CALCULATED_OBJECT or QSF_INVALID_OBJECT.

Enumerator:
QSF_NO_OBJECT 

Init value.

QSF_DEFINED_OBJECT 

The object is unregistered but defined. Objects of this type must exist in the incoming QSF and must provide data for the calculation of registered objects.

QSF_REGISTERED_OBJECT 

Temporary value. The object is registered and defined - a calculation is needed but has not been found, yet.

QSF_CALCULATED_OBJECT 

The object is registered, defined and can be calculated.

QSF_INVALID_OBJECT 

Oops value.

Definition at line 443 of file qsf-xml.h.

enum QsfType
Enumerator:
QSF_UNDEF 

Initial undefined value.

IS_QSF_MAP 

A QSF map

IS_QSF_OBJ 

A QSF object without a map - it may or may not need one.

HAVE_QSF_MAP 

A QSF object with the map it needs.

OUR_QSF_OBJ 

A QSF object that can be loaded without a map.

Definition at line 41 of file qsf-xml.h.


Function Documentation

gboolean is_our_qsf_object ( const gchar *  path)

Validate a QSF file.

Parameters:
pathAbsolute or relative path to the file to be validated

The file is validated against the QSF object schema, qsf-object.xsd.xml and each object described in the file is checked to see if it is registered with QOF within the QOF environment of the calling process.

Files that pass the test can be imported into the QOF application without the need for a QSF map.

Returns:
TRUE if the file validates and all objects pass, otherwise FALSE.

Definition at line 180 of file qsf-xml.c.

{
    xmlDocPtr doc;
    struct QsfNodeIterate qsfiter;
    xmlNodePtr object_root;
    QsfValidator valid;
    gint table_count;

    g_return_val_if_fail ((path != NULL), FALSE);
    doc = xmlParseFile (path);
    if (doc == NULL)
    {
        return FALSE;
    }
    if (TRUE != qsf_is_valid (QSF_SCHEMA_DIR, QSF_OBJECT_SCHEMA, doc))
    {
        PINFO (" validation failed %s %s %s", QSF_SCHEMA_DIR,
            QSF_OBJECT_SCHEMA, path);
        return FALSE;
    }
    object_root = xmlDocGetRootElement (doc);
    /* check that all objects in the file are already registered in QOF */
    valid.object_table = g_hash_table_new (g_str_hash, g_str_equal);
    valid.qof_registered_count = 0;
    valid.valid_object_count = 0;
    qsfiter.ns = object_root->ns;
    qsf_valid_foreach (object_root, qsf_object_validation_handler, 
        &qsfiter, &valid);
    table_count = g_hash_table_size (valid.object_table);
    g_hash_table_destroy (valid.object_table);
    xmlFreeDoc (doc);
    if (table_count == valid.qof_registered_count)
    {
        return TRUE;
    }
    return FALSE;
}
gboolean is_our_qsf_object_be ( QsfParam params)

Validate a QSF file and determine type.

Parameters:
paramsPointer to qsf_param context

The file is validated against the QSF object schema, qsf-object.xsd.xml and each object described in the file is checked to see if it is registered with QOF within the QOF environment of the calling process.

Files that pass the test can be imported into the QOF appliction without the need for a QSF map.

Returns:
TRUE if the file validates and all objects pass, otherwise FALSE.

Definition at line 243 of file qsf-xml.c.

{
    xmlDocPtr doc;
    struct QsfNodeIterate qsfiter;
    xmlNodePtr object_root;
    QsfValidator valid;
    gint table_count;

    g_return_val_if_fail ((params != NULL), FALSE);
    if (params->filepath == NULL)
    {
        qof_error_set_be (params->be, qof_error_register
        (_("The QSF XML file '%s' could not be found."), TRUE));
        return FALSE;
    }
    if (params->file_type != QSF_UNDEF)
    {
        return FALSE;
    }
    doc = xmlParseFile (params->filepath);
    if (doc == NULL)
    {
        qof_error_set_be (params->be, qof_error_register
        (_("There was an error parsing the file '%s'."), TRUE));
        return FALSE;
    }
    if (TRUE != qsf_is_valid (QSF_SCHEMA_DIR, QSF_OBJECT_SCHEMA, doc))
    {
        qof_error_set_be (params->be, qof_error_register
        (_("Invalid QSF Object file! The QSF object file '%s' "
        " failed to validate  against the QSF object schema. "
        "The XML structure of the file is either not well-formed "
        "or the file contains illegal data."), TRUE));
        xmlFreeDoc (doc);
        return FALSE;
    }
    params->file_type = IS_QSF_OBJ;
    object_root = xmlDocGetRootElement (doc);
    xmlFreeDoc (doc);
    valid.object_table = g_hash_table_new (g_str_hash, g_str_equal);
    valid.qof_registered_count = 0;
    qsfiter.ns = object_root->ns;
    qsf_valid_foreach (object_root, qsf_object_validation_handler, 
        &qsfiter, &valid);
    table_count = g_hash_table_size (valid.object_table);
    if (table_count == valid.qof_registered_count)
    {
        g_hash_table_destroy (valid.object_table);
        return TRUE;
    }
    g_hash_table_destroy (valid.object_table);
    qof_error_set_be (params->be, params->err_nomap);
    return FALSE;
}
gboolean is_qsf_map ( const gchar *  path)

Validate a QSF map file.

Parameters:
pathAbsolute or relative path to the file to be validated

These functions are in pairs. When called from within a QofSession, the qsf_param context will be available. When just determining the type of file, qsf_param is not necessary. Use the *_be functions from within the QofBackend and the corresponding function in other code.

The file is validated aginst the QSF map schema, qsf-map.xsd.xsml. This function is called by is_qsf_object. If called directly, the map file is validated and closed, no data is retrieved. QSF maps do not contain user data but are used to import QSF object files from other applications.

Returns:
TRUE if the map validates, otherwise FALSE.

Definition at line 372 of file qsf-xml-map.c.

{
    xmlDocPtr doc;
    struct QsfNodeIterate qsfiter;
    QsfValidator valid;
    xmlNodePtr map_root;
    xmlNsPtr map_ns;

    g_return_val_if_fail ((path != NULL), FALSE);
    if (path == NULL)
    {
        return FALSE;
    }
    doc = xmlParseFile (path);
    if (doc == NULL)
    {
        return FALSE;
    }
    if (TRUE != qsf_is_valid (QSF_SCHEMA_DIR, QSF_MAP_SCHEMA, doc))
    {
        return FALSE;
    }
    map_root = xmlDocGetRootElement (doc);
    map_ns = map_root->ns;
    qsfiter.ns = map_ns;
    valid.error_state = QOF_SUCCESS;
    valid.map_table = g_hash_table_new (g_str_hash, g_str_equal);
    qsf_valid_foreach (map_root, qsf_map_validation_handler, 
        &qsfiter, &valid);
    if (valid.error_state != QOF_SUCCESS)
    {
        g_hash_table_destroy (valid.map_table);
        return FALSE;
    }
    g_hash_table_destroy (valid.map_table);
    return TRUE;
}
gboolean is_qsf_map_be ( QsfParam params)

Validate a QSF map file.

Parameters:
paramsPointer to qsf_param context

The file is validated aginst the QSF map schema, qsf-map.xsd.xsml. This function is called by is_qsf_object. If called directly, the map file is validated and closed with a QofBackend error. QSF maps do not contain user data and are used to import QSF object files.

Returns:
TRUE if the map validates, otherwise FALSE.

Definition at line 320 of file qsf-xml-map.c.

{
    xmlDocPtr doc;
    struct QsfNodeIterate qsfiter;
    QsfValidator valid;
    xmlNodePtr map_root;
    xmlNsPtr map_ns;
    gchar *path;

    g_return_val_if_fail ((params != NULL), FALSE);
    path = g_strdup (params->filepath);
    if (path == NULL)
    {
        qof_error_set_be (params->be, qof_error_register
        (_("The QSF XML file '%s' could not be found."), TRUE));
        return FALSE;
    }
    doc = xmlParseFile (path);
    if (doc == NULL)
    {
        qof_error_set_be (params->be, qof_error_register
        (_("There was an error parsing the file '%s'."), TRUE));
        return FALSE;
    }
    if (TRUE != qsf_is_valid (QSF_SCHEMA_DIR, QSF_MAP_SCHEMA, doc))
    {
        qof_error_set_be (params->be, 
            qof_error_register (
            _("Invalid QSF Map file! The QSF map file "
              "failed to validate against the QSF map schema. "
              "The XML structure of the file is either not well-formed "
              "or the file contains illegal data."), FALSE));
        return FALSE;
    }
    map_root = xmlDocGetRootElement (doc);
    map_ns = map_root->ns;
    qsfiter.ns = map_ns;
    valid.object_table = g_hash_table_new (g_str_hash, g_str_equal);
    valid.map_table = g_hash_table_new (g_str_hash, g_str_equal);
    valid.error_state = QOF_SUCCESS;
    qsf_valid_foreach (map_root, qsf_map_validation_handler, 
        &qsfiter, &valid);
    if (valid.error_state != QOF_SUCCESS)
    {
        g_hash_table_destroy (valid.object_table);
        return FALSE;
    }
    g_hash_table_destroy (valid.object_table);
    return TRUE;
}
gboolean is_qsf_object ( const gchar *  path)

Validate a QSF file and identify a suitable QSF map.

Parameters:
pathAbsolute or relative path to the file to be validated.

These functions are in pairs. When called from within a QofSession, the qsf_param context will be available. When just determining the type of file, qsf_param is not necessary. Use the *_be functions from within the QofBackend and the corresponding function in other code.

The file is validated against the QSF object schema, qsf-object.xsd.xml and each object described in the file is checked to find out if a suitable QSF map exists. Map files are accepted if all objects described in the QSF object file are defined in the QSF map.

Returns:
TRUE if the file validates and a QSF map can be found, otherwise FALSE.

Definition at line 219 of file qsf-xml.c.

{
    xmlDocPtr doc;

    g_return_val_if_fail ((path != NULL), FALSE);
    if (path == NULL)
    {
        return FALSE;
    }
    doc = xmlParseFile (path);
    if (doc == NULL)
    {
        return FALSE;
    }
    if (TRUE != qsf_is_valid (QSF_SCHEMA_DIR, QSF_OBJECT_SCHEMA, doc))
    {
        return FALSE;
    }
    /* Note cannot test against a map here, so if the file is valid QSF,
       accept it and work out the details later. */
    return TRUE;
}
gboolean is_qsf_object_be ( QsfParam params)

Validate a QSF file and identify a suitable QSF map.

Parameters:
paramsPointer to qsf_param context

These functions are in pairs. When called from within a QofSession, the qsf_param context will be available. When just determining the type of file, qsf_param is not necessary. Use the *_be functions from within the QofBackend and the corresponding function in other code.

The file is validated against the QSF object schema, qsf-object.xsd.xml and each object described in the file is checked to find out if a suitable QSF map exists. Map files are accepted if all objects described in the QSF object file are defined in the QSF map.

Returns:
TRUE if the file validates and a QSF map can be found, otherwise FALSE.

Definition at line 299 of file qsf-xml.c.

{
    gboolean result;
    xmlDocPtr doc;
    GList *maps;
    gchar *path;

    g_return_val_if_fail ((params != NULL), FALSE);
    path = g_strdup (params->filepath);
    if (path == NULL)
    {
        qof_error_set_be (params->be, qof_error_register
        (_("The QSF XML file '%s' could not be found."), TRUE));
        return FALSE;
    }
    /* skip validation if is_our_qsf_object has already been called. */
/*  if (ERR_QSF_INVALID_OBJ == qof_backend_get_error (params->be))
    {
        return FALSE;
    }*/
    if (params->file_type == QSF_UNDEF)
    {
        doc = xmlParseFile (path);
        if (doc == NULL)
        {
            qof_error_set_be (params->be, qof_error_register
            (_("There was an error parsing the file '%s'."), TRUE));
            return FALSE;
        }
        if (TRUE != qsf_is_valid (QSF_SCHEMA_DIR, QSF_OBJECT_SCHEMA, doc))
        {
            qof_error_set_be (params->be, qof_error_register
            (_("Invalid QSF Object file! The QSF object file '%s' "
            " failed to validate  against the QSF object schema. "
            "The XML structure of the file is either not well-formed "
            "or the file contains illegal data."), TRUE));
            return FALSE;
        }
    }
    result = FALSE;
    /* retrieve list of maps from config frame. */
    for (maps = params->map_files; maps; maps = maps->next)
    {
        QofErrorId err;
        result = is_qsf_object_with_map_be (maps->data, params);
        err = qof_error_check_be (params->be);
        if ((err == QOF_SUCCESS) && result)
        {
            params->map_path = maps->data;
            PINFO ("map chosen = %s", params->map_path);
            break;
        }
    }
    return result;
}
gboolean is_qsf_object_with_map ( const gchar *  path,
gchar *  map_file 
)

Validate a QSF file and a selected QSF map.

Parameters:
pathAbsolute or relative path to the selected QSF object file
map_fileName of the QSF map file, located in QSF_SCHEMA_DIR.

The file is validated against the QSF object schema, qsf-object.xsd.xml and each object described in the file is checked to find out if the supplied QSF map is suitable. Map files are accepted if all objects described in the QSF object file are defined in the QSF map.

Returns:
TRUE if the file validates and the supplied QSF map is usable, otherwise FALSE.

Definition at line 290 of file qsf-xml-map.c.

{
    xmlDocPtr doc, map_doc;
    QofErrorId result;
    gchar *map_path;

    map_path = g_strdup_printf ("%s/%s", QSF_SCHEMA_DIR, map_file);
    if (path == NULL)
    {
        return FALSE;
    }
    doc = xmlParseFile (path);
    if (doc == NULL)
    {
        return FALSE;
    }
    if (TRUE != qsf_is_valid (QSF_SCHEMA_DIR, QSF_OBJECT_SCHEMA, doc))
    {
        return FALSE;
    }
    if (map_path == NULL)
    {
        return FALSE;
    }
    map_doc = xmlParseFile (map_path);
    result = check_qsf_object_with_map_internal (map_doc, doc);
    return (result == QOF_SUCCESS) ? TRUE : FALSE;
}
gboolean is_qsf_object_with_map_be ( gchar *  map_path,
QsfParam params 
)

Validate a QSF file and a selected QSF map.

Parameters:
map_pathAbsolute or relative path to the selected QSF map file
paramsPointer to qsf_param context

The file is validated against the QSF object schema, qsf-object.xsd.xml and each object described in the file is checked to find out if the supplied QSF map is suitable. Map files are accepted if all objects described in the QSF object file are defined in the QSF map.

This backend twin also sets QofErrorId codes.

Returns:
TRUE if the file validates and the supplied QSF map is usable, otherwise FALSE.

Definition at line 240 of file qsf-xml-map.c.

{
    xmlDocPtr doc, map_doc;
    QofErrorId result;
    gchar *path, *map_path;

    g_return_val_if_fail ((params != NULL), FALSE);
    path = g_strdup (params->filepath);
    map_path = g_strdup_printf ("%s/%s", QSF_SCHEMA_DIR, map_file);
    PINFO (" checking map file '%s'", map_path);
    if (path == NULL)
    {
        qof_error_set_be (params->be, qof_error_register
        (_("The QSF XML file '%s' could not be found."), TRUE));
        return FALSE;
    }
    doc = xmlParseFile (path);
    if (doc == NULL)
    {
        qof_error_set_be (params->be, qof_error_register
        (_("There was an error parsing the file '%s'."), TRUE));
        return FALSE;
    }
    if (TRUE != qsf_is_valid (QSF_SCHEMA_DIR, QSF_OBJECT_SCHEMA, doc))
    {
        qof_error_set_be (params->be, qof_error_register
        (_("Invalid QSF Object file! The QSF object file '%s' "
        " failed to validate  against the QSF object schema. "
        "The XML structure of the file is either not well-formed "
        "or the file contains illegal data."), TRUE));
        return FALSE;
    }
    if (map_path == NULL)
    {
        qof_error_set_be (params->be, qof_error_register
        (_("The QSF map file '%s' could not be found."), TRUE));
        return FALSE;
    }
    map_doc = xmlParseFile (map_path);
    if (map_doc == NULL)
    {
        qof_error_set_be (params->be, qof_error_register
        (_("There was an error parsing the file '%s'."), TRUE));
        return FALSE;
    }
    result = check_qsf_object_with_map_internal (map_doc, doc);
    return (result == QOF_SUCCESS) ? TRUE : FALSE;
}
void qsf_book_node_handler ( xmlNodePtr  child,
xmlNsPtr  qsf_ns,
QsfParam params 
)

Book and book-guid node handler.

Reads the book count="" attribute (currently only 1 QofBook is supported per QSF object file). Sets the book-guid as the GUID of the current QofBackend QofBook in qsf_param. Calls the next handler, qsf_object_node_handler, with the child of the book tag.

Definition at line 424 of file qsf-xml.c.

{
    gchar *book_count_s, *tail;
    gint book_count;
    xmlNodePtr child_node;
    struct QsfNodeIterate qsfiter;
    gchar *buffer;
    GUID book_guid;

    g_return_if_fail (child);
    g_return_if_fail (params);
    ENTER (" child=%s", child->name);
    if (qsf_is_element (child, ns, QSF_BOOK_TAG))
    {
        book_count_s =
            (gchar *) xmlGetProp (child, BAD_CAST QSF_BOOK_COUNT);
        if (book_count_s)
        {
            book_count = (gint) strtol (book_count_s, &tail, 0);
            /* More than one book not currently supported. */
            g_free (book_count_s);
            g_return_if_fail (book_count == 1);
        }
        qsfiter.ns = ns;
        child_node = child->children->next;
        if (qsf_is_element (child_node, ns, QSF_BOOK_GUID))
        {
            DEBUG (" trying to set book GUID");
            buffer = BAD_CAST xmlNodeGetContent (child_node);
            g_return_if_fail (TRUE == string_to_guid (buffer, &book_guid));
            qof_entity_set_guid ((QofEntity *) params->book, &book_guid);
            xmlNewChild (params->output_node, params->qsf_ns,
                BAD_CAST QSF_BOOK_GUID, BAD_CAST buffer);
            xmlFree (buffer);
        }
        qsf_node_foreach (child, qsf_object_node_handler, &qsfiter, params);
    }
    LEAVE (" ");
}
gint qsf_check_tag ( QsfParam params,
gchar *  qof_type 
)

shorthand function

This may look repetitive but each one is used separately as well as in a block.

Definition at line 69 of file qsf-xml.c.

{
    return qsf_is_element (params->child_node, params->qsf_ns, qof_type);
}
gint qsf_compare_tag_strings ( const xmlChar *  node_name,
gchar *  tag_name 
)

shorthand function

This may look repetitive but each one is used separately as well as in a block.

Definition at line 39 of file qsf-xml.c.

{
    return xmlStrcmp (node_name, (const xmlChar *) tag_name);
}
gint qsf_is_element ( xmlNodePtr  a,
xmlNsPtr  ns,
gchar *  c 
)

shorthand function

This may look repetitive but each one is used separately as well as in a block.

Definition at line 55 of file qsf-xml.c.

{
    g_return_val_if_fail (a != NULL, 0);
    g_return_val_if_fail (ns != NULL, 0);
    g_return_val_if_fail (c != NULL, 0);
    if ((a->ns == ns) && (a->type == XML_ELEMENT_NODE) &&
        qsf_strings_equal (a->name, c))
    {
        return 1;
    }
    return 0;
}
gboolean qsf_is_valid ( const gchar *  schema_dir,
const gchar *  schema_filename,
xmlDocPtr  doc 
)

Compares an xmlDoc in memory against the schema file.

Parameters:
schema_dirset at compile time to $prefix/share/qsf/
schema_filenameEither the QSF Object Schema or the QSF Map Schema.
docThe xmlDoc read from the file using libxml2.

Ensure that you call the right schema_filename for the doc in question!

Incorrect validation will result in output to the terminal window.

Returns:
TRUE if the doc validates against the assigned schema, otherwise FALSE.

Definition at line 75 of file qsf-xml.c.

{
    xmlSchemaParserCtxtPtr qsf_schema_file;
    xmlSchemaPtr qsf_schema;
    xmlSchemaValidCtxtPtr qsf_context;
    gchar *schema_path;
    gint result;

    g_return_val_if_fail (doc || schema_filename, FALSE);
    schema_path = g_strdup_printf ("%s/%s", schema_dir, schema_filename);
    qsf_schema_file = xmlSchemaNewParserCtxt (schema_path);
    qsf_schema = xmlSchemaParse (qsf_schema_file);
    qsf_context = xmlSchemaNewValidCtxt (qsf_schema);
    result = xmlSchemaValidateDoc (qsf_context, doc);
    xmlSchemaFreeParserCtxt (qsf_schema_file);
    xmlSchemaFreeValidCtxt (qsf_context);
    xmlSchemaFree (qsf_schema);
    g_free (schema_path);
    if (result == 0)
    {
        return TRUE;
    }
    return FALSE;
}
GList** qsf_map_prepare_list ( GList **  maps)

Prepare the default list of maps.

Prepend the default maps to the supplied GList.

The GList remains the property of the caller.

Todo:
Automate this once map support is stable

Definition at line 167 of file qsf-backend.c.

{
    /* Add new map filenames here. */
    *maps = g_list_prepend (*maps, "pilot-qsf-GnuCashInvoice.xml");
    *maps = g_list_prepend (*maps, "pilot-qsf-gncCustomer.xml");
    return maps;
}
void qsf_node_foreach ( xmlNodePtr  parent,
QsfNodeCB  cb,
struct QsfNodeIterate qsfiter,
QsfParam params 
)

Iterate over the children of the parent node.

Only iterates over the immediate children of the parent - this function is not recursive.

Definition at line 116 of file qsf-xml.c.

{
    xmlNodePtr cur_node;

    if (!parent)
        return;
    g_return_if_fail (params);
    g_return_if_fail (qsfiter->ns);
    qsfiter->fcn = &cb;
    for (cur_node = parent->children; cur_node != NULL;
        cur_node = cur_node->next)
    {
        cb (cur_node, qsfiter->ns, params);
    }
}
xmlDocPtr qsf_object_convert ( xmlDocPtr  mapDoc,
xmlNodePtr  qsf_root,
QsfParam params 
)

Convert between QSF objects.

This is the main workhorse of the conversion between QSF objects using maps.

Parameters:
mapDocThe map document, parsed by libxml2.
qsf_rootThe top node of the QSF object to be converted using the map.
paramsThe QSF backend parameters.

Each calculation in the map is performed over the child nodes of the object tree. A new xmlDoc is created and this is made available to QOF to be loaded into the book.

Definition at line 954 of file qsf-xml-map.c.

{
    /* mapDoc : map document. qsf_root: incoming QSF root node. */
    struct QsfNodeIterate qsfiter;
    xmlDocPtr output_doc;
    xmlNode *cur_node;
    xmlNode *map_root, *output_root;

    g_return_val_if_fail ((mapDoc && qsf_root && params), NULL);
    ENTER (" root=%s", qsf_root->name);
    /* prepare the intermediary document */
    qsfiter.ns = params->qsf_ns;
    output_doc = xmlNewDoc (BAD_CAST QSF_XML_VERSION);
    output_root = xmlNewNode (NULL, BAD_CAST QSF_ROOT_TAG);
    xmlDocSetRootElement (output_doc, output_root);
    xmlSetNs (output_root, params->qsf_ns);
    params->output_node = xmlNewChild (output_root, params->qsf_ns,
        BAD_CAST QSF_BOOK_TAG, NULL);
    xmlNewProp (params->output_node, BAD_CAST QSF_BOOK_COUNT,
        BAD_CAST "1");
    /* parse the incoming QSF */
    qsf_book_node_handler (qsf_root->children->next, params->qsf_ns,
        params);
    /* parse the map and calculate the values */
    map_root = xmlDocGetRootElement (mapDoc);
    params->foreach_limit = 0;
    qsfiter.ns = params->map_ns;
    /* sets qof_foreach iterator, defines and defaults. */
    qsf_node_foreach (map_root, qsf_map_top_node_handler, &qsfiter, params);
    /* identify the entities of iterator type. */
    qsfiter.ns = params->qsf_ns;
    qsf_node_foreach (qsf_root->children->next, iterator_cb, &qsfiter,
        params);
    PINFO (" counted %d records", params->foreach_limit);
    params->count = 0;
    for (cur_node = map_root->children; cur_node != NULL;
        cur_node = cur_node->next)
    {
        params->convert_node = cur_node;
        if (qsf_is_element (cur_node, params->map_ns, MAP_OBJECT_TAG))
        {
            gint i;

            params->lister = NULL;
            PINFO (" found an object tag. starting calculation");
            /* cur_node describes the target object */
            if (!qof_class_is_registered (BAD_CAST
                    xmlGetProp (cur_node, MAP_TYPE_ATTR)))
            {
                continue;
            }
            qsf_add_object_tag (params, params->count);
            params->count++;
            qsfiter.ns = params->map_ns;
            PINFO (" params->foreach_limit=%d", params->foreach_limit);
            for (i = -1; i < params->foreach_limit; i++)
            {
                qsf_node_foreach (cur_node, qsf_map_object_handler, 
                    &qsfiter, params);
                params->qsf_object_list =
                    g_list_next (params->qsf_object_list);
                params->count++;
            }
        }
    }
    params->file_type = OUR_QSF_OBJ;
    /* use for debugging */
    xmlSaveFormatFileEnc ("-", output_doc, "UTF-8", 1);
    LEAVE (" ");
    return output_doc;
}
void qsf_object_node_handler ( xmlNodePtr  child,
xmlNsPtr  qsf_ns,
QsfParam params 
)

Despite the name, this function handles the QSF object book tag AND the object tags.

Used to parse object and map files.

Definition at line 385 of file qsf-xml.c.

{
    struct QsfNodeIterate qsfiter;
    QsfObject *object_set;
    gchar *tail, *object_count_s;
    gint64 c;

    g_return_if_fail (child != NULL);
    g_return_if_fail (qsf_ns != NULL);
    params->qsf_ns = qsf_ns;
    if (qsf_is_element (child, qsf_ns, QSF_OBJECT_TAG))
    {
        params->qsf_parameter_hash = NULL;
        c = 0;
        object_set = g_new (QsfObject, 1);
        params->object_set = object_set;
        object_set->object_count = 0;
        object_set->parameters =
            g_hash_table_new (g_str_hash, g_str_equal);
        object_set->object_type = ((gchar *) xmlGetProp (child,
                BAD_CAST QSF_OBJECT_TYPE));
        object_count_s = ((gchar *) xmlGetProp (child,
                BAD_CAST QSF_OBJECT_COUNT));
        if (object_count_s)
        {
            c = (gint64) strtol (object_count_s, &tail, 0);
            object_set->object_count = (gint) c;
            g_free (object_count_s);
        }
        params->qsf_object_list =
            g_list_prepend (params->qsf_object_list, object_set);
        qsfiter.ns = qsf_ns;
        params->qsf_parameter_hash = object_set->parameters;
        qsf_node_foreach (child, qsf_parameter_handler, &qsfiter, params);
    }
}
void qsf_object_validation_handler ( xmlNodePtr  child,
xmlNsPtr  ns,
QsfValidator valid 
)

Checks all incoming objects for QOF registration.

Sums all existing objects in the QSF and counts the number of those objects that are also registered with QOF in the host application.

Definition at line 134 of file qsf-xml.c.

{
    xmlNodePtr cur_node;
    xmlChar *object_declaration;
    guint count;
    QsfStatus type;
    gboolean is_registered;

    count = 0;
    type = QSF_NO_OBJECT;
    is_registered = FALSE;
    for (cur_node = child->children; cur_node != NULL;
        cur_node = cur_node->next)
    {
        if (qsf_is_element (cur_node, ns, QSF_OBJECT_TAG))
        {
            object_declaration =
                xmlGetProp (cur_node, BAD_CAST QSF_OBJECT_TYPE);
            is_registered = qof_class_is_registered (object_declaration);
            if (is_registered)
            {
                type = QSF_REGISTERED_OBJECT;
            }
            else
            {
                type = QSF_DEFINED_OBJECT;
            }
            xmlFree (object_declaration);
            count = g_hash_table_size (valid->object_table);
            g_hash_table_insert (valid->object_table, object_declaration,
                GINT_TO_POINTER (type));
            /* if insert was successful - i.e. object is unique so far */
            if (g_hash_table_size (valid->object_table) > count)
            {
                valid->valid_object_count++;
                if (is_registered)
                {
                    valid->qof_registered_count++;
                }
            }
        }
    }
}
gint qsf_strings_equal ( const xmlChar *  node_name,
gchar *  tag_name 
)

shorthand function

This may look repetitive but each one is used separately as well as in a block.

Definition at line 45 of file qsf-xml.c.

{
    if (0 == qsf_compare_tag_strings (node_name, tag_name))
    {
        return 1;
    }
    return 0;
}
void qsf_valid_foreach ( xmlNodePtr  parent,
QsfValidCB  cb,
struct QsfNodeIterate qsfiter,
QsfValidator valid 
)

Validate the children of the parent node.

Note:
Slightly different to qsf_node_foreach because the validation can be run without qsf_param being initialized.

Definition at line 102 of file qsf-xml.c.

{
    xmlNodePtr cur_node;

    qsfiter->v_fcn = &cb;
    for (cur_node = parent->children; cur_node != NULL;
        cur_node = cur_node->next)
    {
        cb (cur_node, qsfiter->ns, valid);
    }
}
KvpValue* string_to_kvp_value ( const gchar *  content,
KvpValueType  type 
)

Convert a string value into KvpValue.

Partner to kvp_value_to_string. Given the type of KvpValue required, attempts to convert the string into that type of value.

Parameters:
contentA string representation of the value, ideally as output by kvp_value_to_string.
typeKvpValueType of the intended KvpValue
Returns:
KvpValue* or NULL on failure.
Todo:
reconcile the duplication with the QSF version

Definition at line 1223 of file qsf-backend.c.

{
    gchar *tail;
    gint64 cm_i64;
    gdouble cm_double;
    QofNumeric cm_numeric;
    GUID *cm_guid;
#ifndef QOF_DISABLE_DEPRECATED
    struct tm kvp_time;
    time_t kvp_time_t;
    Timespec cm_date;
#endif

    switch (type)
    {
        case KVP_TYPE_GINT64:
        {
            errno = 0;
            cm_i64 = strtoll (content, &tail, 0);
            if (errno == 0)
            {
                return kvp_value_new_gint64 (cm_i64);
            }
            break;
        }
        case KVP_TYPE_DOUBLE:
        {
            errno = 0;
            cm_double = strtod (content, &tail);
            if (errno == 0)
                return kvp_value_new_double (cm_double);
            break;
        }
        case KVP_TYPE_NUMERIC:
        {
            qof_numeric_from_string (content, &cm_numeric);
            return kvp_value_new_numeric (cm_numeric);
            break;
        }
        case KVP_TYPE_STRING:
        {
            return kvp_value_new_string (content);
            break;
        }
        case KVP_TYPE_GUID:
        {
            cm_guid = g_new0 (GUID, 1);
            if (TRUE == string_to_guid (content, cm_guid))
                return kvp_value_new_guid (cm_guid);
            break;
        }
        case KVP_TYPE_TIME :
        {
            QofDate *qd;
            QofTime *qt;
            KvpValue *retval;

            qd = qof_date_parse (content, QOF_DATE_FORMAT_UTC);
            if(qd)
            {
                qt = qof_date_to_qtime (qd);
                retval = kvp_value_new_time (qt);
                qof_date_free (qd);
                qof_time_free (qt);
                return retval;
            }
            else
                PERR (" failed to parse date");
        }
#ifndef QOF_DISABLE_DEPRECATED
        case KVP_TYPE_TIMESPEC:
        {
            strptime (content, QSF_XSD_TIME, &kvp_time);
            kvp_time_t = mktime (&kvp_time);
            timespecFromTime_t (&cm_date, kvp_time_t);
            return kvp_value_new_timespec (cm_date);
            break;
        }
#endif
        case KVP_TYPE_BOOLEAN :
        {
            gboolean val;
            val = qof_util_bool_to_int (content);
            return kvp_value_new_boolean (val);
        }
        case KVP_TYPE_BINARY:
//        return kvp_value_new_binary(value->value.binary.data,
//                                  value->value.binary.datasize);
            break;
        case KVP_TYPE_GLIST:
//          return kvp_value_new_glist(value->value.list);
            break;
        case KVP_TYPE_FRAME:
//        return kvp_value_new_frame(value->value.frame);
            break;
    }
    return NULL;
}