Age Owner Branch data TLA Line data Source code
1 : : /*
2 : : * contrib/xml2/xpath.c
3 : : *
4 : : * Parser interface for DOM-based parser (libxml) rather than
5 : : * stream-based SAX-type parser
6 : : */
7 : : #include "postgres.h"
8 : :
9 : : #include "access/htup_details.h"
10 : : #include "executor/spi.h"
11 : : #include "fmgr.h"
12 : : #include "funcapi.h"
13 : : #include "lib/stringinfo.h"
14 : : #include "utils/builtins.h"
15 : : #include "utils/xml.h"
16 : :
17 : : /* libxml includes */
18 : :
19 : : #include <libxml/xpath.h>
20 : : #include <libxml/tree.h>
21 : : #include <libxml/xmlmemory.h>
22 : : #include <libxml/xmlerror.h>
23 : : #include <libxml/parserInternals.h>
24 : :
164 tgl@sss.pgh.pa.us 25 :CBC 1 : PG_MODULE_MAGIC_EXT(
26 : : .name = "xml2",
27 : : .version = PG_VERSION
28 : : );
29 : :
30 : : /* exported for use by xslt_proc.c */
31 : :
32 : : PgXmlErrorContext *pgxml_parser_init(PgXmlStrictness strictness);
33 : :
34 : : /* workspace for pgxml_xpath() */
35 : :
36 : : typedef struct
37 : : {
38 : : xmlDocPtr doctree;
39 : : xmlXPathContextPtr ctxt;
40 : : xmlXPathObjectPtr res;
41 : : } xpath_workspace;
42 : :
43 : : /* local declarations */
44 : :
45 : : static xmlChar *pgxmlNodeSetToText(xmlNodeSetPtr nodeset,
46 : : xmlChar *toptagname, xmlChar *septagname,
47 : : xmlChar *plainsep);
48 : :
49 : : static text *pgxml_result_to_text(xmlXPathObjectPtr res, xmlChar *toptag,
50 : : xmlChar *septag, xmlChar *plainsep);
51 : :
52 : : static xmlChar *pgxml_texttoxmlchar(text *textstring);
53 : :
54 : : static xpath_workspace *pgxml_xpath(text *document, xmlChar *xpath,
55 : : PgXmlErrorContext *xmlerrcxt);
56 : :
57 : : static void cleanup_workspace(xpath_workspace *workspace);
58 : :
59 : :
60 : : /*
61 : : * Initialize for xml parsing.
62 : : *
63 : : * As with the underlying pg_xml_init function, calls to this MUST be followed
64 : : * by a PG_TRY block that guarantees that pg_xml_done is called.
65 : : */
66 : : PgXmlErrorContext *
5162 67 : 16 : pgxml_parser_init(PgXmlStrictness strictness)
68 : : {
69 : : PgXmlErrorContext *xmlerrcxt;
70 : :
71 : : /* Set up error handling (we share the core's error handler) */
72 : 16 : xmlerrcxt = pg_xml_init(strictness);
73 : :
74 : : /* Note: we're assuming an elog cannot be thrown by the following calls */
75 : :
76 : : /* Initialize libxml */
5669 77 : 16 : xmlInitParser();
78 : :
5162 79 : 16 : return xmlerrcxt;
80 : : }
81 : :
82 : :
83 : : /* Encodes special characters (<, >, &, " and \r) as XML entities */
84 : :
7583 bruce@momjian.us 85 : 1 : PG_FUNCTION_INFO_V1(xml_encode_special_chars);
86 : :
87 : : Datum
7583 bruce@momjian.us 88 :UBC 0 : xml_encode_special_chars(PG_FUNCTION_ARGS)
89 : : {
3100 noah@leadboat.com 90 : 0 : text *tin = PG_GETARG_TEXT_PP(0);
60 tgl@sss.pgh.pa.us 91 :UNC 0 : text *volatile tout = NULL;
92 : 0 : xmlChar *volatile tt = NULL;
93 : : PgXmlErrorContext *xmlerrcxt;
94 : :
67 michael@paquier.xyz 95 : 0 : xmlerrcxt = pg_xml_init(PG_XML_STRICTNESS_ALL);
96 : :
97 [ # # ]: 0 : PG_TRY();
98 : : {
99 : : xmlChar *ts;
100 : :
101 : 0 : ts = pgxml_texttoxmlchar(tin);
102 : :
103 : 0 : tt = xmlEncodeSpecialChars(NULL, ts);
104 [ # # # # ]: 0 : if (tt == NULL || pg_xml_error_occurred(xmlerrcxt))
105 : 0 : xml_ereport(xmlerrcxt, ERROR, ERRCODE_OUT_OF_MEMORY,
106 : : "could not allocate xmlChar");
107 : 0 : pfree(ts);
108 : :
109 : 0 : tout = cstring_to_text((char *) tt);
110 : : }
111 : 0 : PG_CATCH();
112 : : {
113 [ # # ]: 0 : if (tt != NULL)
60 tgl@sss.pgh.pa.us 114 : 0 : xmlFree(tt);
115 : :
67 michael@paquier.xyz 116 : 0 : pg_xml_done(xmlerrcxt, true);
117 : :
118 : 0 : PG_RE_THROW();
119 : : }
120 [ # # ]: 0 : PG_END_TRY();
121 : :
122 [ # # ]: 0 : if (tt != NULL)
60 tgl@sss.pgh.pa.us 123 : 0 : xmlFree(tt);
124 : :
67 michael@paquier.xyz 125 : 0 : pg_xml_done(xmlerrcxt, false);
126 : :
7583 bruce@momjian.us 127 :UBC 0 : PG_RETURN_TEXT_P(tout);
128 : : }
129 : :
130 : : /*
131 : : * Function translates a nodeset into a text representation
132 : : *
133 : : * iterates over each node in the set and calls xmlNodeDump to write it to
134 : : * an xmlBuffer -from which an xmlChar * string is returned.
135 : : *
136 : : * each representation is surrounded by <tagname> ... </tagname>
137 : : *
138 : : * plainsep is an ordinary (not tag) separator - if used, then nodes are
139 : : * cast to string as output method
140 : : */
141 : : static xmlChar *
7855 bruce@momjian.us 142 :CBC 5 : pgxmlNodeSetToText(xmlNodeSetPtr nodeset,
143 : : xmlChar *toptagname,
144 : : xmlChar *septagname,
145 : : xmlChar *plainsep)
146 : : {
67 michael@paquier.xyz 147 :GNC 5 : volatile xmlBufferPtr buf = NULL;
60 tgl@sss.pgh.pa.us 148 : 5 : xmlChar *volatile result = NULL;
149 : : PgXmlErrorContext *xmlerrcxt;
150 : :
151 : : /* spin up some error handling */
67 michael@paquier.xyz 152 : 5 : xmlerrcxt = pg_xml_init(PG_XML_STRICTNESS_ALL);
153 : :
154 [ + - ]: 5 : PG_TRY();
155 : : {
156 : 5 : buf = xmlBufferCreate();
157 : :
158 [ + - - + ]: 5 : if (buf == NULL || pg_xml_error_occurred(xmlerrcxt))
67 michael@paquier.xyz 159 :UNC 0 : xml_ereport(xmlerrcxt, ERROR, ERRCODE_OUT_OF_MEMORY,
160 : : "could not allocate xmlBuffer");
161 : :
67 michael@paquier.xyz 162 [ + + + + ]:GNC 5 : if ((toptagname != NULL) && (xmlStrlen(toptagname) > 0))
163 : : {
164 : 1 : xmlBufferWriteChar(buf, "<");
165 : 1 : xmlBufferWriteCHAR(buf, toptagname);
166 : 1 : xmlBufferWriteChar(buf, ">");
167 : : }
168 [ + - ]: 5 : if (nodeset != NULL)
169 : : {
60 tgl@sss.pgh.pa.us 170 [ + + ]: 15 : for (int i = 0; i < nodeset->nodeNr; i++)
171 : : {
67 michael@paquier.xyz 172 [ + + ]: 10 : if (plainsep != NULL)
173 : : {
174 : 4 : xmlBufferWriteCHAR(buf,
175 : 4 : xmlXPathCastNodeToString(nodeset->nodeTab[i]));
176 : :
177 : : /* If this isn't the last entry, write the plain sep. */
178 [ + + ]: 4 : if (i < (nodeset->nodeNr) - 1)
179 : 2 : xmlBufferWriteChar(buf, (char *) plainsep);
180 : : }
181 : : else
182 : : {
183 [ + - + + ]: 6 : if ((septagname != NULL) && (xmlStrlen(septagname) > 0))
184 : : {
185 : 4 : xmlBufferWriteChar(buf, "<");
186 : 4 : xmlBufferWriteCHAR(buf, septagname);
187 : 4 : xmlBufferWriteChar(buf, ">");
188 : : }
189 : 6 : xmlNodeDump(buf,
190 : 6 : nodeset->nodeTab[i]->doc,
191 : 6 : nodeset->nodeTab[i],
192 : : 1, 0);
193 : :
194 [ + - + + ]: 6 : if ((septagname != NULL) && (xmlStrlen(septagname) > 0))
195 : : {
196 : 4 : xmlBufferWriteChar(buf, "</");
197 : 4 : xmlBufferWriteCHAR(buf, septagname);
198 : 4 : xmlBufferWriteChar(buf, ">");
199 : : }
200 : : }
201 : : }
202 : : }
203 : :
204 [ + + + + ]: 5 : if ((toptagname != NULL) && (xmlStrlen(toptagname) > 0))
205 : : {
206 : 1 : xmlBufferWriteChar(buf, "</");
207 : 1 : xmlBufferWriteCHAR(buf, toptagname);
208 : 1 : xmlBufferWriteChar(buf, ">");
209 : : }
210 : :
61 211 : 5 : result = xmlStrdup(xmlBufferContent(buf));
67 212 [ + - - + ]: 5 : if (result == NULL || pg_xml_error_occurred(xmlerrcxt))
67 michael@paquier.xyz 213 :UNC 0 : xml_ereport(xmlerrcxt, ERROR, ERRCODE_OUT_OF_MEMORY,
214 : : "could not allocate result");
215 : : }
216 : 0 : PG_CATCH();
217 : : {
218 [ # # ]: 0 : if (buf)
219 : 0 : xmlBufferFree(buf);
220 : :
221 : 0 : pg_xml_done(xmlerrcxt, true);
222 : :
223 : 0 : PG_RE_THROW();
224 : : }
67 michael@paquier.xyz 225 [ - + ]:GNC 5 : PG_END_TRY();
226 : :
7855 bruce@momjian.us 227 :CBC 5 : xmlBufferFree(buf);
67 michael@paquier.xyz 228 :GNC 5 : pg_xml_done(xmlerrcxt, false);
229 : :
7855 bruce@momjian.us 230 :CBC 5 : return result;
231 : : }
232 : :
233 : :
234 : : /* Translate a PostgreSQL "varlena" -i.e. a variable length parameter
235 : : * into the libxml2 representation
236 : : */
237 : : static xmlChar *
238 : 13 : pgxml_texttoxmlchar(text *textstring)
239 : : {
6334 tgl@sss.pgh.pa.us 240 : 13 : return (xmlChar *) text_to_cstring(textstring);
241 : : }
242 : :
243 : : /* Publicly visible XPath functions */
244 : :
245 : : /*
246 : : * This is a "raw" xpath function. Check that it returns child elements
247 : : * properly
248 : : */
7855 bruce@momjian.us 249 : 2 : PG_FUNCTION_INFO_V1(xpath_nodeset);
250 : :
251 : : Datum
252 : 3 : xpath_nodeset(PG_FUNCTION_ARGS)
253 : : {
3100 noah@leadboat.com 254 : 3 : text *document = PG_GETARG_TEXT_PP(0);
2999 tgl@sss.pgh.pa.us 255 : 3 : text *xpathsupp = PG_GETARG_TEXT_PP(1); /* XPath expression */
3100 noah@leadboat.com 256 : 3 : xmlChar *toptag = pgxml_texttoxmlchar(PG_GETARG_TEXT_PP(2));
257 : 3 : xmlChar *septag = pgxml_texttoxmlchar(PG_GETARG_TEXT_PP(3));
258 : : xmlChar *xpath;
60 tgl@sss.pgh.pa.us 259 :GNC 3 : text *volatile xpres = NULL;
260 : 3 : xpath_workspace *volatile workspace = NULL;
261 : : PgXmlErrorContext *xmlerrcxt;
262 : :
5398 tgl@sss.pgh.pa.us 263 :CBC 3 : xpath = pgxml_texttoxmlchar(xpathsupp);
67 michael@paquier.xyz 264 :GNC 3 : xmlerrcxt = pgxml_parser_init(PG_XML_STRICTNESS_LEGACY);
265 : :
266 [ + - ]: 3 : PG_TRY();
267 : : {
268 : 3 : workspace = pgxml_xpath(document, xpath, xmlerrcxt);
269 : 3 : xpres = pgxml_result_to_text(workspace->res, toptag, septag, NULL);
270 : : }
67 michael@paquier.xyz 271 :UNC 0 : PG_CATCH();
272 : : {
273 [ # # ]: 0 : if (workspace)
274 : 0 : cleanup_workspace(workspace);
275 : :
276 : 0 : pg_xml_done(xmlerrcxt, true);
277 : 0 : PG_RE_THROW();
278 : : }
67 michael@paquier.xyz 279 [ - + ]:GNC 3 : PG_END_TRY();
280 : :
281 : 3 : cleanup_workspace(workspace);
282 : 3 : pg_xml_done(xmlerrcxt, false);
283 : :
7633 neilc@samurai.com 284 :CBC 3 : pfree(xpath);
285 : :
7678 bruce@momjian.us 286 [ - + ]: 3 : if (xpres == NULL)
7678 bruce@momjian.us 287 :UBC 0 : PG_RETURN_NULL();
7855 bruce@momjian.us 288 :CBC 3 : PG_RETURN_TEXT_P(xpres);
289 : : }
290 : :
291 : : /*
292 : : * The following function is almost identical, but returns the elements in
293 : : * a list.
294 : : */
295 : 2 : PG_FUNCTION_INFO_V1(xpath_list);
296 : :
297 : : Datum
298 : 2 : xpath_list(PG_FUNCTION_ARGS)
299 : : {
3100 noah@leadboat.com 300 : 2 : text *document = PG_GETARG_TEXT_PP(0);
2999 tgl@sss.pgh.pa.us 301 : 2 : text *xpathsupp = PG_GETARG_TEXT_PP(1); /* XPath expression */
3100 noah@leadboat.com 302 : 2 : xmlChar *plainsep = pgxml_texttoxmlchar(PG_GETARG_TEXT_PP(2));
303 : : xmlChar *xpath;
60 tgl@sss.pgh.pa.us 304 :GNC 2 : text *volatile xpres = NULL;
305 : 2 : xpath_workspace *volatile workspace = NULL;
306 : : PgXmlErrorContext *xmlerrcxt;
307 : :
5398 tgl@sss.pgh.pa.us 308 :CBC 2 : xpath = pgxml_texttoxmlchar(xpathsupp);
67 michael@paquier.xyz 309 :GNC 2 : xmlerrcxt = pgxml_parser_init(PG_XML_STRICTNESS_LEGACY);
310 : :
311 [ + - ]: 2 : PG_TRY();
312 : : {
313 : 2 : workspace = pgxml_xpath(document, xpath, xmlerrcxt);
314 : 2 : xpres = pgxml_result_to_text(workspace->res, NULL, NULL, plainsep);
315 : : }
67 michael@paquier.xyz 316 :UNC 0 : PG_CATCH();
317 : : {
318 [ # # ]: 0 : if (workspace)
319 : 0 : cleanup_workspace(workspace);
320 : :
321 : 0 : pg_xml_done(xmlerrcxt, true);
322 : 0 : PG_RE_THROW();
323 : : }
67 michael@paquier.xyz 324 [ - + ]:GNC 2 : PG_END_TRY();
325 : :
326 : 2 : cleanup_workspace(workspace);
327 : 2 : pg_xml_done(xmlerrcxt, false);
328 : :
7633 neilc@samurai.com 329 :CBC 2 : pfree(xpath);
330 : :
7678 bruce@momjian.us 331 [ - + ]: 2 : if (xpres == NULL)
7678 bruce@momjian.us 332 :UBC 0 : PG_RETURN_NULL();
7855 bruce@momjian.us 333 :CBC 2 : PG_RETURN_TEXT_P(xpres);
334 : : }
335 : :
336 : :
337 : 2 : PG_FUNCTION_INFO_V1(xpath_string);
338 : :
339 : : Datum
340 : 1 : xpath_string(PG_FUNCTION_ARGS)
341 : : {
3100 noah@leadboat.com 342 : 1 : text *document = PG_GETARG_TEXT_PP(0);
2999 tgl@sss.pgh.pa.us 343 : 1 : text *xpathsupp = PG_GETARG_TEXT_PP(1); /* XPath expression */
344 : : xmlChar *xpath;
345 : : int32 pathsize;
60 tgl@sss.pgh.pa.us 346 :GNC 1 : text *volatile xpres = NULL;
347 : 1 : xpath_workspace *volatile workspace = NULL;
348 : : PgXmlErrorContext *xmlerrcxt;
349 : :
3100 noah@leadboat.com 350 [ - + - - :CBC 1 : pathsize = VARSIZE_ANY_EXHDR(xpathsupp);
- - - - +
- ]
351 : :
352 : : /*
353 : : * We encapsulate the supplied path with "string()" = 8 chars + 1 for NUL
354 : : * at end
355 : : */
356 : : /* We could try casting to string using the libxml function? */
357 : :
7678 bruce@momjian.us 358 : 1 : xpath = (xmlChar *) palloc(pathsize + 9);
206 peter@eisentraut.org 359 : 1 : memcpy(xpath, "string(", 7);
360 [ + - ]: 1 : memcpy(xpath + 7, VARDATA_ANY(xpathsupp), pathsize);
7678 bruce@momjian.us 361 : 1 : xpath[pathsize + 7] = ')';
362 : 1 : xpath[pathsize + 8] = '\0';
363 : :
67 michael@paquier.xyz 364 :GNC 1 : xmlerrcxt = pgxml_parser_init(PG_XML_STRICTNESS_LEGACY);
365 : :
366 [ + - ]: 1 : PG_TRY();
367 : : {
368 : 1 : workspace = pgxml_xpath(document, xpath, xmlerrcxt);
369 : 1 : xpres = pgxml_result_to_text(workspace->res, NULL, NULL, NULL);
370 : : }
67 michael@paquier.xyz 371 :UNC 0 : PG_CATCH();
372 : : {
373 [ # # ]: 0 : if (workspace)
374 : 0 : cleanup_workspace(workspace);
375 : :
376 : 0 : pg_xml_done(xmlerrcxt, true);
377 : 0 : PG_RE_THROW();
378 : : }
67 michael@paquier.xyz 379 [ - + ]:GNC 1 : PG_END_TRY();
380 : :
381 : 1 : cleanup_workspace(workspace);
382 : 1 : pg_xml_done(xmlerrcxt, false);
383 : :
7633 neilc@samurai.com 384 :CBC 1 : pfree(xpath);
385 : :
7678 bruce@momjian.us 386 [ + - ]: 1 : if (xpres == NULL)
387 : 1 : PG_RETURN_NULL();
7855 bruce@momjian.us 388 :UBC 0 : PG_RETURN_TEXT_P(xpres);
389 : : }
390 : :
391 : :
7855 bruce@momjian.us 392 :CBC 1 : PG_FUNCTION_INFO_V1(xpath_number);
393 : :
394 : : Datum
7855 bruce@momjian.us 395 :UBC 0 : xpath_number(PG_FUNCTION_ARGS)
396 : : {
3100 noah@leadboat.com 397 : 0 : text *document = PG_GETARG_TEXT_PP(0);
2999 tgl@sss.pgh.pa.us 398 : 0 : text *xpathsupp = PG_GETARG_TEXT_PP(1); /* XPath expression */
399 : : xmlChar *xpath;
60 tgl@sss.pgh.pa.us 400 :UNC 0 : volatile float4 fRes = 0.0;
401 : 0 : volatile bool isNull = false;
402 : 0 : xpath_workspace *volatile workspace = NULL;
403 : : PgXmlErrorContext *xmlerrcxt;
404 : :
7855 bruce@momjian.us 405 :UBC 0 : xpath = pgxml_texttoxmlchar(xpathsupp);
67 michael@paquier.xyz 406 :UNC 0 : xmlerrcxt = pgxml_parser_init(PG_XML_STRICTNESS_LEGACY);
407 : :
408 [ # # ]: 0 : PG_TRY();
409 : : {
410 : 0 : workspace = pgxml_xpath(document, xpath, xmlerrcxt);
411 : 0 : pfree(xpath);
412 : :
413 [ # # ]: 0 : if (workspace->res == NULL)
414 : 0 : isNull = true;
415 : : else
416 : 0 : fRes = xmlXPathCastToNumber(workspace->res);
417 : : }
418 : 0 : PG_CATCH();
419 : : {
420 [ # # ]: 0 : if (workspace)
421 : 0 : cleanup_workspace(workspace);
422 : :
423 : 0 : pg_xml_done(xmlerrcxt, true);
424 : 0 : PG_RE_THROW();
425 : : }
426 [ # # ]: 0 : PG_END_TRY();
427 : :
428 : 0 : cleanup_workspace(workspace);
429 : 0 : pg_xml_done(xmlerrcxt, false);
430 : :
431 [ # # # # ]: 0 : if (isNull || xmlXPathIsNaN(fRes))
7678 bruce@momjian.us 432 :UBC 0 : PG_RETURN_NULL();
433 : :
7855 434 : 0 : PG_RETURN_FLOAT4(fRes);
435 : : }
436 : :
437 : :
7855 bruce@momjian.us 438 :CBC 1 : PG_FUNCTION_INFO_V1(xpath_bool);
439 : :
440 : : Datum
7855 bruce@momjian.us 441 :UBC 0 : xpath_bool(PG_FUNCTION_ARGS)
442 : : {
3100 noah@leadboat.com 443 : 0 : text *document = PG_GETARG_TEXT_PP(0);
2999 tgl@sss.pgh.pa.us 444 : 0 : text *xpathsupp = PG_GETARG_TEXT_PP(1); /* XPath expression */
445 : : xmlChar *xpath;
60 tgl@sss.pgh.pa.us 446 :UNC 0 : volatile int bRes = 0;
447 : 0 : xpath_workspace *volatile workspace = NULL;
448 : : PgXmlErrorContext *xmlerrcxt;
449 : :
7855 bruce@momjian.us 450 :UBC 0 : xpath = pgxml_texttoxmlchar(xpathsupp);
67 michael@paquier.xyz 451 :UNC 0 : xmlerrcxt = pgxml_parser_init(PG_XML_STRICTNESS_LEGACY);
452 : :
453 [ # # ]: 0 : PG_TRY();
454 : : {
455 : 0 : workspace = pgxml_xpath(document, xpath, xmlerrcxt);
456 : 0 : pfree(xpath);
457 : :
458 [ # # ]: 0 : if (workspace->res == NULL)
459 : 0 : bRes = 0;
460 : : else
461 : 0 : bRes = xmlXPathCastToBoolean(workspace->res);
462 : : }
463 : 0 : PG_CATCH();
464 : : {
465 [ # # ]: 0 : if (workspace)
466 : 0 : cleanup_workspace(workspace);
467 : :
468 : 0 : pg_xml_done(xmlerrcxt, true);
469 : 0 : PG_RE_THROW();
470 : : }
471 [ # # ]: 0 : PG_END_TRY();
472 : :
473 : 0 : cleanup_workspace(workspace);
474 : 0 : pg_xml_done(xmlerrcxt, false);
475 : :
7855 bruce@momjian.us 476 :UBC 0 : PG_RETURN_BOOL(bRes);
477 : : }
478 : :
479 : :
480 : :
481 : : /* Core function to evaluate XPath query */
482 : :
483 : : static xpath_workspace *
67 michael@paquier.xyz 484 :GNC 6 : pgxml_xpath(text *document, xmlChar *xpath, PgXmlErrorContext *xmlerrcxt)
485 : : {
3100 noah@leadboat.com 486 [ - + - - :CBC 6 : int32 docsize = VARSIZE_ANY_EXHDR(document);
- - - - +
+ ]
487 : : xmlXPathCompExprPtr comppath;
488 : : xpath_workspace *workspace = (xpath_workspace *)
67 michael@paquier.xyz 489 :GNC 6 : palloc0(sizeof(xpath_workspace));
490 : :
5398 tgl@sss.pgh.pa.us 491 :CBC 6 : workspace->doctree = NULL;
492 : 6 : workspace->ctxt = NULL;
493 : 6 : workspace->res = NULL;
494 : :
67 michael@paquier.xyz 495 :GNC 6 : workspace->doctree = xmlReadMemory((char *) VARDATA_ANY(document),
496 : : docsize, NULL, NULL,
497 : : XML_PARSE_NOENT);
498 [ + + ]: 6 : if (workspace->doctree != NULL)
499 : : {
500 : 5 : workspace->ctxt = xmlXPathNewContext(workspace->doctree);
501 : 5 : workspace->ctxt->node = xmlDocGetRootElement(workspace->doctree);
502 : :
503 : : /* compile the path */
504 : 5 : comppath = xmlXPathCtxtCompile(workspace->ctxt, xpath);
505 [ + - - + ]: 5 : if (comppath == NULL || pg_xml_error_occurred(xmlerrcxt))
67 michael@paquier.xyz 506 :UNC 0 : xml_ereport(xmlerrcxt, ERROR, ERRCODE_INVALID_ARGUMENT_FOR_XQUERY,
507 : : "XPath Syntax Error");
508 : :
509 : : /* Now evaluate the path expression. */
67 michael@paquier.xyz 510 :GNC 5 : workspace->res = xmlXPathCompiledEval(comppath, workspace->ctxt);
511 : :
512 : 5 : xmlXPathFreeCompExpr(comppath);
513 : : }
514 : :
515 : 6 : return workspace;
516 : : }
517 : :
518 : : /* Clean up after processing the result of pgxml_xpath() */
519 : : static void
60 tgl@sss.pgh.pa.us 520 :CBC 6 : cleanup_workspace(xpath_workspace *workspace)
521 : : {
5398 522 [ + + ]: 6 : if (workspace->res)
523 : 5 : xmlXPathFreeObject(workspace->res);
524 : 6 : workspace->res = NULL;
525 [ + + ]: 6 : if (workspace->ctxt)
526 : 5 : xmlXPathFreeContext(workspace->ctxt);
527 : 6 : workspace->ctxt = NULL;
528 [ + + ]: 6 : if (workspace->doctree)
529 : 5 : xmlFreeDoc(workspace->doctree);
530 : 6 : workspace->doctree = NULL;
531 : 6 : }
532 : :
533 : : static text *
7678 bruce@momjian.us 534 : 6 : pgxml_result_to_text(xmlXPathObjectPtr res,
535 : : xmlChar *toptag,
536 : : xmlChar *septag,
537 : : xmlChar *plainsep)
538 : : {
60 tgl@sss.pgh.pa.us 539 :GNC 6 : xmlChar *volatile xpresstr = NULL;
540 : 6 : text *volatile xpres = NULL;
541 : : PgXmlErrorContext *xmlerrcxt;
542 : :
7678 bruce@momjian.us 543 [ + + ]:CBC 6 : if (res == NULL)
544 : 1 : return NULL;
545 : :
546 : : /* spin some error handling */
67 michael@paquier.xyz 547 :GNC 5 : xmlerrcxt = pg_xml_init(PG_XML_STRICTNESS_ALL);
548 : :
549 [ + - ]: 5 : PG_TRY();
550 : : {
551 [ + - - ]: 5 : switch (res->type)
552 : : {
553 : 5 : case XPATH_NODESET:
554 : 5 : xpresstr = pgxmlNodeSetToText(res->nodesetval,
555 : : toptag,
556 : : septag, plainsep);
557 : 5 : break;
558 : :
67 michael@paquier.xyz 559 :UNC 0 : case XPATH_STRING:
560 : 0 : xpresstr = xmlStrdup(res->stringval);
561 [ # # # # ]: 0 : if (xpresstr == NULL || pg_xml_error_occurred(xmlerrcxt))
562 : 0 : xml_ereport(xmlerrcxt, ERROR, ERRCODE_OUT_OF_MEMORY,
563 : : "could not allocate result");
564 : 0 : break;
565 : :
566 : 0 : default:
567 [ # # ]: 0 : elog(NOTICE, "unsupported XQuery result: %d", res->type);
568 : 0 : xpresstr = xmlStrdup((const xmlChar *) "<unsupported/>");
569 [ # # # # ]: 0 : if (xpresstr == NULL || pg_xml_error_occurred(xmlerrcxt))
570 : 0 : xml_ereport(xmlerrcxt, ERROR, ERRCODE_OUT_OF_MEMORY,
571 : : "could not allocate result");
572 : : }
573 : :
574 : : /* Now convert this result back to text */
67 michael@paquier.xyz 575 :GNC 5 : xpres = cstring_to_text((char *) xpresstr);
576 : : }
67 michael@paquier.xyz 577 :UNC 0 : PG_CATCH();
578 : : {
579 [ # # ]: 0 : if (xpresstr != NULL)
60 tgl@sss.pgh.pa.us 580 : 0 : xmlFree(xpresstr);
581 : :
67 michael@paquier.xyz 582 : 0 : pg_xml_done(xmlerrcxt, true);
583 : :
584 : 0 : PG_RE_THROW();
585 : : }
67 michael@paquier.xyz 586 [ - + ]:GNC 5 : PG_END_TRY();
587 : :
588 : : /* Free various storage */
60 tgl@sss.pgh.pa.us 589 :CBC 5 : xmlFree(xpresstr);
590 : :
67 michael@paquier.xyz 591 :GNC 5 : pg_xml_done(xmlerrcxt, false);
592 : :
7855 bruce@momjian.us 593 :CBC 5 : return xpres;
594 : : }
595 : :
596 : : /*
597 : : * xpath_table is a table function. It needs some tidying (as do the
598 : : * other functions here!
599 : : */
600 : 2 : PG_FUNCTION_INFO_V1(xpath_table);
601 : :
602 : : Datum
7678 603 : 5 : xpath_table(PG_FUNCTION_ARGS)
604 : : {
605 : : /* Function parameters */
5669 tgl@sss.pgh.pa.us 606 : 5 : char *pkeyfield = text_to_cstring(PG_GETARG_TEXT_PP(0));
607 : 5 : char *xmlfield = text_to_cstring(PG_GETARG_TEXT_PP(1));
608 : 5 : char *relname = text_to_cstring(PG_GETARG_TEXT_PP(2));
609 : 5 : char *xpathset = text_to_cstring(PG_GETARG_TEXT_PP(3));
610 : 5 : char *condition = text_to_cstring(PG_GETARG_TEXT_PP(4));
611 : :
612 : : /* SPI (input tuple) support */
613 : : SPITupleTable *tuptable;
614 : : HeapTuple spi_tuple;
615 : : TupleDesc spi_tupdesc;
616 : :
617 : :
7678 bruce@momjian.us 618 : 5 : ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
619 : : AttInMetadata *attinmeta;
620 : :
621 : : char **values;
622 : : xmlChar **xpaths;
623 : : char *pos;
6628 tgl@sss.pgh.pa.us 624 : 5 : const char *pathsep = "|";
625 : :
626 : : int numpaths;
627 : : int ret;
628 : : uint64 proc;
629 : : int j;
630 : : int rownr; /* For issuing multiple rows from one original
631 : : * document */
632 : : bool had_values; /* To determine end of nodeset results */
633 : : StringInfoData query_buf;
634 : : PgXmlErrorContext *xmlerrcxt;
5162 635 : 5 : volatile xmlDocPtr doctree = NULL;
636 : :
1054 michael@paquier.xyz 637 : 5 : InitMaterializedSRF(fcinfo, MAT_SRF_USE_EXPECTED_DESC);
638 : :
639 : : /* must have at least one output column (for the pkey) */
1278 640 [ - + ]: 5 : if (rsinfo->setDesc->natts < 1)
5669 tgl@sss.pgh.pa.us 641 [ # # ]:UBC 0 : ereport(ERROR,
642 : : (errcode(ERRCODE_SYNTAX_ERROR),
643 : : errmsg("xpath_table must have at least one output column")));
644 : :
645 : : /*
646 : : * At the moment we assume that the returned attributes make sense for the
647 : : * XPath specified (i.e. we trust the caller). It's not fatal if they get
648 : : * it wrong - the input function for the column type will raise an error
649 : : * if the path result can't be converted into the correct binary
650 : : * representation.
651 : : */
652 : :
1278 michael@paquier.xyz 653 :CBC 5 : attinmeta = TupleDescGetAttInMetadata(rsinfo->setDesc);
654 : :
655 : 5 : values = (char **) palloc(rsinfo->setDesc->natts * sizeof(char *));
656 : 5 : xpaths = (xmlChar **) palloc(rsinfo->setDesc->natts * sizeof(xmlChar *));
657 : :
658 : : /*
659 : : * Split XPaths. xpathset is a writable CString.
660 : : *
661 : : * Note that we stop splitting once we've done all needed for tupdesc
662 : : */
7678 bruce@momjian.us 663 : 5 : numpaths = 0;
664 : 5 : pos = xpathset;
1278 michael@paquier.xyz 665 [ + + ]: 7 : while (numpaths < (rsinfo->setDesc->natts - 1))
666 : : {
5669 tgl@sss.pgh.pa.us 667 : 5 : xpaths[numpaths++] = (xmlChar *) pos;
7678 bruce@momjian.us 668 : 5 : pos = strstr(pos, pathsep);
669 [ + + ]: 5 : if (pos != NULL)
670 : : {
671 : 2 : *pos = '\0';
672 : 2 : pos++;
673 : : }
674 : : else
5669 tgl@sss.pgh.pa.us 675 : 3 : break;
676 : : }
677 : :
678 : : /* Now build query */
7129 neilc@samurai.com 679 : 5 : initStringInfo(&query_buf);
680 : :
681 : : /* Build initial sql statement */
682 : 5 : appendStringInfo(&query_buf, "SELECT %s, %s FROM %s WHERE %s",
683 : : pkeyfield,
684 : : xmlfield,
685 : : relname,
686 : : condition);
687 : :
362 tgl@sss.pgh.pa.us 688 : 5 : SPI_connect();
689 : :
7129 neilc@samurai.com 690 [ - + ]: 5 : if ((ret = SPI_exec(query_buf.data, 0)) != SPI_OK_SELECT)
5669 tgl@sss.pgh.pa.us 691 [ # # ]:UBC 0 : elog(ERROR, "xpath_table: SPI execution failed for query %s",
692 : : query_buf.data);
693 : :
7678 bruce@momjian.us 694 :CBC 5 : proc = SPI_processed;
695 : 5 : tuptable = SPI_tuptable;
696 : 5 : spi_tupdesc = tuptable->tupdesc;
697 : :
698 : : /*
699 : : * Check that SPI returned correct result. If you put a comma into one of
700 : : * the function parameters, this will catch it when the SPI query returns
701 : : * e.g. 3 columns.
702 : : */
703 [ - + ]: 5 : if (spi_tupdesc->natts != 2)
704 : : {
7678 bruce@momjian.us 705 [ # # ]:UBC 0 : ereport(ERROR, (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
706 : : errmsg("expression returning multiple columns is not valid in parameter list"),
707 : : errdetail("Expected two columns in SPI result, got %d.", spi_tupdesc->natts)));
708 : : }
709 : :
710 : : /*
711 : : * Setup the parser. This should happen after we are done evaluating the
712 : : * query, in case it calls functions that set up libxml differently.
713 : : */
5162 tgl@sss.pgh.pa.us 714 :CBC 5 : xmlerrcxt = pgxml_parser_init(PG_XML_STRICTNESS_LEGACY);
715 : :
716 [ + - ]: 5 : PG_TRY();
717 : : {
718 : : /* For each row i.e. document returned from SPI */
719 : : uint64 i;
720 : :
4836 bruce@momjian.us 721 [ + + ]: 10 : for (i = 0; i < proc; i++)
722 : : {
723 : : char *pkey;
724 : : char *xmldoc;
725 : : xmlXPathContextPtr ctxt;
726 : : xmlXPathObjectPtr res;
727 : : xmlChar *resstr;
728 : : xmlXPathCompExprPtr comppath;
729 : : HeapTuple ret_tuple;
730 : :
731 : : /* Extract the row data as C Strings */
732 : 5 : spi_tuple = tuptable->vals[i];
733 : 5 : pkey = SPI_getvalue(spi_tuple, spi_tupdesc, 1);
734 : 5 : xmldoc = SPI_getvalue(spi_tuple, spi_tupdesc, 2);
735 : :
736 : : /*
737 : : * Clear the values array, so that not-well-formed documents
738 : : * return NULL in all columns. Note that this also means that
739 : : * spare columns will be NULL.
740 : : */
1278 michael@paquier.xyz 741 [ + + ]: 15 : for (j = 0; j < rsinfo->setDesc->natts; j++)
4836 bruce@momjian.us 742 : 10 : values[j] = NULL;
743 : :
744 : : /* Insert primary key */
745 : 5 : values[0] = pkey;
746 : :
747 : : /* Parse the document */
748 [ + - ]: 5 : if (xmldoc)
598 michael@paquier.xyz 749 : 5 : doctree = xmlReadMemory(xmldoc, strlen(xmldoc),
750 : : NULL, NULL,
751 : : XML_PARSE_NOENT);
752 : : else /* treat NULL as not well-formed */
4836 bruce@momjian.us 753 :UBC 0 : doctree = NULL;
754 : :
4836 bruce@momjian.us 755 [ - + ]:CBC 5 : if (doctree == NULL)
756 : : {
757 : : /* not well-formed, so output all-NULL tuple */
4836 bruce@momjian.us 758 :UBC 0 : ret_tuple = BuildTupleFromCStrings(attinmeta, values);
1278 michael@paquier.xyz 759 : 0 : tuplestore_puttuple(rsinfo->setResult, ret_tuple);
4836 bruce@momjian.us 760 : 0 : heap_freetuple(ret_tuple);
761 : : }
762 : : else
763 : : {
764 : : /* New loop here - we have to deal with nodeset results */
4836 bruce@momjian.us 765 :CBC 5 : rownr = 0;
766 : :
767 : : do
768 : : {
769 : : /* Now evaluate the set of xpaths. */
770 : 8 : had_values = false;
771 [ + + ]: 18 : for (j = 0; j < numpaths; j++)
772 : : {
773 : 10 : ctxt = xmlXPathNewContext(doctree);
67 michael@paquier.xyz 774 [ + - - + ]:GNC 10 : if (ctxt == NULL || pg_xml_error_occurred(xmlerrcxt))
67 michael@paquier.xyz 775 :UNC 0 : xml_ereport(xmlerrcxt,
776 : : ERROR, ERRCODE_OUT_OF_MEMORY,
777 : : "could not allocate XPath context");
778 : :
4836 bruce@momjian.us 779 :CBC 10 : ctxt->node = xmlDocGetRootElement(doctree);
780 : :
781 : : /* compile the path */
356 tgl@sss.pgh.pa.us 782 : 10 : comppath = xmlXPathCtxtCompile(ctxt, xpaths[j]);
67 michael@paquier.xyz 783 [ + - - + ]:GNC 10 : if (comppath == NULL || pg_xml_error_occurred(xmlerrcxt))
4836 bruce@momjian.us 784 :UBC 0 : xml_ereport(xmlerrcxt, ERROR,
785 : : ERRCODE_INVALID_ARGUMENT_FOR_XQUERY,
786 : : "XPath Syntax Error");
787 : :
788 : : /* Now evaluate the path expression. */
4836 bruce@momjian.us 789 :CBC 10 : res = xmlXPathCompiledEval(comppath, ctxt);
790 : 10 : xmlXPathFreeCompExpr(comppath);
791 : :
792 [ + - ]: 10 : if (res != NULL)
793 : : {
794 [ + - - ]: 10 : switch (res->type)
795 : : {
796 : 10 : case XPATH_NODESET:
797 : : /* We see if this nodeset has enough nodes */
798 [ + - ]: 10 : if (res->nodesetval != NULL &&
799 [ + + ]: 10 : rownr < res->nodesetval->nodeNr)
800 : : {
801 : 4 : resstr = xmlXPathCastNodeToString(res->nodesetval->nodeTab[rownr]);
67 michael@paquier.xyz 802 [ + - - + ]:GNC 4 : if (resstr == NULL || pg_xml_error_occurred(xmlerrcxt))
67 michael@paquier.xyz 803 :UNC 0 : xml_ereport(xmlerrcxt,
804 : : ERROR, ERRCODE_OUT_OF_MEMORY,
805 : : "could not allocate result");
4836 bruce@momjian.us 806 :CBC 4 : had_values = true;
807 : : }
808 : : else
809 : 6 : resstr = NULL;
810 : :
811 : 10 : break;
812 : :
4836 bruce@momjian.us 813 :UBC 0 : case XPATH_STRING:
814 : 0 : resstr = xmlStrdup(res->stringval);
67 michael@paquier.xyz 815 [ # # # # ]:UNC 0 : if (resstr == NULL || pg_xml_error_occurred(xmlerrcxt))
816 : 0 : xml_ereport(xmlerrcxt,
817 : : ERROR, ERRCODE_OUT_OF_MEMORY,
818 : : "could not allocate result");
4836 bruce@momjian.us 819 :UBC 0 : break;
820 : :
821 : 0 : default:
822 [ # # ]: 0 : elog(NOTICE, "unsupported XQuery result: %d", res->type);
823 : 0 : resstr = xmlStrdup((const xmlChar *) "<unsupported/>");
67 michael@paquier.xyz 824 [ # # # # ]:UNC 0 : if (resstr == NULL || pg_xml_error_occurred(xmlerrcxt))
825 : 0 : xml_ereport(xmlerrcxt,
826 : : ERROR, ERRCODE_OUT_OF_MEMORY,
827 : : "could not allocate result");
828 : : }
829 : :
830 : : /*
831 : : * Insert this into the appropriate column in the
832 : : * result tuple.
833 : : */
4836 bruce@momjian.us 834 :CBC 10 : values[j + 1] = (char *) resstr;
835 : : }
836 : 10 : xmlXPathFreeContext(ctxt);
837 : : }
838 : :
839 : : /* Now add the tuple to the output, if there is one. */
840 [ + + ]: 8 : if (had_values)
841 : : {
842 : 3 : ret_tuple = BuildTupleFromCStrings(attinmeta, values);
1278 michael@paquier.xyz 843 : 3 : tuplestore_puttuple(rsinfo->setResult, ret_tuple);
4836 bruce@momjian.us 844 : 3 : heap_freetuple(ret_tuple);
845 : : }
846 : :
847 : 8 : rownr++;
848 [ + + ]: 8 : } while (had_values);
849 : : }
850 : :
851 [ + - ]: 5 : if (doctree != NULL)
852 : 5 : xmlFreeDoc(doctree);
853 : 5 : doctree = NULL;
854 : :
855 [ + - ]: 5 : if (pkey)
856 : 5 : pfree(pkey);
857 [ + - ]: 5 : if (xmldoc)
858 : 5 : pfree(xmldoc);
859 : : }
860 : : }
5162 tgl@sss.pgh.pa.us 861 :UBC 0 : PG_CATCH();
862 : : {
863 [ # # ]: 0 : if (doctree != NULL)
864 : 0 : xmlFreeDoc(doctree);
865 : :
866 : 0 : pg_xml_done(xmlerrcxt, true);
867 : :
868 : 0 : PG_RE_THROW();
869 : : }
5162 tgl@sss.pgh.pa.us 870 [ - + ]:CBC 5 : PG_END_TRY();
871 : :
872 [ - + ]: 5 : if (doctree != NULL)
5162 tgl@sss.pgh.pa.us 873 :UBC 0 : xmlFreeDoc(doctree);
874 : :
5162 tgl@sss.pgh.pa.us 875 :CBC 5 : pg_xml_done(xmlerrcxt, false);
876 : :
7678 bruce@momjian.us 877 : 5 : SPI_finish();
878 : :
879 : : /*
880 : : * SFRM_Materialize mode expects us to return a NULL Datum. The actual
881 : : * tuples are in our tuplestore and passed back through rsinfo->setResult.
882 : : * rsinfo->setDesc is set to the tuple description that we actually used
883 : : * to build our tuples with, so the caller can verify we did what it was
884 : : * expecting.
885 : : */
886 : 5 : return (Datum) 0;
887 : : }
|
