ota_compiler.c File Reference

#include <ctype.h>
#include <inttypes.h>
#include <libxml/xmlmemory.h>
#include <libxml/tree.h>
#include <libxml/debugXML.h>
#include <libxml/encoding.h>
#include "shared.h"
#include "xml_shared.h"
#include "ota_compiler.h"
#include "xml_definitions.h"

Go to the source code of this file.

Data Structures
struct	ota_2table_t
struct	ota_3table_t

Macros
#define	NUMBER_OF_ELEMENTS   sizeof(ota_elements)/sizeof(ota_elements[0])
#define	NUMBER_OF_SYNCSETTINGS_ELEMENTS   sizeof(ota_syncsettings_elements)/sizeof(ota_syncsettings_elements[0])
#define	NUMBER_OF_ATTRIBUTES   sizeof(ota_attributes)/sizeof(ota_attributes[0])
#define	OMA_VALUE_TAG   0x06
#define	NUMBER_OF_OMA_ATTRIBUTES   sizeof(oma_ota_attributes)/sizeof(oma_ota_attributes[0])

Typedefs
typedef struct ota_2table_t	ota_2table_t
typedef struct ota_3table_t	ota_3table_t

Functions
static int	parse_document (xmlDocPtr document, Octstr *charset, simple_binary_t **ota_binary)
static int	parse_node (xmlNodePtr node, simple_binary_t **otabxml)
static int	parse_element (xmlNodePtr node, simple_binary_t **otabxml)
static int	parse_attribute (xmlAttrPtr attr, simple_binary_t **otabxml)
int	ota_compile (Octstr *ota_doc, Octstr *charset, Octstr **ota_binary)
static int	parse_ota_syncsettings (xmlNodePtr node, simple_binary_t **otabxml)

Variables
static ota_2table_t	ota_elements []
static ota_2table_t	ota_syncsettings_elements []
static ota_3table_t	ota_attributes []
static ota_3table_t	oma_ota_attributes []

Macro Definition Documentation

NUMBER_OF_ATTRIBUTES

#define NUMBER_OF_ATTRIBUTES   sizeof(ota_attributes)/sizeof(ota_attributes[0])

Definition at line 229 of file ota_compiler.c.

Referenced by parse_attribute().

NUMBER_OF_ELEMENTS

#define NUMBER_OF_ELEMENTS   sizeof(ota_elements)/sizeof(ota_elements[0])

Definition at line 133 of file ota_compiler.c.

Referenced by parse_element().

NUMBER_OF_OMA_ATTRIBUTES

#define NUMBER_OF_OMA_ATTRIBUTES   sizeof(oma_ota_attributes)/sizeof(oma_ota_attributes[0])

Definition at line 453 of file ota_compiler.c.

Referenced by parse_attribute().

NUMBER_OF_SYNCSETTINGS_ELEMENTS

#define NUMBER_OF_SYNCSETTINGS_ELEMENTS   sizeof(ota_syncsettings_elements)/sizeof(ota_syncsettings_elements[0])

Definition at line 161 of file ota_compiler.c.

Referenced by parse_ota_syncsettings().

OMA_VALUE_TAG

#define OMA_VALUE_TAG   0x06

Definition at line 451 of file ota_compiler.c.

Referenced by parse_attribute().

Typedef Documentation

ota_2table_t

typedef struct ota_2table_t ota_2table_t

Definition at line 105 of file ota_compiler.c.

ota_3table_t

typedef struct ota_3table_t ota_3table_t

Definition at line 118 of file ota_compiler.c.

Function Documentation

ota_compile()

int ota_compile	(	Octstr *	ota_doc,
		Octstr *	charset,
		Octstr **	ota_binary
	)

Definition at line 473 of file ota_compiler.c.

References charset, error(), octstr_create, octstr_destroy(), octstr_get_cstr, octstr_len(), octstr_shrink_blanks(), octstr_strip_blanks(), parse_document(), set_charset(), simple_binary_create(), simple_binary_destroy(), simple_binary_output(), and size.

Referenced by main(), and ota_pack_message().

{
    simple_binary_t *otabxml;
    int ret;
    xmlDocPtr pDoc;
    size_t size;
    char *ota_c_text;

    *ota_binary = octstr_create(""); 
    otabxml = simple_binary_create();

    octstr_strip_blanks(ota_doc);
    octstr_shrink_blanks(ota_doc);
    set_charset(ota_doc, charset);
    size = octstr_len(ota_doc);
    ota_c_text = octstr_get_cstr(ota_doc);
    pDoc = xmlParseMemory(ota_c_text, size);

    ret = 0;
    if (pDoc) {
        ret = parse_document(pDoc, charset, &otabxml);
        simple_binary_output(*ota_binary, otabxml);
        xmlFreeDoc(pDoc);
    } else {
        xmlFreeDoc(pDoc);
        octstr_destroy(*ota_binary);
        simple_binary_destroy(otabxml);
        error(0, "OTA: No document to parse. Probably an error in OTA source");
        return -1;
    }

    simple_binary_destroy(otabxml);

    return ret;
}

parse_attribute()

static int parse_attribute ( xmlAttrPtr  attr, simple_binary_t **  otabxml  )

static

Definition at line 749 of file ota_compiler.c.

References ota_3table_t::code_page, create_octstr_from_node, error(), name, NUMBER_OF_ATTRIBUTES, NUMBER_OF_OMA_ATTRIBUTES, octstr_case_compare(), octstr_compare(), octstr_create, octstr_destroy(), octstr_get_cstr, octstr_imm(), oma_ota_attributes, OMA_VALUE_TAG, ota_attributes, output_char(), parse_inline_string(), ota_3table_t::token, ota_3table_t::value, and warning().

Referenced by parse_element().

{
    Octstr *name, *value, *valueos, *nameos;
    unsigned char ota_hex;
    size_t i, limit;
    ota_3table_t *alist;

    name = octstr_create((char *)attr->name);

    if (attr->children != NULL)
        value = create_octstr_from_node((char *)attr->children);
    else 
        value = NULL;

    if (value == NULL)
        goto error;

    /* OMA has it's own dedicated public ID, so use this */        
    if ((*otabxml)->public_id == 0x0B) { 
        alist = oma_ota_attributes;
        limit = NUMBER_OF_OMA_ATTRIBUTES;
    } else {
        alist = ota_attributes;
        limit = NUMBER_OF_ATTRIBUTES;
    }

    i = 0;
    valueos = NULL;
    nameos = NULL;
    while (i < limit) {
        nameos = octstr_imm(alist[i].name);
        if (octstr_case_compare(name, nameos) == 0) {
            if (alist[i].value != NULL) {
                valueos = octstr_imm(alist[i].value);
            }
            if (octstr_case_compare(value, valueos) == 0) {
                break;
            }
            if (octstr_compare(valueos, octstr_imm("INLINE")) == 0) {
                break;
            }
        }
       ++i;
    }

    if (i == limit) {
        warning(0, "OTA compiler: Unknown attribute '%s' in OTA source, "
                   "with value '%s'.", 
                octstr_get_cstr(name), octstr_get_cstr(value));
        goto error;
    }

    ota_hex = alist[i].token;
    /* if not inline used */
    if (octstr_compare(valueos, octstr_imm("INLINE")) != 0) {
        /* Switch code page. */
        if (alist[i].code_page != (*otabxml)->code_page) { 
            output_char(0, otabxml);
            output_char(alist[i].code_page, otabxml);
            (*otabxml)->code_page = alist[i].code_page;
        }
        /* if OMA add value tag */
        if ((*otabxml)->public_id == 0x0B && name 
            && octstr_case_compare(name, octstr_imm("value")) == 0)
            output_char(OMA_VALUE_TAG, otabxml);
        output_char(ota_hex, otabxml);
    } else {
        /* Switch code page. */
        if (alist[i].code_page != (*otabxml)->code_page) {
            output_char(0, otabxml);
            output_char(alist[i].code_page, otabxml);
            (*otabxml)->code_page = alist[i].code_page;
        }
        output_char(ota_hex, otabxml);
        parse_inline_string(value, otabxml);
    }  

    octstr_destroy(name);
    octstr_destroy(value);
    return 0;

error:
    octstr_destroy(name);
    octstr_destroy(value);
    return -1;
}

parse_document()

static int parse_document ( xmlDocPtr  document, Octstr *  charset, simple_binary_t **  ota_binary  )

static

Definition at line 518 of file ota_compiler.c.

References charset, octstr_create, octstr_destroy(), parse_charset(), and parse_node().

Referenced by ota_compile().

{
    xmlNodePtr node;

    if (document->intSubset && document->intSubset->ExternalID 
        && strcmp((char *)document->intSubset->ExternalID, "-//WAPFORUM//DTD PROV 1.0//EN") == 0) {
        /* OMA ProvCont */
        (*otabxml)->wbxml_version = 0x03; /* WBXML Version number 1.3  */
        (*otabxml)->public_id = 0x0B; /* Public id for this kind of doc */  
    } else {
        /* OTA */
        (*otabxml)->wbxml_version = 0x01; /* WBXML Version number 1.1  */
        (*otabxml)->public_id = 0x01; /* Public id for an unknown document type */
    }
    (*otabxml)->code_page = 0;
    
    charset = octstr_create("UTF-8");
    (*otabxml)->charset = parse_charset(charset);
    octstr_destroy(charset);

    node = xmlDocGetRootElement(document);
    return parse_node(node, otabxml);
}

parse_element()

static int parse_element ( xmlNodePtr  node, simple_binary_t **  otabxml  )

static

Definition at line 674 of file ota_compiler.c.

References element_check_content(), name, NUMBER_OF_ELEMENTS, octstr_case_compare(), octstr_create, octstr_destroy(), octstr_duplicate, octstr_get_cstr, octstr_imm(), octstr_len(), octstr_search_char(), ota_elements, output_char(), output_octet_string(), parse_attribute(), parse_end(), parse_ota_syncsettings(), ota_2table_t::token, warning(), WBXML_CONTENT_BIT, and WBXML_LITERAL.

Referenced by parse_node().

{
    Octstr *name;
    size_t i;
    unsigned char status_bits, ota_hex;
    int add_end_tag, syncstat;
    xmlAttrPtr attribute;

    /* if compiling a syncsettings document there's no need to
       continue with the parsing of ota or oma tags. */
    syncstat = -1;
    if (octstr_search_char((**otabxml).binary, 0x55, 0) == 0) {
        syncstat = parse_ota_syncsettings(node, otabxml);
        if (syncstat >= 0) {
            return syncstat;
        }
    }

    name = octstr_create((char *)node->name);
    if (octstr_len(name) == 0) {
        octstr_destroy(name);
        return -1;
    }

    i = 0;
    while (i < NUMBER_OF_ELEMENTS) {
        if (octstr_case_compare(name, octstr_imm(ota_elements[i].name)) == 0)
            break;
        ++i;
    }

    status_bits = 0x00;
    ota_hex = 0x00;
    add_end_tag = 0;

    if (i != NUMBER_OF_ELEMENTS) {
        ota_hex = ota_elements[i].token;
        if ((status_bits = element_check_content(node)) > 0) {
            ota_hex = ota_hex | status_bits;
            if ((status_bits & WBXML_CONTENT_BIT) == WBXML_CONTENT_BIT)
                add_end_tag = 1;
        }
        output_char(ota_hex, otabxml);
    } else {
        warning(0, "OTA compiler: Unknown tag '%s' in OTA source", octstr_get_cstr(name));
        ota_hex = WBXML_LITERAL;
        if ((status_bits = element_check_content(node)) > 0) {
            ota_hex = ota_hex | status_bits;
            /* If this node has children, the end tag must be added after them. */
            if ((status_bits & WBXML_CONTENT_BIT) == WBXML_CONTENT_BIT)
                add_end_tag = 1;
        }
        output_char(ota_hex, otabxml);
        output_octet_string(octstr_duplicate(name), otabxml);
    }

    if (node->properties != NULL) {
        attribute = node->properties;
        while (attribute != NULL) {
            parse_attribute(attribute, otabxml);
            attribute = attribute->next;
        }
        parse_end(otabxml);
    }

    octstr_destroy(name);
    return add_end_tag;
}

parse_node()

static int parse_node ( xmlNodePtr  node, simple_binary_t **  otabxml  )

static

Definition at line 550 of file ota_compiler.c.

References error(), parse_element(), parse_end(), and warning().

Referenced by parse_document().

{
    int status = 0;
    
    /* Call for the parser function of the node type. */
    switch (node->type) {
        case XML_ELEMENT_NODE:
            status = parse_element(node, otabxml);
            break;
        case XML_TEXT_NODE:
        case XML_COMMENT_NODE:
        case XML_PI_NODE:
            /* Text nodes, comments and PIs are ignored. */
            break;
        /*
         * XML has also many other node types, these are not needed with 
         * OTA. Therefore they are assumed to be an error.
         */
        default:
            error(0, "OTA compiler: Unknown XML node in the OTA source.");
            return -1;
            break;
    }

    /* 
     * If node is an element with content, it will need an end tag after it's
     * children. The status for it is returned by parse_element.
     */
    switch (status) {
        case 0:
            if (node->children != NULL && parse_node(node->children, otabxml) == -1)
                return -1;
            break;
        case 1:
            if (node->children != NULL && parse_node(node->children, otabxml) == -1)
                return -1;
            parse_end(otabxml);
            break;
        case -1: /* Something went wrong in the parsing. */
            return -1;
            break;
        default:
            warning(0,"OTA compiler: Undefined return value in a parse function.");
            return -1;
            break;
    }

    if (node->next != NULL && parse_node(node->next, otabxml) == -1)
        return -1;

    return 0;
}

parse_ota_syncsettings()

static int parse_ota_syncsettings ( xmlNodePtr  node, simple_binary_t **  otabxml  )

static

Definition at line 610 of file ota_compiler.c.

References content, element_check_content(), error(), name, NUMBER_OF_SYNCSETTINGS_ELEMENTS, octstr_case_compare(), octstr_create, octstr_destroy(), octstr_get_cstr, octstr_imm(), octstr_len(), only_blanks(), ota_syncsettings_elements, output_char(), parse_inline_string(), ota_2table_t::token, token, warning(), and WBXML_CONTENT_BIT.

Referenced by parse_element().

{
    Octstr *name, *content;
    unsigned char status_bits, ota_hex;
    int add_end_tag;
    size_t i;

    name = NULL;
    content = NULL;
    name = octstr_create((char *)node->name);
    if (octstr_len(name) == 0) {
        goto error;
    }

    i = 0;
    while (i < NUMBER_OF_SYNCSETTINGS_ELEMENTS) {
        if (octstr_case_compare(name, octstr_imm(ota_syncsettings_elements[i].name)) == 0)
            break;
        ++i;
    }

    if (i == NUMBER_OF_SYNCSETTINGS_ELEMENTS) {
        goto error;
    }

    ota_hex = ota_syncsettings_elements[i].token;
    output_char(ota_syncsettings_elements[i].token, otabxml);

    /* if the node has CDATA content output it. 
     * Else expect child tags */
    if (!only_blanks((char *)node->children->content)) {
        content = octstr_create((char *)node->children->content);
        parse_inline_string(content, otabxml);
    }

    add_end_tag = 0;
    if ((status_bits = element_check_content(node)) > 0) {
        ota_hex = ota_hex | status_bits;
        /* If this node has children, the end tag must be added after them. */
        if ((status_bits & WBXML_CONTENT_BIT) == WBXML_CONTENT_BIT) {
            add_end_tag = 1;
        }
    }

    octstr_destroy(content);
    octstr_destroy(name);
    return add_end_tag;

    error:
        warning(0, "OTA compiler: Unknown tag '%s' in OTA SyncSettings source",
                octstr_get_cstr(name));
        octstr_destroy(content);
        octstr_destroy(name);
        return -1;
}

Variable Documentation

oma_ota_attributes

ota_3table_t oma_ota_attributes[]

static

Definition at line 237 of file ota_compiler.c.

Referenced by parse_attribute().

ota_attributes

ota_3table_t ota_attributes[]

static

Definition at line 172 of file ota_compiler.c.

Referenced by parse_attribute().

ota_elements

ota_2table_t ota_elements[]

static

Initial value:

= {
    { "SYNCSETTINGS", 0x15 },
    { "WAP-PROVISIONINGDOC", 0x05 },
    { "CHARACTERISTIC-LIST", 0x05 },
    { "CHARACTERISTIC", 0x06 },
    { "PARM", 0x07 }
}

Definition at line 125 of file ota_compiler.c.

Referenced by parse_element().

ota_syncsettings_elements

ota_2table_t ota_syncsettings_elements[]

static

Initial value:

= {
    { "Addr", 0x45 },
    { "AddrType", 0x46 },
    { "Auth", 0x47 },
    { "AuthLevel", 0x48 },
    { "AuthScheme", 0x49 },
    { "Bearer", 0x4A },
    { "ConRef", 0x4B },
    { "ConType", 0x4C },
    { "Cred", 0x4D },
    { "CTType", 0x4E },
    { "CTVer", 0x4F },
    { "HostAddr", 0x50 },
    { "Name", 0x51 },
    { "Port", 0x52 },
    { "RefID", 0x53 },
    { "RemoteDB", 0x54 },
    { "URI", 0x56 },
    { "Username", 0x57 },
    { "Version", 0x58 }
}

Definition at line 139 of file ota_compiler.c.

Referenced by parse_ota_syncsettings().