/**
* Is XML node name matching?
*/
static gboolean
node_named_as(const xnode_t *xn, void *data)
{
const char *name = xnode_element_name(xn);
return (name != NULL) ? 0 == strcmp(name, cast_to_char_ptr(data)) : FALSE;
}
/* XML helper functions */
static xnode_t *
find_element_by_name(xnode_t *p, const char *name)
{
xnode_t *xn;
for (xn = xnode_first_child(p); xn != NULL; xn = xnode_next_sibling(xn)) {
if (xnode_is_element(xn) && 0 == strcmp(xnode_element_name(xn), name))
return xn;
}
return NULL;
}
/**
* Pass 2 handler on each tree node leave.
*/
static void
xfmt_handle_pass2_leave(void *node, void *data)
{
xnode_t *xn = node;
struct xfmt_pass2 *xp2 = data;
if (xnode_is_element(xn)) {
const char *uri = xnode_element_ns(xn);
xfmt_indent(xp2);
/*
* We don't emit the URI if it is that of the default namespace.
*/
if (
uri != NULL && xp2->default_ns != NULL &&
0 == strcmp(uri, xp2->default_ns)
) {
uri = NULL;
}
if (uri != NULL) {
const char *pre = xfmt_uri_to_prefix(xp2, uri);
ostream_printf(xp2->os, "</%s:%s>", pre, xnode_element_name(xn));
} else {
ostream_printf(xp2->os, "</%s>", xnode_element_name(xn));
}
if (!(xp2->options & XFMT_O_SINGLE_LINE)) {
ostream_putc(xp2->os, '\n');
}
/* Reset for next element */
xp2->had_text = FALSE;
xp2->last_was_nl = TRUE;
}
xfmt_pass2_leaving(xp2);
}
static bool
verify_element(xnode_t *node, const char *prop, const char *expect)
{
const char *value;
value = xnode_prop_get(node, prop);
if (NULL == value) {
if (GNET_PROPERTY(tigertree_debug)) {
g_debug("TTH couldn't find property \"%s\" of node \"%s\"",
prop, xnode_element_name(node));
}
return FALSE;
}
if (0 != strcmp(value, expect)) {
if (GNET_PROPERTY(tigertree_debug)) {
g_debug("TTH property %s/%s doesn't match expected value \"%s\", "
"got \"%s\"",
xnode_element_name(node), prop, expect, value);
}
return FALSE;
}
return TRUE;
}
/**
* Successful SOAP RPC reply callback.
*
* @param sr the SOAP RPC request
* @param root XML tree of SOAP reply
* @param arg the UPnP control request
*/
static void
upnp_ctrl_soap_reply(const soap_rpc_t *sr, xnode_t *root, void *arg)
{
upnp_ctrl_t *ucd = arg;
xnode_t *xn;
nv_table_t *nvt;
void *reply;
size_t reply_len;
host_addr_t local_addr;
int code;
upnp_ctrl_check(ucd);
if (GNET_PROPERTY(upnp_debug) > 1) {
g_debug("UPNP got SOAP reply for %s", ucd->action);
if (GNET_PROPERTY(upnp_debug) > 2)
xfmt_tree_dump(root, stderr);
}
ucd->sr = NULL; /* Done with SOAP request */
if (soap_rpc_local_addr(sr, &local_addr))
upnp_set_local_addr(local_addr);
/*
* Decompile the returned values.
*
* <u:actionResponse xmlns:u="urn:schemas-upnp-org:service:serviceType:v">
* <arg1>out value1</arg1>
* <arg2>out value2</arg2>
* : : : :
* <argn>out valuen</argn>
* </u:actionResponse>
*
* Values are inserted in name / value pairs: "arg1" -> "out value 1" and
* given to the launch callback for extracting and decompiling the values.
*/
nvt = nv_table_make(TRUE);
for (xn = xnode_first_child(root); xn; xn = xnode_next_sibling(xn)) {
nv_pair_t *nv;
xnode_t *xt;
if (!xnode_is_element(xn)) {
if (GNET_PROPERTY(upnp_debug)) {
g_warning("UPNP \"%s\" skipping XML node %s",
ucd->action, xnode_to_string(xn));
}
continue;
}
xt = xnode_first_child(xn);
if (NULL == xt || !xnode_is_text(xt)) {
if (GNET_PROPERTY(upnp_debug)) {
g_warning("UPNP \"%s\" bad child node %s in %s",
ucd->action, xnode_to_string(xt), xnode_to_string2(xn));
}
} else {
/*
* Name/value strings point in the tree, which is going to be
* alive for the duration of the processing, so we can use the
* strings without copying them.
*/
nv = nv_pair_make_static_str(
xnode_element_name(xn), xnode_text(xt));
nv_table_insert_pair(nvt, nv);
if (xnode_next_sibling(xt) != NULL) {
if (GNET_PROPERTY(upnp_debug)) {
g_warning("UPNP \"%s\" content of %s is not pure text",
ucd->action, xnode_to_string(xt));
}
}
}
}
/*
* Attempt to decompile the replied values, if any are expected.
*
* Allocated data is done via walloc(), and the returned structure is flat.
* It will be freed after invoking the user callback.
*/
if (ucd->lcb != NULL) {
reply = (*ucd->lcb)(nvt, &reply_len);
code = NULL == reply ? UPNP_ERR_OK : UPNP_ERR_BAD_REPLY;
} else {
code = UPNP_ERR_OK;
reply = NULL;
reply_len = 0;
}
/*
* Let UPnP control invoker know about the result of the query.
*/
(*ucd->cb)(code, reply, reply_len, ucd->cb_arg);
/*
* Done, final cleanup.
*/
WFREE_NULL(reply, reply_len);
nv_table_free(nvt);
upnp_ctrl_free(ucd);
}
static char *
thex_download_handle_xml(struct thex_download *ctx,
const char *data, size_t size)
{
xnode_t *hashtree = NULL, *node;
char *hashtree_id = NULL;
bool success = FALSE;
vxml_parser_t *vp;
vxml_error_t e;
if (size <= 0) {
if (GNET_PROPERTY(tigertree_debug)) {
g_debug("TTH XML record has no data");
}
goto finish;
}
/*
* Parse the XML record.
*/
vp = vxml_parser_make("THEX record", VXML_O_STRIP_BLANKS);
vxml_parser_add_data(vp, data, size);
e = vxml_parse_tree(vp, &hashtree);
vxml_parser_free(vp);
if (VXML_E_OK != e) {
if (GNET_PROPERTY(tigertree_debug)) {
g_warning("TTH cannot parse XML record: %s", vxml_strerror(e));
dump_hex(stderr, "XML record", data, size);
}
goto finish;
}
if (0 != strcmp("hashtree", xnode_element_name(hashtree))) {
if (GNET_PROPERTY(tigertree_debug)) {
g_debug("TTH couldn't find root hashtree element");
}
goto finish;
}
node = find_element_by_name(hashtree, "file");
if (node) {
if (!verify_element(node, "size", filesize_to_string(ctx->filesize)))
goto finish;
if (!verify_element(node, "segmentsize", THEX_SEGMENT_SIZE))
goto finish;
} else {
if (GNET_PROPERTY(tigertree_debug)) {
g_debug("TTH couldn't find hashtree/file element");
}
goto finish;
}
node = find_element_by_name(hashtree, "digest");
if (node) {
if (!verify_element(node, "algorithm", THEX_HASH_ALGO))
goto finish;
if (!verify_element(node, "outputsize", THEX_HASH_SIZE))
goto finish;
} else {
if (GNET_PROPERTY(tigertree_debug)) {
g_debug("TTH couldn't find hashtree/digest element");
}
goto finish;
}
node = find_element_by_name(hashtree, "serializedtree");
if (node) {
const char *value;
int error;
if (!verify_element(node, "type", THEX_TREE_TYPE))
goto finish;
value = xnode_prop_get(node, "uri");
if (NULL == value) {
if (GNET_PROPERTY(tigertree_debug)) {
g_debug("TTH couldn't find property \"uri\" of node \"%s\"",
xnode_element_name(node));
}
goto finish;
}
hashtree_id = h_strdup(value);
value = xnode_prop_get(node, "depth");
if (NULL == value) {
if (GNET_PROPERTY(tigertree_debug)) {
g_debug("TTH couldn't find property \"depth\" of node \"%s\"",
xnode_element_name(node));
}
goto finish;
}
ctx->depth = parse_uint16(value, NULL, 10, &error);
error |= ctx->depth > tt_full_depth(ctx->filesize);
if (error) {
ctx->depth = 0;
g_warning("TTH bad value for \"depth\" of node \"%s\": \"%s\"",
xnode_element_name(node), value);
}
if (error)
goto finish;
} else {
if (GNET_PROPERTY(tigertree_debug))
g_debug("TTH couldn't find hashtree/serializedtree element");
goto finish;
}
success = TRUE;
finish:
if (!success)
HFREE_NULL(hashtree_id);
xnode_tree_free_null(&hashtree);
return hashtree_id;
}
/**
* Process the SOAP reply from the server.
*/
static void
soap_process_reply(soap_rpc_t *sr)
{
const char *buf;
vxml_parser_t *vp;
vxml_error_t e;
xnode_t *root = NULL;
xnode_t *xn = NULL;
const char *charset;
soap_rpc_check(sr);
if (sr->reply_len != 0 && (GNET_PROPERTY(soap_trace) & SOCK_TRACE_IN)) {
g_debug("----Got SOAP HTTP reply data from %s:", sr->url);
if (log_printable(LOG_STDERR)) {
fwrite(sr->reply_data, sr->reply_len, 1, stderr);
fputs("----End SOAP HTTP reply\n", stderr);
}
}
if (GNET_PROPERTY(soap_debug) > 2) {
g_debug("SOAP \"%s\" at \"%s\": processing reply (%lu byte%s) HTTP %d",
sr->action, sr->url, (unsigned long) sr->reply_len,
1 == sr->reply_len ? "" : "s", sr->http_code);
}
/*
* If we got a 2xx reply, we need to parse up to the <Body> element
* and then pass up the remaining to the user for parsing specific
* elemnts accordingly.
*
* Other reply codes indicate an error. On 4xx replies we may not
* have any XML to parse. On 5xx replies, we should usually have
* a <Fault> indication under the <Body>.
*
* The strategy used here is to parse the XML reply into a tree and then
* analyse the tree, ignoring the HTTP status code which is redundant.
*/
buf = header_get(sr->header, "Content-Type");
if (NULL == buf)
goto no_xml;
/*
* MIME type and subtypes are case-insensitive (see RFC 2616, section 3.7).
*/
if (
!http_field_starts_with(buf, SOAP_TEXT_REPLY, FALSE) &&
!http_field_starts_with(buf, SOAP_APPLICATION_REPLY, FALSE)
) {
if (GNET_PROPERTY(soap_debug)) {
g_debug("SOAP \"%s\" at \"%s\": got unexpected Content-Type: %s",
sr->action, sr->url, buf);
}
goto no_xml;
}
/*
* Extract charset if given.
*/
charset = http_parameter_get(buf, "charset");
/*
* Parse the SOAP envelope.
*/
vp = vxml_parser_make(sr->action, VXML_O_STRIP_BLANKS);
vxml_parser_add_data(vp, sr->reply_data, sr->reply_len);
if (!vxml_parser_set_charset(vp, charset)) {
g_warning("SOAP \"%s\" at \"%s\": ignoring unknown charset \"%s\"",
sr->action, sr->url, charset);
}
e = vxml_parse_tree(vp, &root);
vxml_parser_free(vp);
if (e != VXML_E_OK) {
if (GNET_PROPERTY(soap_debug)) {
g_debug("SOAP \"%s\" at \"%s\": cannot parse XML reply: %s",
sr->action, sr->url, vxml_strerror(e));
}
goto bad_xml;
}
g_assert(root != NULL);
/*
* Make sure we got a SOAP reply.
*/
if (!xnode_is_element_named(root, SOAP_NAMESPACE, SOAP_X_ENVELOPE))
goto not_soap;
/*
* Look for the <SOAP:Body> element.
*/
for (xn = xnode_first_child(root); TRUE; xn = xnode_next_sibling(xn)) {
if (NULL == xn || !xnode_within_namespace(xn, SOAP_NAMESPACE))
goto bad_soap;
if (0 == strcmp(SOAP_X_BODY, xnode_element_name(xn)))
break;
}
/*
* Inspect the first child of the <SOAP:Body> element.
*
* If it's a <SOAP:Fault>, go process it and return an error.
* If it's another SOAP tag, we have an unknown structure.
* Otherwise it's the reply, for user code to handle.
*/
xn = xnode_first_child(xn);
if (NULL == xn)
goto bad_soap;
if (xnode_is_element_named(xn, SOAP_NAMESPACE, SOAP_X_FAULT)) {
xnode_detach(xn);
soap_fault(sr, xn);
} else if (xnode_within_namespace(xn, SOAP_NAMESPACE)) {
goto bad_soap;
} else {
xnode_detach(xn);
soap_reply(sr, xn);
}
xnode_tree_free(root);
return;
not_soap:
if (GNET_PROPERTY(soap_debug)) {
g_debug("SOAP \"%s\" at \"%s\": unexpected root XML "
"element <%s:%s>",
sr->action, sr->url, EMPTY_STRING(xnode_element_ns(root)),
xnode_element_name(root));
}
xnode_tree_free(root);
/* FALL THROUGH */
no_xml:
soap_error(sr, SOAP_E_PROTOCOL);
return;
bad_soap:
if (GNET_PROPERTY(soap_debug)) {
g_debug("SOAP \"%s\" at \"%s\": unexpected XML structure",
sr->action, sr->url);
}
if (GNET_PROPERTY(soap_debug) > 1) {
g_debug("SOAP current node is %s", xnode_to_string(xn));
}
if (GNET_PROPERTY(soap_debug) > 2)
xfmt_tree_dump(root, stderr);
xnode_tree_free(root);
/* FALL THROUGH */
bad_xml:
soap_error(sr, SOAP_E_PROCESSING);
return;
}
/**
* Pass 2 handler on each tree node entry.
*/
static bool
xfmt_handle_pass2_enter(const void *node, void *data)
{
const xnode_t *xn = node;
struct xfmt_pass2 *xp2 = data;
xp2->depth++;
if (xnode_is_element(xn)) {
GSList *ns = xfmt_ns_declarations(xp2, xn);
const char *nsuri = xnode_element_ns(xn);
if (!xp2->had_text && !xp2->last_was_nl) {
if (!(xp2->options & XFMT_O_SINGLE_LINE))
ostream_putc(xp2->os, '\n');
xp2->last_was_nl = TRUE;
}
xfmt_indent(xp2);
/*
* Look for the namespace matching the default namespace, in which
* case we don't have to emit it.
*/
if (
nsuri != NULL && xp2->default_ns != NULL &&
0 == strcmp(nsuri, xp2->default_ns)
) {
nsuri = NULL;
}
if (nsuri != NULL) {
const char *prefix = xfmt_uri_to_prefix(xp2, nsuri);
ostream_printf(xp2->os, "<%s:%s", prefix, xnode_element_name(xn));
} else {
ostream_printf(xp2->os, "<%s", xnode_element_name(xn));
}
/*
* Install default namespace on the root element, if any.
*/
if (1 == xp2->depth && xp2->default_ns != NULL) {
int c = xfmt_quoting_char(xp2->default_ns);
g_assert(c != '\0');
ostream_printf(xp2->os, " xmlns=%c%s%c", c, xp2->default_ns, c);
}
/*
* Declare namespaces for the element's scope.
*/
xfmt_pass2_declare_ns(xp2, ns);
g_slist_free(ns);
/*
* Emit attributes.
*/
xnode_prop_foreach(xn, xfmt_handle_pass2_attr, xp2);
/*
* Handle content-less elements specially: we don't let the
* "leave" callback run.
*
* We consider an element with a single empty text child as
* content-less, so we test with xnode_is_empty() instead of
* !xnode_has_content().
*/
xp2->had_text = FALSE;
if (xnode_is_empty(xn)) {
ostream_write(xp2->os, XFMT_EMPTY, CONST_STRLEN(XFMT_EMPTY));
if (!(xp2->options & XFMT_O_SINGLE_LINE))
ostream_putc(xp2->os, '\n');
xp2->last_was_nl = TRUE;
xfmt_pass2_leaving(xp2); /* No children, no "leave" callback */
return FALSE;
}
ostream_write(xp2->os, XFMT_GT, CONST_STRLEN(XFMT_GT));
xp2->last_was_nl = FALSE;
} else if (xnode_is_text(xn)) {
const char *text = xnode_text(xn);
size_t len;
size_t overhead;
bool amp;
if (xp2->options & XFMT_O_SKIP_BLANKS) {
const char *start;
size_t tlen;
start = xfmt_strip_blanks(text, &tlen);
if (0 == tlen)
goto ignore;
/* FIXME: handle blank collapsing */
(void) start;
}
/*
* If text is known to have entities, we must not escape the '&'.
* This means the generated XML must define that entity in the DTD
* part of the tree.
*
* Computes the required overhead to fully escape the text (0 meaning
* that no escaping is required). If the overhead is larger than
* a leading "<![CDATA[" and a closing ""]]>", we can emit a CDATA
* section instead, provided the text does not contain "]]>".
*/
amp = !xnode_text_has_entities(xn);
overhead = xfmt_text_escape_overhead(text, amp, FALSE, &len);
if (0 == overhead) {
ostream_write(xp2->os, text, len);
} else if (
overhead >= XFMT_CDATA_OVERHEAD &&
NULL == strstr(text, XFMT_CDATA_END)
) {
ostream_write(xp2->os,
XFMT_CDATA_START, CONST_STRLEN(XFMT_CDATA_START));
ostream_write(xp2->os, text, len);
ostream_write(xp2->os,
XFMT_CDATA_END, CONST_STRLEN(XFMT_CDATA_END));
} else {
char *escaped = xfmt_text_escape(text, amp, FALSE, len + overhead);
ostream_write(xp2->os, escaped, len + overhead);
hfree(escaped);
}
xp2->last_was_nl = FALSE;
xp2->had_text = TRUE;
}
ignore:
return TRUE;
}
