blob: ff3dafbb9860e05ff205594c5b72deec9700ee54 [file] [log] [blame]
Owen Taylor3473f882001-02-23 17:55:21 +00001/*
2 * xinclude.c : Code to implement XInclude processing
3 *
Daniel Veillarde74d2e12003-12-09 11:35:37 +00004 * World Wide Web Consortium W3C Last Call Working Draft 10 November 2003
5 * http://www.w3.org/TR/2003/WD-xinclude-20031110
Owen Taylor3473f882001-02-23 17:55:21 +00006 *
7 * See Copyright for the status of this software.
8 *
Daniel Veillardc5d64342001-06-24 12:13:24 +00009 * daniel@veillard.com
Owen Taylor3473f882001-02-23 17:55:21 +000010 */
11
Daniel Veillard34ce8be2002-03-18 19:37:11 +000012#define IN_LIBXML
Bjorn Reese70a9da52001-04-21 16:57:29 +000013#include "libxml.h"
Owen Taylor3473f882001-02-23 17:55:21 +000014
Owen Taylor3473f882001-02-23 17:55:21 +000015#include <string.h>
16#include <libxml/xmlmemory.h>
17#include <libxml/tree.h>
18#include <libxml/parser.h>
19#include <libxml/uri.h>
Nicolas Le Cam41586ca2013-06-17 13:01:33 +020020#include <libxml/xpath.h>
Owen Taylor3473f882001-02-23 17:55:21 +000021#include <libxml/xpointer.h>
22#include <libxml/parserInternals.h>
Owen Taylor3473f882001-02-23 17:55:21 +000023#include <libxml/xmlerror.h>
Daniel Veillardd076a202002-11-20 13:28:31 +000024#include <libxml/encoding.h>
Daniel Veillard3c01b1d2001-10-17 15:58:35 +000025#include <libxml/globals.h>
Owen Taylor3473f882001-02-23 17:55:21 +000026
27#ifdef LIBXML_XINCLUDE_ENABLED
28#include <libxml/xinclude.h>
29
Daniel Veillard345ee8b2012-07-16 14:40:37 +080030#include "buf.h"
Owen Taylor3473f882001-02-23 17:55:21 +000031
Daniel Veillardf4b4f982003-02-13 11:02:08 +000032#define XINCLUDE_MAX_DEPTH 40
33
Daniel Veillard98485322003-08-14 15:44:40 +000034/* #define DEBUG_XINCLUDE */
Daniel Veillard017b1082001-06-21 11:20:21 +000035#ifdef DEBUG_XINCLUDE
36#ifdef LIBXML_DEBUG_ENABLED
37#include <libxml/debugXML.h>
38#endif
39#endif
Owen Taylor3473f882001-02-23 17:55:21 +000040
41/************************************************************************
42 * *
William M. Brack72ee48d2003-12-30 08:30:19 +000043 * XInclude context handling *
Owen Taylor3473f882001-02-23 17:55:21 +000044 * *
45 ************************************************************************/
46
47/*
48 * An XInclude context
49 */
Daniel Veillardedac3c92001-02-26 01:36:19 +000050typedef xmlChar *xmlURL;
Daniel Veillardbbc72c32002-09-05 10:52:10 +000051
52typedef struct _xmlXIncludeRef xmlXIncludeRef;
53typedef xmlXIncludeRef *xmlXIncludeRefPtr;
54struct _xmlXIncludeRef {
William M. Brack72ee48d2003-12-30 08:30:19 +000055 xmlChar *URI; /* the fully resolved resource URL */
Daniel Veillardbbc72c32002-09-05 10:52:10 +000056 xmlChar *fragment; /* the fragment in the URI */
57 xmlDocPtr doc; /* the parsed document */
58 xmlNodePtr ref; /* the node making the reference in the source */
59 xmlNodePtr inc; /* the included copy */
60 int xml; /* xml or txt */
61 int count; /* how many refs use that specific doc */
Daniel Veillardf4b4f982003-02-13 11:02:08 +000062 xmlXPathObjectPtr xptr; /* the xpointer if needed */
William M. Brack95af5942004-02-08 04:12:49 +000063 int emptyFb; /* flag to show fallback empty */
Daniel Veillardbbc72c32002-09-05 10:52:10 +000064};
65
Owen Taylor3473f882001-02-23 17:55:21 +000066struct _xmlXIncludeCtxt {
67 xmlDocPtr doc; /* the source document */
Daniel Veillardbbc72c32002-09-05 10:52:10 +000068 int incBase; /* the first include for this document */
Owen Taylor3473f882001-02-23 17:55:21 +000069 int incNr; /* number of includes */
70 int incMax; /* size of includes tab */
Daniel Veillardbbc72c32002-09-05 10:52:10 +000071 xmlXIncludeRefPtr *incTab; /* array of included references */
72
Owen Taylor3473f882001-02-23 17:55:21 +000073 int txtNr; /* number of unparsed documents */
74 int txtMax; /* size of unparsed documents tab */
75 xmlNodePtr *txtTab; /* array of unparsed text nodes */
William M. Brack72ee48d2003-12-30 08:30:19 +000076 xmlURL *txturlTab; /* array of unparsed text URLs */
Daniel Veillardd581b7e2003-02-11 18:03:05 +000077
Daniel Veillardf4b4f982003-02-13 11:02:08 +000078 xmlChar * url; /* the current URL processed */
William M. Brack72ee48d2003-12-30 08:30:19 +000079 int urlNr; /* number of URLs stacked */
80 int urlMax; /* size of URL stack */
81 xmlChar * *urlTab; /* URL stack */
Daniel Veillardf4b4f982003-02-13 11:02:08 +000082
Daniel Veillardd581b7e2003-02-11 18:03:05 +000083 int nbErrors; /* the number of errors detected */
Daniel Veillardb5fa0202003-12-08 17:41:29 +000084 int legacy; /* using XINCLUDE_OLD_NS */
Daniel Veillarde74d2e12003-12-09 11:35:37 +000085 int parseFlags; /* the flags used for parsing XML documents */
William M. Brackf7789b12004-06-07 08:57:27 +000086 xmlChar * base; /* the current xml:base */
Daniel Veillard681e9042006-09-29 09:16:00 +000087
88 void *_private; /* application data */
Owen Taylor3473f882001-02-23 17:55:21 +000089};
90
Daniel Veillardd16df9f2001-05-23 13:44:21 +000091static int
Daniel Veillard8edf1c52003-07-22 20:52:14 +000092xmlXIncludeDoProcess(xmlXIncludeCtxtPtr ctxt, xmlDocPtr doc, xmlNodePtr tree);
Owen Taylor3473f882001-02-23 17:55:21 +000093
Daniel Veillard98485322003-08-14 15:44:40 +000094
Daniel Veillardcd6ff282003-10-08 22:38:13 +000095/************************************************************************
96 * *
Daniel Veillardf8e3db02012-09-11 13:26:36 +080097 * XInclude error handler *
Daniel Veillardcd6ff282003-10-08 22:38:13 +000098 * *
99 ************************************************************************/
100
Daniel Veillard98485322003-08-14 15:44:40 +0000101/**
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000102 * xmlXIncludeErrMemory:
William M. Brack72ee48d2003-12-30 08:30:19 +0000103 * @extra: extra information
Daniel Veillard98485322003-08-14 15:44:40 +0000104 *
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000105 * Handle an out of memory condition
Daniel Veillard98485322003-08-14 15:44:40 +0000106 */
107static void
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000108xmlXIncludeErrMemory(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node,
109 const char *extra)
Daniel Veillard98485322003-08-14 15:44:40 +0000110{
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000111 if (ctxt != NULL)
112 ctxt->nbErrors++;
Daniel Veillard659e71e2003-10-10 14:10:40 +0000113 __xmlRaiseError(NULL, NULL, NULL, ctxt, node, XML_FROM_XINCLUDE,
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000114 XML_ERR_NO_MEMORY, XML_ERR_ERROR, NULL, 0,
115 extra, NULL, NULL, 0, 0,
116 "Memory allocation failed : %s\n", extra);
117}
Daniel Veillard98485322003-08-14 15:44:40 +0000118
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000119/**
120 * xmlXIncludeErr:
121 * @ctxt: the XInclude context
122 * @node: the context node
123 * @msg: the error message
William M. Brack72ee48d2003-12-30 08:30:19 +0000124 * @extra: extra information
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000125 *
Daniel Veillardb5fa0202003-12-08 17:41:29 +0000126 * Handle an XInclude error
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000127 */
128static void
129xmlXIncludeErr(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node, int error,
130 const char *msg, const xmlChar *extra)
131{
132 if (ctxt != NULL)
133 ctxt->nbErrors++;
Daniel Veillard659e71e2003-10-10 14:10:40 +0000134 __xmlRaiseError(NULL, NULL, NULL, ctxt, node, XML_FROM_XINCLUDE,
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000135 error, XML_ERR_ERROR, NULL, 0,
136 (const char *) extra, NULL, NULL, 0, 0,
137 msg, (const char *) extra);
Daniel Veillard98485322003-08-14 15:44:40 +0000138}
139
Daniel Veillardf54cd532004-02-25 11:52:31 +0000140#if 0
Owen Taylor3473f882001-02-23 17:55:21 +0000141/**
Daniel Veillardb5fa0202003-12-08 17:41:29 +0000142 * xmlXIncludeWarn:
143 * @ctxt: the XInclude context
144 * @node: the context node
145 * @msg: the error message
William M. Brack72ee48d2003-12-30 08:30:19 +0000146 * @extra: extra information
Daniel Veillardb5fa0202003-12-08 17:41:29 +0000147 *
148 * Emit an XInclude warning.
149 */
150static void
151xmlXIncludeWarn(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node, int error,
152 const char *msg, const xmlChar *extra)
153{
154 __xmlRaiseError(NULL, NULL, NULL, ctxt, node, XML_FROM_XINCLUDE,
155 error, XML_ERR_WARNING, NULL, 0,
156 (const char *) extra, NULL, NULL, 0, 0,
157 msg, (const char *) extra);
158}
Daniel Veillardf54cd532004-02-25 11:52:31 +0000159#endif
Daniel Veillardb5fa0202003-12-08 17:41:29 +0000160
161/**
162 * xmlXIncludeGetProp:
163 * @ctxt: the XInclude context
164 * @cur: the node
165 * @name: the attribute name
166 *
167 * Get an XInclude attribute
168 *
169 * Returns the value (to be freed) or NULL if not found
170 */
171static xmlChar *
172xmlXIncludeGetProp(xmlXIncludeCtxtPtr ctxt, xmlNodePtr cur,
173 const xmlChar *name) {
174 xmlChar *ret;
175
176 ret = xmlGetNsProp(cur, XINCLUDE_NS, name);
177 if (ret != NULL)
178 return(ret);
179 if (ctxt->legacy != 0) {
180 ret = xmlGetNsProp(cur, XINCLUDE_OLD_NS, name);
181 if (ret != NULL)
182 return(ret);
183 }
184 ret = xmlGetProp(cur, name);
185 return(ret);
186}
187/**
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000188 * xmlXIncludeFreeRef:
189 * @ref: the XInclude reference
190 *
191 * Free an XInclude reference
192 */
193static void
194xmlXIncludeFreeRef(xmlXIncludeRefPtr ref) {
195 if (ref == NULL)
196 return;
197#ifdef DEBUG_XINCLUDE
198 xmlGenericError(xmlGenericErrorContext, "Freeing ref\n");
199#endif
200 if (ref->doc != NULL) {
201#ifdef DEBUG_XINCLUDE
202 xmlGenericError(xmlGenericErrorContext, "Freeing doc %s\n", ref->URI);
203#endif
204 xmlFreeDoc(ref->doc);
205 }
206 if (ref->URI != NULL)
207 xmlFree(ref->URI);
208 if (ref->fragment != NULL)
209 xmlFree(ref->fragment);
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000210 if (ref->xptr != NULL)
211 xmlXPathFreeObject(ref->xptr);
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000212 xmlFree(ref);
213}
214
215/**
216 * xmlXIncludeNewRef:
217 * @ctxt: the XInclude context
218 * @URI: the resource URI
219 *
220 * Creates a new reference within an XInclude context
221 *
222 * Returns the new set
223 */
224static xmlXIncludeRefPtr
225xmlXIncludeNewRef(xmlXIncludeCtxtPtr ctxt, const xmlChar *URI,
226 xmlNodePtr ref) {
227 xmlXIncludeRefPtr ret;
228
229#ifdef DEBUG_XINCLUDE
230 xmlGenericError(xmlGenericErrorContext, "New ref %s\n", URI);
231#endif
232 ret = (xmlXIncludeRefPtr) xmlMalloc(sizeof(xmlXIncludeRef));
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000233 if (ret == NULL) {
234 xmlXIncludeErrMemory(ctxt, ref, "growing XInclude context");
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000235 return(NULL);
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000236 }
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000237 memset(ret, 0, sizeof(xmlXIncludeRef));
238 if (URI == NULL)
239 ret->URI = NULL;
240 else
241 ret->URI = xmlStrdup(URI);
242 ret->fragment = NULL;
243 ret->ref = ref;
Daniel Veillard24505b02005-07-28 23:49:35 +0000244 ret->doc = NULL;
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000245 ret->count = 0;
246 ret->xml = 0;
247 ret->inc = NULL;
248 if (ctxt->incMax == 0) {
249 ctxt->incMax = 4;
250 ctxt->incTab = (xmlXIncludeRefPtr *) xmlMalloc(ctxt->incMax *
251 sizeof(ctxt->incTab[0]));
252 if (ctxt->incTab == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000253 xmlXIncludeErrMemory(ctxt, ref, "growing XInclude context");
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000254 xmlXIncludeFreeRef(ret);
255 return(NULL);
256 }
257 }
258 if (ctxt->incNr >= ctxt->incMax) {
259 ctxt->incMax *= 2;
260 ctxt->incTab = (xmlXIncludeRefPtr *) xmlRealloc(ctxt->incTab,
261 ctxt->incMax * sizeof(ctxt->incTab[0]));
262 if (ctxt->incTab == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000263 xmlXIncludeErrMemory(ctxt, ref, "growing XInclude context");
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000264 xmlXIncludeFreeRef(ret);
265 return(NULL);
266 }
267 }
268 ctxt->incTab[ctxt->incNr++] = ret;
269 return(ret);
270}
271
272/**
Owen Taylor3473f882001-02-23 17:55:21 +0000273 * xmlXIncludeNewContext:
274 * @doc: an XML Document
275 *
276 * Creates a new XInclude context
277 *
278 * Returns the new set
279 */
Daniel Veillard7899c5c2003-11-03 12:31:38 +0000280xmlXIncludeCtxtPtr
Owen Taylor3473f882001-02-23 17:55:21 +0000281xmlXIncludeNewContext(xmlDocPtr doc) {
282 xmlXIncludeCtxtPtr ret;
283
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000284#ifdef DEBUG_XINCLUDE
285 xmlGenericError(xmlGenericErrorContext, "New context\n");
286#endif
Owen Taylor3473f882001-02-23 17:55:21 +0000287 if (doc == NULL)
288 return(NULL);
289 ret = (xmlXIncludeCtxtPtr) xmlMalloc(sizeof(xmlXIncludeCtxt));
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000290 if (ret == NULL) {
291 xmlXIncludeErrMemory(NULL, (xmlNodePtr) doc,
292 "creating XInclude context");
Owen Taylor3473f882001-02-23 17:55:21 +0000293 return(NULL);
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000294 }
Owen Taylor3473f882001-02-23 17:55:21 +0000295 memset(ret, 0, sizeof(xmlXIncludeCtxt));
296 ret->doc = doc;
297 ret->incNr = 0;
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000298 ret->incBase = 0;
Owen Taylor3473f882001-02-23 17:55:21 +0000299 ret->incMax = 0;
300 ret->incTab = NULL;
Daniel Veillardd581b7e2003-02-11 18:03:05 +0000301 ret->nbErrors = 0;
Owen Taylor3473f882001-02-23 17:55:21 +0000302 return(ret);
303}
304
305/**
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000306 * xmlXIncludeURLPush:
307 * @ctxt: the parser context
308 * @value: the url
309 *
310 * Pushes a new url on top of the url stack
311 *
312 * Returns -1 in case of error, the index in the stack otherwise
313 */
314static int
315xmlXIncludeURLPush(xmlXIncludeCtxtPtr ctxt,
316 const xmlChar *value)
317{
318 if (ctxt->urlNr > XINCLUDE_MAX_DEPTH) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000319 xmlXIncludeErr(ctxt, NULL, XML_XINCLUDE_RECURSION,
320 "detected a recursion in %s\n", value);
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000321 return(-1);
322 }
323 if (ctxt->urlTab == NULL) {
324 ctxt->urlMax = 4;
325 ctxt->urlNr = 0;
326 ctxt->urlTab = (xmlChar * *) xmlMalloc(
327 ctxt->urlMax * sizeof(ctxt->urlTab[0]));
328 if (ctxt->urlTab == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000329 xmlXIncludeErrMemory(ctxt, NULL, "adding URL");
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000330 return (-1);
331 }
332 }
333 if (ctxt->urlNr >= ctxt->urlMax) {
334 ctxt->urlMax *= 2;
335 ctxt->urlTab =
336 (xmlChar * *) xmlRealloc(ctxt->urlTab,
337 ctxt->urlMax *
338 sizeof(ctxt->urlTab[0]));
339 if (ctxt->urlTab == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000340 xmlXIncludeErrMemory(ctxt, NULL, "adding URL");
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000341 return (-1);
342 }
343 }
344 ctxt->url = ctxt->urlTab[ctxt->urlNr] = xmlStrdup(value);
345 return (ctxt->urlNr++);
346}
347
348/**
349 * xmlXIncludeURLPop:
350 * @ctxt: the parser context
351 *
William M. Brack72ee48d2003-12-30 08:30:19 +0000352 * Pops the top URL from the URL stack
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000353 */
354static void
355xmlXIncludeURLPop(xmlXIncludeCtxtPtr ctxt)
356{
357 xmlChar * ret;
358
359 if (ctxt->urlNr <= 0)
360 return;
361 ctxt->urlNr--;
362 if (ctxt->urlNr > 0)
363 ctxt->url = ctxt->urlTab[ctxt->urlNr - 1];
364 else
365 ctxt->url = NULL;
366 ret = ctxt->urlTab[ctxt->urlNr];
Daniel Veillard24505b02005-07-28 23:49:35 +0000367 ctxt->urlTab[ctxt->urlNr] = NULL;
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000368 if (ret != NULL)
369 xmlFree(ret);
370}
371
372/**
Owen Taylor3473f882001-02-23 17:55:21 +0000373 * xmlXIncludeFreeContext:
374 * @ctxt: the XInclude context
375 *
376 * Free an XInclude context
377 */
Daniel Veillard7899c5c2003-11-03 12:31:38 +0000378void
Owen Taylor3473f882001-02-23 17:55:21 +0000379xmlXIncludeFreeContext(xmlXIncludeCtxtPtr ctxt) {
380 int i;
381
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000382#ifdef DEBUG_XINCLUDE
383 xmlGenericError(xmlGenericErrorContext, "Freeing context\n");
384#endif
Owen Taylor3473f882001-02-23 17:55:21 +0000385 if (ctxt == NULL)
386 return;
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000387 while (ctxt->urlNr > 0)
388 xmlXIncludeURLPop(ctxt);
389 if (ctxt->urlTab != NULL)
390 xmlFree(ctxt->urlTab);
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000391 for (i = 0;i < ctxt->incNr;i++) {
392 if (ctxt->incTab[i] != NULL)
393 xmlXIncludeFreeRef(ctxt->incTab[i]);
Owen Taylor3473f882001-02-23 17:55:21 +0000394 }
Daniel Veillard11ce4002006-03-10 00:36:23 +0000395 if (ctxt->txturlTab != NULL) {
396 for (i = 0;i < ctxt->txtNr;i++) {
397 if (ctxt->txturlTab[i] != NULL)
398 xmlFree(ctxt->txturlTab[i]);
399 }
Owen Taylor3473f882001-02-23 17:55:21 +0000400 }
401 if (ctxt->incTab != NULL)
402 xmlFree(ctxt->incTab);
Owen Taylor3473f882001-02-23 17:55:21 +0000403 if (ctxt->txtTab != NULL)
404 xmlFree(ctxt->txtTab);
405 if (ctxt->txturlTab != NULL)
406 xmlFree(ctxt->txturlTab);
Daniel Veillardce244ad2004-11-05 10:03:46 +0000407 if (ctxt->base != NULL) {
408 xmlFree(ctxt->base);
409 }
Owen Taylor3473f882001-02-23 17:55:21 +0000410 xmlFree(ctxt);
411}
412
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000413/**
Daniel Veillard98485322003-08-14 15:44:40 +0000414 * xmlXIncludeParseFile:
415 * @ctxt: the XInclude context
416 * @URL: the URL or file path
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800417 *
William M. Brack72ee48d2003-12-30 08:30:19 +0000418 * parse a document for XInclude
Daniel Veillard98485322003-08-14 15:44:40 +0000419 */
420static xmlDocPtr
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000421xmlXIncludeParseFile(xmlXIncludeCtxtPtr ctxt, const char *URL) {
Daniel Veillard98485322003-08-14 15:44:40 +0000422 xmlDocPtr ret;
423 xmlParserCtxtPtr pctxt;
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000424 xmlParserInputPtr inputStream;
Daniel Veillard98485322003-08-14 15:44:40 +0000425
426 xmlInitParser();
427
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000428 pctxt = xmlNewParserCtxt();
Daniel Veillard98485322003-08-14 15:44:40 +0000429 if (pctxt == NULL) {
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000430 xmlXIncludeErrMemory(ctxt, NULL, "cannot allocate parser context");
Daniel Veillard98485322003-08-14 15:44:40 +0000431 return(NULL);
432 }
Daniel Veillard681e9042006-09-29 09:16:00 +0000433
434 /*
435 * pass in the application data to the parser context.
436 */
437 pctxt->_private = ctxt->_private;
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800438
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000439 /*
William M. Brack72ee48d2003-12-30 08:30:19 +0000440 * try to ensure that new documents included are actually
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000441 * built with the same dictionary as the including document.
442 */
Daniel Veillardcb6f5252009-08-25 19:24:15 +0200443 if ((ctxt->doc != NULL) && (ctxt->doc->dict != NULL)) {
444 if (pctxt->dict != NULL)
445 xmlDictFree(pctxt->dict);
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000446 pctxt->dict = ctxt->doc->dict;
447 xmlDictReference(pctxt->dict);
448 }
449
450 xmlCtxtUseOptions(pctxt, ctxt->parseFlags | XML_PARSE_DTDLOAD);
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800451
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000452 inputStream = xmlLoadExternalEntity(URL, NULL, pctxt);
453 if (inputStream == NULL) {
454 xmlFreeParserCtxt(pctxt);
455 return(NULL);
456 }
457
458 inputPush(pctxt, inputStream);
Daniel Veillard98485322003-08-14 15:44:40 +0000459
Daniel Veillard37d2d162008-03-14 10:54:00 +0000460 if (pctxt->directory == NULL)
461 pctxt->directory = xmlParserGetDirectory(URL);
Daniel Veillard98485322003-08-14 15:44:40 +0000462
William M. Bracka22da292005-02-12 01:08:22 +0000463 pctxt->loadsubset |= XML_DETECT_IDS;
Daniel Veillard98485322003-08-14 15:44:40 +0000464
465 xmlParseDocument(pctxt);
466
William M. Brack1ff42132003-12-31 14:05:15 +0000467 if (pctxt->wellFormed) {
Daniel Veillard98485322003-08-14 15:44:40 +0000468 ret = pctxt->myDoc;
William M. Brack1ff42132003-12-31 14:05:15 +0000469 }
Daniel Veillard98485322003-08-14 15:44:40 +0000470 else {
471 ret = NULL;
Daniel Veillard500a1de2004-03-22 15:22:58 +0000472 if (pctxt->myDoc != NULL)
Daniel Veillard4773df22004-01-23 13:15:13 +0000473 xmlFreeDoc(pctxt->myDoc);
Daniel Veillard98485322003-08-14 15:44:40 +0000474 pctxt->myDoc = NULL;
475 }
476 xmlFreeParserCtxt(pctxt);
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800477
Daniel Veillard98485322003-08-14 15:44:40 +0000478 return(ret);
479}
480
481/**
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000482 * xmlXIncludeAddNode:
483 * @ctxt: the XInclude context
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000484 * @cur: the new node
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800485 *
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000486 * Add a new node to process to an XInclude context
487 */
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000488static int
489xmlXIncludeAddNode(xmlXIncludeCtxtPtr ctxt, xmlNodePtr cur) {
490 xmlXIncludeRefPtr ref;
491 xmlURIPtr uri;
492 xmlChar *URL;
493 xmlChar *fragment = NULL;
494 xmlChar *href;
495 xmlChar *parse;
496 xmlChar *base;
497 xmlChar *URI;
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000498 int xml = 1, i; /* default Issue 64 */
499 int local = 0;
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000500
501
502 if (ctxt == NULL)
503 return(-1);
504 if (cur == NULL)
505 return(-1);
506
507#ifdef DEBUG_XINCLUDE
508 xmlGenericError(xmlGenericErrorContext, "Add node\n");
509#endif
510 /*
511 * read the attributes
512 */
Daniel Veillardb5fa0202003-12-08 17:41:29 +0000513 href = xmlXIncludeGetProp(ctxt, cur, XINCLUDE_HREF);
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000514 if (href == NULL) {
Daniel Veillardb5fa0202003-12-08 17:41:29 +0000515 href = xmlStrdup(BAD_CAST ""); /* @@@@ href is now optional */
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800516 if (href == NULL)
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000517 return(-1);
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000518 }
Daniel Veillardb242b082008-02-08 09:56:31 +0000519 if ((href[0] == '#') || (href[0] == 0))
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000520 local = 1;
Daniel Veillardb5fa0202003-12-08 17:41:29 +0000521 parse = xmlXIncludeGetProp(ctxt, cur, XINCLUDE_PARSE);
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000522 if (parse != NULL) {
523 if (xmlStrEqual(parse, XINCLUDE_PARSE_XML))
524 xml = 1;
525 else if (xmlStrEqual(parse, XINCLUDE_PARSE_TEXT))
526 xml = 0;
527 else {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000528 xmlXIncludeErr(ctxt, cur, XML_XINCLUDE_PARSE_VALUE,
529 "invalid value %s for 'parse'\n", parse);
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000530 if (href != NULL)
531 xmlFree(href);
532 if (parse != NULL)
533 xmlFree(parse);
534 return(-1);
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000535 }
536 }
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000537
538 /*
539 * compute the URI
540 */
541 base = xmlNodeGetBase(ctxt->doc, cur);
542 if (base == NULL) {
543 URI = xmlBuildURI(href, ctxt->doc->URL);
544 } else {
545 URI = xmlBuildURI(href, base);
546 }
547 if (URI == NULL) {
548 xmlChar *escbase;
549 xmlChar *eschref;
550 /*
551 * Some escaping may be needed
552 */
553 escbase = xmlURIEscape(base);
554 eschref = xmlURIEscape(href);
555 URI = xmlBuildURI(eschref, escbase);
556 if (escbase != NULL)
557 xmlFree(escbase);
558 if (eschref != NULL)
559 xmlFree(eschref);
560 }
561 if (parse != NULL)
562 xmlFree(parse);
563 if (href != NULL)
564 xmlFree(href);
565 if (base != NULL)
566 xmlFree(base);
567 if (URI == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000568 xmlXIncludeErr(ctxt, cur, XML_XINCLUDE_HREF_URI,
569 "failed build URL\n", NULL);
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000570 return(-1);
571 }
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000572 fragment = xmlXIncludeGetProp(ctxt, cur, XINCLUDE_PARSE_XPOINTER);
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000573
574 /*
575 * Check the URL and remove any fragment identifier
576 */
577 uri = xmlParseURI((const char *)URI);
578 if (uri == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000579 xmlXIncludeErr(ctxt, cur, XML_XINCLUDE_HREF_URI,
580 "invalid value URI %s\n", URI);
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000581 if (fragment != NULL)
582 xmlFree(fragment);
583 xmlFree(URI);
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000584 return(-1);
585 }
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000586
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000587 if (uri->fragment != NULL) {
Daniel Veillarde74d2e12003-12-09 11:35:37 +0000588 if (ctxt->legacy != 0) {
589 if (fragment == NULL) {
590 fragment = (xmlChar *) uri->fragment;
591 } else {
592 xmlFree(uri->fragment);
593 }
594 } else {
595 xmlXIncludeErr(ctxt, cur, XML_XINCLUDE_FRAGMENT_ID,
596 "Invalid fragment identifier in URI %s use the xpointer attribute\n",
597 URI);
598 if (fragment != NULL)
599 xmlFree(fragment);
600 xmlFreeURI(uri);
601 xmlFree(URI);
602 return(-1);
603 }
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000604 uri->fragment = NULL;
605 }
606 URL = xmlSaveUri(uri);
607 xmlFreeURI(uri);
608 xmlFree(URI);
609 if (URL == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000610 xmlXIncludeErr(ctxt, cur, XML_XINCLUDE_HREF_URI,
611 "invalid value URI %s\n", URI);
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000612 if (fragment != NULL)
613 xmlFree(fragment);
614 return(-1);
615 }
616
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000617 /*
Daniel Veillardb242b082008-02-08 09:56:31 +0000618 * If local and xml then we need a fragment
619 */
620 if ((local == 1) && (xml == 1) &&
621 ((fragment == NULL) || (fragment[0] == 0))) {
622 xmlXIncludeErr(ctxt, cur, XML_XINCLUDE_RECURSION,
623 "detected a local recursion with no xpointer in %s\n",
624 URL);
625 if (fragment != NULL)
626 xmlFree(fragment);
627 return(-1);
628 }
629
630 /*
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000631 * Check the URL against the stack for recursions
632 */
Daniel Veillardbf630c02006-06-06 08:21:41 +0000633 if ((!local) && (xml == 1)) {
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000634 for (i = 0;i < ctxt->urlNr;i++) {
635 if (xmlStrEqual(URL, ctxt->urlTab[i])) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000636 xmlXIncludeErr(ctxt, cur, XML_XINCLUDE_RECURSION,
637 "detected a recursion in %s\n", URL);
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000638 return(-1);
639 }
640 }
641 }
642
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000643 ref = xmlXIncludeNewRef(ctxt, URL, cur);
644 if (ref == NULL) {
645 return(-1);
646 }
647 ref->fragment = fragment;
648 ref->doc = NULL;
649 ref->xml = xml;
650 ref->count = 1;
651 xmlFree(URL);
652 return(0);
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000653}
654
655/**
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000656 * xmlXIncludeRecurseDoc:
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000657 * @ctxt: the XInclude context
658 * @doc: the new document
659 * @url: the associated URL
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800660 *
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000661 * The XInclude recursive nature is handled at this point.
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000662 */
663static void
Daniel Veillard118aed72002-09-24 14:13:13 +0000664xmlXIncludeRecurseDoc(xmlXIncludeCtxtPtr ctxt, xmlDocPtr doc,
Daniel Veillarddda8f1b2002-09-26 09:47:36 +0000665 const xmlURL url ATTRIBUTE_UNUSED) {
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000666 xmlXIncludeCtxtPtr newctxt;
667 int i;
668
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000669 /*
670 * Avoid recursion in already substitued resources
671 for (i = 0;i < ctxt->urlNr;i++) {
672 if (xmlStrEqual(doc->URL, ctxt->urlTab[i]))
673 return;
674 }
675 */
676
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000677#ifdef DEBUG_XINCLUDE
678 xmlGenericError(xmlGenericErrorContext, "Recursing in doc %s\n", doc->URL);
679#endif
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000680 /*
681 * Handle recursion here.
682 */
683
684 newctxt = xmlXIncludeNewContext(doc);
685 if (newctxt != NULL) {
686 /*
Daniel Veillarda6585822006-12-04 09:21:28 +0000687 * Copy the private user data
688 */
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800689 newctxt->_private = ctxt->_private;
Daniel Veillarda6585822006-12-04 09:21:28 +0000690 /*
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000691 * Copy the existing document set
692 */
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000693 newctxt->incMax = ctxt->incMax;
694 newctxt->incNr = ctxt->incNr;
695 newctxt->incTab = (xmlXIncludeRefPtr *) xmlMalloc(newctxt->incMax *
696 sizeof(newctxt->incTab[0]));
697 if (newctxt->incTab == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000698 xmlXIncludeErrMemory(ctxt, (xmlNodePtr) doc, "processing doc");
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000699 xmlFree(newctxt);
700 return;
701 }
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000702 /*
703 * copy the urlTab
704 */
705 newctxt->urlMax = ctxt->urlMax;
706 newctxt->urlNr = ctxt->urlNr;
707 newctxt->urlTab = ctxt->urlTab;
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000708
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000709 /*
William M. Brackf7789b12004-06-07 08:57:27 +0000710 * Inherit the existing base
711 */
Daniel Veillardce244ad2004-11-05 10:03:46 +0000712 newctxt->base = xmlStrdup(ctxt->base);
William M. Brackf7789b12004-06-07 08:57:27 +0000713
714 /*
William M. Brack72ee48d2003-12-30 08:30:19 +0000715 * Inherit the documents already in use by other includes
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000716 */
717 newctxt->incBase = ctxt->incNr;
718 for (i = 0;i < ctxt->incNr;i++) {
719 newctxt->incTab[i] = ctxt->incTab[i];
720 newctxt->incTab[i]->count++; /* prevent the recursion from
721 freeing it */
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000722 }
William M. Bracka11e4832004-03-07 11:03:43 +0000723 /*
724 * The new context should also inherit the Parse Flags
725 * (bug 132597)
726 */
727 newctxt->parseFlags = ctxt->parseFlags;
Daniel Veillard8edf1c52003-07-22 20:52:14 +0000728 xmlXIncludeDoProcess(newctxt, doc, xmlDocGetRootElement(doc));
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000729 for (i = 0;i < ctxt->incNr;i++) {
730 newctxt->incTab[i]->count--;
731 newctxt->incTab[i] = NULL;
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000732 }
Daniel Veillardd9b72832003-03-27 14:24:00 +0000733
734 /* urlTab may have been reallocated */
735 ctxt->urlTab = newctxt->urlTab;
736 ctxt->urlMax = newctxt->urlMax;
737
Daniel Veillardf4b4f982003-02-13 11:02:08 +0000738 newctxt->urlMax = 0;
739 newctxt->urlNr = 0;
740 newctxt->urlTab = NULL;
741
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000742 xmlXIncludeFreeContext(newctxt);
743 }
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000744#ifdef DEBUG_XINCLUDE
745 xmlGenericError(xmlGenericErrorContext, "Done recursing in doc %s\n", url);
746#endif
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000747}
748
749/**
750 * xmlXIncludeAddTxt:
751 * @ctxt: the XInclude context
752 * @txt: the new text node
753 * @url: the associated URL
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800754 *
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000755 * Add a new txtument to the list
756 */
757static void
758xmlXIncludeAddTxt(xmlXIncludeCtxtPtr ctxt, xmlNodePtr txt, const xmlURL url) {
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000759#ifdef DEBUG_XINCLUDE
760 xmlGenericError(xmlGenericErrorContext, "Adding text %s\n", url);
761#endif
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000762 if (ctxt->txtMax == 0) {
763 ctxt->txtMax = 4;
764 ctxt->txtTab = (xmlNodePtr *) xmlMalloc(ctxt->txtMax *
765 sizeof(ctxt->txtTab[0]));
766 if (ctxt->txtTab == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000767 xmlXIncludeErrMemory(ctxt, NULL, "processing text");
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000768 return;
769 }
770 ctxt->txturlTab = (xmlURL *) xmlMalloc(ctxt->txtMax *
771 sizeof(ctxt->txturlTab[0]));
772 if (ctxt->txturlTab == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000773 xmlXIncludeErrMemory(ctxt, NULL, "processing text");
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000774 return;
775 }
776 }
777 if (ctxt->txtNr >= ctxt->txtMax) {
778 ctxt->txtMax *= 2;
779 ctxt->txtTab = (xmlNodePtr *) xmlRealloc(ctxt->txtTab,
780 ctxt->txtMax * sizeof(ctxt->txtTab[0]));
781 if (ctxt->txtTab == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000782 xmlXIncludeErrMemory(ctxt, NULL, "processing text");
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000783 return;
784 }
785 ctxt->txturlTab = (xmlURL *) xmlRealloc(ctxt->txturlTab,
Daniel Veillardbbc72c32002-09-05 10:52:10 +0000786 ctxt->txtMax * sizeof(ctxt->txturlTab[0]));
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000787 if (ctxt->txturlTab == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000788 xmlXIncludeErrMemory(ctxt, NULL, "processing text");
Daniel Veillardd16df9f2001-05-23 13:44:21 +0000789 return;
790 }
791 }
792 ctxt->txtTab[ctxt->txtNr] = txt;
793 ctxt->txturlTab[ctxt->txtNr] = xmlStrdup(url);
794 ctxt->txtNr++;
795}
796
Owen Taylor3473f882001-02-23 17:55:21 +0000797/************************************************************************
798 * *
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000799 * Node copy with specific semantic *
800 * *
801 ************************************************************************/
802
Daniel Veillardcb6f5252009-08-25 19:24:15 +0200803static xmlNodePtr
804xmlXIncludeCopyNodeList(xmlXIncludeCtxtPtr ctxt, xmlDocPtr target,
805 xmlDocPtr source, xmlNodePtr elem);
806
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000807/**
808 * xmlXIncludeCopyNode:
809 * @ctxt: the XInclude context
810 * @target: the document target
811 * @source: the document source
812 * @elem: the element
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800813 *
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000814 * Make a copy of the node while preserving the XInclude semantic
815 * of the Infoset copy
816 */
817static xmlNodePtr
818xmlXIncludeCopyNode(xmlXIncludeCtxtPtr ctxt, xmlDocPtr target,
819 xmlDocPtr source, xmlNodePtr elem) {
820 xmlNodePtr result = NULL;
821
822 if ((ctxt == NULL) || (target == NULL) || (source == NULL) ||
823 (elem == NULL))
824 return(NULL);
825 if (elem->type == XML_DTD_NODE)
826 return(NULL);
Daniel Veillardcb6f5252009-08-25 19:24:15 +0200827 if (elem->type == XML_DOCUMENT_NODE)
828 result = xmlXIncludeCopyNodeList(ctxt, target, source, elem->children);
829 else
830 result = xmlDocCopyNode(elem, target, 1);
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000831 return(result);
832}
833
834/**
835 * xmlXIncludeCopyNodeList:
836 * @ctxt: the XInclude context
837 * @target: the document target
838 * @source: the document source
839 * @elem: the element list
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800840 *
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000841 * Make a copy of the node list while preserving the XInclude semantic
842 * of the Infoset copy
843 */
844static xmlNodePtr
845xmlXIncludeCopyNodeList(xmlXIncludeCtxtPtr ctxt, xmlDocPtr target,
846 xmlDocPtr source, xmlNodePtr elem) {
847 xmlNodePtr cur, res, result = NULL, last = NULL;
848
849 if ((ctxt == NULL) || (target == NULL) || (source == NULL) ||
850 (elem == NULL))
851 return(NULL);
852 cur = elem;
853 while (cur != NULL) {
854 res = xmlXIncludeCopyNode(ctxt, target, source, cur);
855 if (res != NULL) {
856 if (result == NULL) {
857 result = last = res;
858 } else {
859 last->next = res;
860 res->prev = last;
861 last = res;
862 }
863 }
864 cur = cur->next;
865 }
866 return(result);
867}
868
869/**
William M. Brack72ee48d2003-12-30 08:30:19 +0000870 * xmlXIncludeGetNthChild:
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000871 * @cur: the node
872 * @no: the child number
873 *
William M. Brack72ee48d2003-12-30 08:30:19 +0000874 * Returns the @n'th element child of @cur or NULL
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000875 */
876static xmlNodePtr
877xmlXIncludeGetNthChild(xmlNodePtr cur, int no) {
878 int i;
Daniel Veillard3e62adb2012-08-09 14:24:02 +0800879 if ((cur == NULL) || (cur->type == XML_NAMESPACE_DECL))
880 return(NULL);
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000881 cur = cur->children;
882 for (i = 0;i <= no;cur = cur->next) {
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800883 if (cur == NULL)
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000884 return(cur);
885 if ((cur->type == XML_ELEMENT_NODE) ||
886 (cur->type == XML_DOCUMENT_NODE) ||
887 (cur->type == XML_HTML_DOCUMENT_NODE)) {
888 i++;
889 if (i == no)
890 break;
891 }
892 }
893 return(cur);
894}
895
William M. Brackf7eb7942003-12-31 07:59:17 +0000896xmlNodePtr xmlXPtrAdvanceNode(xmlNodePtr cur, int *level); /* in xpointer.c */
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000897/**
898 * xmlXIncludeCopyRange:
899 * @ctxt: the XInclude context
900 * @target: the document target
901 * @source: the document source
902 * @obj: the XPointer result from the evaluation.
903 *
904 * Build a node list tree copy of the XPointer result.
905 *
906 * Returns an xmlNodePtr list or NULL.
William M. Brack72ee48d2003-12-30 08:30:19 +0000907 * The caller has to free the node tree.
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000908 */
909static xmlNodePtr
910xmlXIncludeCopyRange(xmlXIncludeCtxtPtr ctxt, xmlDocPtr target,
911 xmlDocPtr source, xmlXPathObjectPtr range) {
912 /* pointers to generated nodes */
William M. Brackf7eb7942003-12-31 07:59:17 +0000913 xmlNodePtr list = NULL, last = NULL, listParent = NULL;
914 xmlNodePtr tmp, tmp2;
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000915 /* pointers to traversal nodes */
916 xmlNodePtr start, cur, end;
917 int index1, index2;
William M. Brack6bdacd72004-02-07 08:53:23 +0000918 int level = 0, lastLevel = 0, endLevel = 0, endFlag = 0;
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000919
920 if ((ctxt == NULL) || (target == NULL) || (source == NULL) ||
921 (range == NULL))
922 return(NULL);
923 if (range->type != XPATH_RANGE)
924 return(NULL);
925 start = (xmlNodePtr) range->user;
926
Daniel Veillard3e62adb2012-08-09 14:24:02 +0800927 if ((start == NULL) || (start->type == XML_NAMESPACE_DECL))
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000928 return(NULL);
929 end = range->user2;
930 if (end == NULL)
931 return(xmlDocCopyNode(start, target, 1));
Daniel Veillard3e62adb2012-08-09 14:24:02 +0800932 if (end->type == XML_NAMESPACE_DECL)
933 return(NULL);
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000934
935 cur = start;
936 index1 = range->index;
937 index2 = range->index2;
William M. Brackf7eb7942003-12-31 07:59:17 +0000938 /*
939 * level is depth of the current node under consideration
940 * list is the pointer to the root of the output tree
941 * listParent is a pointer to the parent of output tree (within
942 the included file) in case we need to add another level
943 * last is a pointer to the last node added to the output tree
944 * lastLevel is the depth of last (relative to the root)
945 */
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000946 while (cur != NULL) {
William M. Brackf7eb7942003-12-31 07:59:17 +0000947 /*
948 * Check if our output tree needs a parent
949 */
950 if (level < 0) {
951 while (level < 0) {
William M. Brack57e9e912004-03-09 16:19:02 +0000952 /* copy must include namespaces and properties */
953 tmp2 = xmlDocCopyNode(listParent, target, 2);
William M. Brackf7eb7942003-12-31 07:59:17 +0000954 xmlAddChild(tmp2, list);
955 list = tmp2;
956 listParent = listParent->parent;
957 level++;
958 }
959 last = list;
960 lastLevel = 0;
961 }
962 /*
963 * Check whether we need to change our insertion point
964 */
965 while (level < lastLevel) {
966 last = last->parent;
967 lastLevel --;
968 }
William M. Brack72ee48d2003-12-30 08:30:19 +0000969 if (cur == end) { /* Are we at the end of the range? */
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000970 if (cur->type == XML_TEXT_NODE) {
971 const xmlChar *content = cur->content;
972 int len;
973
974 if (content == NULL) {
975 tmp = xmlNewTextLen(NULL, 0);
976 } else {
977 len = index2;
978 if ((cur == start) && (index1 > 1)) {
979 content += (index1 - 1);
980 len -= (index1 - 1);
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000981 } else {
982 len = index2;
983 }
984 tmp = xmlNewTextLen(content, len);
985 }
986 /* single sub text node selection */
987 if (list == NULL)
988 return(tmp);
989 /* prune and return full set */
William M. Brackf7eb7942003-12-31 07:59:17 +0000990 if (level == lastLevel)
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000991 xmlAddNextSibling(last, tmp);
Daniel Veillardf8e3db02012-09-11 13:26:36 +0800992 else
William M. Brackf7eb7942003-12-31 07:59:17 +0000993 xmlAddChild(last, tmp);
Daniel Veillardc5f05ad2002-02-10 11:57:22 +0000994 return(list);
William M. Brack72ee48d2003-12-30 08:30:19 +0000995 } else { /* ending node not a text node */
William M. Brack6bdacd72004-02-07 08:53:23 +0000996 endLevel = level; /* remember the level of the end node */
997 endFlag = 1;
William M. Brack57e9e912004-03-09 16:19:02 +0000998 /* last node - need to take care of properties + namespaces */
999 tmp = xmlDocCopyNode(cur, target, 2);
William M. Brackf7eb7942003-12-31 07:59:17 +00001000 if (list == NULL) {
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001001 list = tmp;
William M. Brackf7eb7942003-12-31 07:59:17 +00001002 listParent = cur->parent;
1003 } else {
1004 if (level == lastLevel)
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001005 xmlAddNextSibling(last, tmp);
William M. Brackf7eb7942003-12-31 07:59:17 +00001006 else {
1007 xmlAddChild(last, tmp);
1008 lastLevel = level;
1009 }
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001010 }
William M. Brackf7eb7942003-12-31 07:59:17 +00001011 last = tmp;
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001012
1013 if (index2 > 1) {
1014 end = xmlXIncludeGetNthChild(cur, index2 - 1);
1015 index2 = 0;
1016 }
1017 if ((cur == start) && (index1 > 1)) {
1018 cur = xmlXIncludeGetNthChild(cur, index1 - 1);
1019 index1 = 0;
William M. Brack6bdacd72004-02-07 08:53:23 +00001020 } else {
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001021 cur = cur->children;
1022 }
William M. Brack6bdacd72004-02-07 08:53:23 +00001023 level++; /* increment level to show change */
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001024 /*
1025 * Now gather the remaining nodes from cur to end
1026 */
William M. Brack6bdacd72004-02-07 08:53:23 +00001027 continue; /* while */
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001028 }
William M. Brackf7eb7942003-12-31 07:59:17 +00001029 } else if (cur == start) { /* Not at the end, are we at start? */
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001030 if ((cur->type == XML_TEXT_NODE) ||
1031 (cur->type == XML_CDATA_SECTION_NODE)) {
1032 const xmlChar *content = cur->content;
1033
1034 if (content == NULL) {
1035 tmp = xmlNewTextLen(NULL, 0);
1036 } else {
1037 if (index1 > 1) {
1038 content += (index1 - 1);
William M. Brack72ee48d2003-12-30 08:30:19 +00001039 index1 = 0;
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001040 }
1041 tmp = xmlNewText(content);
1042 }
1043 last = list = tmp;
William M. Brackf7eb7942003-12-31 07:59:17 +00001044 listParent = cur->parent;
William M. Brack72ee48d2003-12-30 08:30:19 +00001045 } else { /* Not text node */
William M. Brack57e9e912004-03-09 16:19:02 +00001046 /*
1047 * start of the range - need to take care of
1048 * properties and namespaces
1049 */
1050 tmp = xmlDocCopyNode(cur, target, 2);
William M. Brackf7eb7942003-12-31 07:59:17 +00001051 list = last = tmp;
1052 listParent = cur->parent;
William M. Brack72ee48d2003-12-30 08:30:19 +00001053 if (index1 > 1) { /* Do we need to position? */
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001054 cur = xmlXIncludeGetNthChild(cur, index1 - 1);
William M. Brackf7eb7942003-12-31 07:59:17 +00001055 level = lastLevel = 1;
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001056 index1 = 0;
1057 /*
1058 * Now gather the remaining nodes from cur to end
1059 */
1060 continue; /* while */
1061 }
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001062 }
1063 } else {
1064 tmp = NULL;
1065 switch (cur->type) {
1066 case XML_DTD_NODE:
1067 case XML_ELEMENT_DECL:
1068 case XML_ATTRIBUTE_DECL:
1069 case XML_ENTITY_NODE:
1070 /* Do not copy DTD informations */
1071 break;
1072 case XML_ENTITY_DECL:
1073 /* handle crossing entities -> stack needed */
1074 break;
1075 case XML_XINCLUDE_START:
1076 case XML_XINCLUDE_END:
1077 /* don't consider it part of the tree content */
1078 break;
1079 case XML_ATTRIBUTE_NODE:
1080 /* Humm, should not happen ! */
1081 break;
1082 default:
William M. Brack57e9e912004-03-09 16:19:02 +00001083 /*
1084 * Middle of the range - need to take care of
1085 * properties and namespaces
1086 */
1087 tmp = xmlDocCopyNode(cur, target, 2);
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001088 break;
1089 }
1090 if (tmp != NULL) {
William M. Brackf7eb7942003-12-31 07:59:17 +00001091 if (level == lastLevel)
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001092 xmlAddNextSibling(last, tmp);
1093 else {
William M. Brackf7eb7942003-12-31 07:59:17 +00001094 xmlAddChild(last, tmp);
1095 lastLevel = level;
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001096 }
William M. Brackf7eb7942003-12-31 07:59:17 +00001097 last = tmp;
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001098 }
1099 }
1100 /*
1101 * Skip to next node in document order
1102 */
William M. Brackf7eb7942003-12-31 07:59:17 +00001103 cur = xmlXPtrAdvanceNode(cur, &level);
William M. Brack6bdacd72004-02-07 08:53:23 +00001104 if (endFlag && (level >= endLevel))
1105 break;
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001106 }
1107 return(list);
1108}
1109
1110/**
1111 * xmlXIncludeBuildNodeList:
1112 * @ctxt: the XInclude context
1113 * @target: the document target
1114 * @source: the document source
1115 * @obj: the XPointer result from the evaluation.
1116 *
1117 * Build a node list tree copy of the XPointer result.
1118 * This will drop Attributes and Namespace declarations.
1119 *
1120 * Returns an xmlNodePtr list or NULL.
1121 * the caller has to free the node tree.
1122 */
1123static xmlNodePtr
1124xmlXIncludeCopyXPointer(xmlXIncludeCtxtPtr ctxt, xmlDocPtr target,
1125 xmlDocPtr source, xmlXPathObjectPtr obj) {
1126 xmlNodePtr list = NULL, last = NULL;
1127 int i;
1128
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001129 if (source == NULL)
1130 source = ctxt->doc;
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001131 if ((ctxt == NULL) || (target == NULL) || (source == NULL) ||
1132 (obj == NULL))
1133 return(NULL);
1134 switch (obj->type) {
1135 case XPATH_NODESET: {
1136 xmlNodeSetPtr set = obj->nodesetval;
1137 if (set == NULL)
1138 return(NULL);
1139 for (i = 0;i < set->nodeNr;i++) {
1140 if (set->nodeTab[i] == NULL)
1141 continue;
1142 switch (set->nodeTab[i]->type) {
1143 case XML_TEXT_NODE:
1144 case XML_CDATA_SECTION_NODE:
1145 case XML_ELEMENT_NODE:
1146 case XML_ENTITY_REF_NODE:
1147 case XML_ENTITY_NODE:
1148 case XML_PI_NODE:
1149 case XML_COMMENT_NODE:
1150 case XML_DOCUMENT_NODE:
1151 case XML_HTML_DOCUMENT_NODE:
1152#ifdef LIBXML_DOCB_ENABLED
1153 case XML_DOCB_DOCUMENT_NODE:
1154#endif
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001155 case XML_XINCLUDE_END:
1156 break;
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001157 case XML_XINCLUDE_START: {
1158 xmlNodePtr tmp, cur = set->nodeTab[i];
1159
1160 cur = cur->next;
1161 while (cur != NULL) {
1162 switch(cur->type) {
1163 case XML_TEXT_NODE:
1164 case XML_CDATA_SECTION_NODE:
1165 case XML_ELEMENT_NODE:
1166 case XML_ENTITY_REF_NODE:
1167 case XML_ENTITY_NODE:
1168 case XML_PI_NODE:
1169 case XML_COMMENT_NODE:
1170 tmp = xmlXIncludeCopyNode(ctxt, target,
1171 source, cur);
1172 if (last == NULL) {
1173 list = last = tmp;
1174 } else {
1175 xmlAddNextSibling(last, tmp);
1176 last = tmp;
1177 }
1178 cur = cur->next;
1179 continue;
1180 default:
1181 break;
1182 }
1183 break;
1184 }
1185 continue;
1186 }
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001187 case XML_ATTRIBUTE_NODE:
1188 case XML_NAMESPACE_DECL:
1189 case XML_DOCUMENT_TYPE_NODE:
1190 case XML_DOCUMENT_FRAG_NODE:
1191 case XML_NOTATION_NODE:
1192 case XML_DTD_NODE:
1193 case XML_ELEMENT_DECL:
1194 case XML_ATTRIBUTE_DECL:
1195 case XML_ENTITY_DECL:
1196 continue; /* for */
1197 }
1198 if (last == NULL)
1199 list = last = xmlXIncludeCopyNode(ctxt, target, source,
1200 set->nodeTab[i]);
1201 else {
1202 xmlAddNextSibling(last,
1203 xmlXIncludeCopyNode(ctxt, target, source,
1204 set->nodeTab[i]));
1205 if (last->next != NULL)
1206 last = last->next;
1207 }
1208 }
1209 break;
1210 }
Nicolas Le Cam41586ca2013-06-17 13:01:33 +02001211#ifdef LIBXML_XPTR_ENABLED
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001212 case XPATH_LOCATIONSET: {
1213 xmlLocationSetPtr set = (xmlLocationSetPtr) obj->user;
1214 if (set == NULL)
1215 return(NULL);
1216 for (i = 0;i < set->locNr;i++) {
1217 if (last == NULL)
1218 list = last = xmlXIncludeCopyXPointer(ctxt, target, source,
1219 set->locTab[i]);
1220 else
1221 xmlAddNextSibling(last,
1222 xmlXIncludeCopyXPointer(ctxt, target, source,
1223 set->locTab[i]));
1224 if (last != NULL) {
1225 while (last->next != NULL)
1226 last = last->next;
1227 }
1228 }
1229 break;
1230 }
1231 case XPATH_RANGE:
1232 return(xmlXIncludeCopyRange(ctxt, target, source, obj));
Daniel Veillard10acc2f2003-09-01 20:59:40 +00001233#endif
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001234 case XPATH_POINT:
1235 /* points are ignored in XInclude */
1236 break;
1237 default:
1238 break;
1239 }
1240 return(list);
1241}
1242/************************************************************************
1243 * *
Owen Taylor3473f882001-02-23 17:55:21 +00001244 * XInclude I/O handling *
1245 * *
1246 ************************************************************************/
1247
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001248typedef struct _xmlXIncludeMergeData xmlXIncludeMergeData;
1249typedef xmlXIncludeMergeData *xmlXIncludeMergeDataPtr;
1250struct _xmlXIncludeMergeData {
1251 xmlDocPtr doc;
1252 xmlXIncludeCtxtPtr ctxt;
1253};
1254
Owen Taylor3473f882001-02-23 17:55:21 +00001255/**
Daniel Veillard4287c572003-02-04 22:48:53 +00001256 * xmlXIncludeMergeOneEntity:
1257 * @ent: the entity
1258 * @doc: the including doc
1259 * @nr: the entity name
1260 *
1261 * Inplements the merge of one entity
1262 */
1263static void
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001264xmlXIncludeMergeEntity(xmlEntityPtr ent, xmlXIncludeMergeDataPtr data,
Daniel Veillard4287c572003-02-04 22:48:53 +00001265 xmlChar *name ATTRIBUTE_UNUSED) {
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001266 xmlEntityPtr ret, prev;
1267 xmlDocPtr doc;
1268 xmlXIncludeCtxtPtr ctxt;
Daniel Veillard4287c572003-02-04 22:48:53 +00001269
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001270 if ((ent == NULL) || (data == NULL))
Daniel Veillard4287c572003-02-04 22:48:53 +00001271 return;
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001272 ctxt = data->ctxt;
1273 doc = data->doc;
1274 if ((ctxt == NULL) || (doc == NULL))
1275 return;
1276 switch (ent->etype) {
1277 case XML_INTERNAL_PARAMETER_ENTITY:
1278 case XML_EXTERNAL_PARAMETER_ENTITY:
1279 case XML_INTERNAL_PREDEFINED_ENTITY:
1280 return;
1281 case XML_INTERNAL_GENERAL_ENTITY:
1282 case XML_EXTERNAL_GENERAL_PARSED_ENTITY:
1283 case XML_EXTERNAL_GENERAL_UNPARSED_ENTITY:
1284 break;
1285 }
Daniel Veillard4287c572003-02-04 22:48:53 +00001286 ret = xmlAddDocEntity(doc, ent->name, ent->etype, ent->ExternalID,
1287 ent->SystemID, ent->content);
1288 if (ret != NULL) {
1289 if (ent->URI != NULL)
1290 ret->URI = xmlStrdup(ent->URI);
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001291 } else {
1292 prev = xmlGetDocEntity(doc, ent->name);
1293 if (prev != NULL) {
1294 if (ent->etype != prev->etype)
1295 goto error;
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001296
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001297 if ((ent->SystemID != NULL) && (prev->SystemID != NULL)) {
1298 if (!xmlStrEqual(ent->SystemID, prev->SystemID))
1299 goto error;
Daniel Veillardb6c7f412003-03-29 16:41:55 +00001300 } else if ((ent->ExternalID != NULL) &&
1301 (prev->ExternalID != NULL)) {
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001302 if (!xmlStrEqual(ent->ExternalID, prev->ExternalID))
1303 goto error;
Daniel Veillard2406abd2003-02-24 18:16:47 +00001304 } else if ((ent->content != NULL) && (prev->content != NULL)) {
1305 if (!xmlStrEqual(ent->content, prev->content))
1306 goto error;
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001307 } else {
1308 goto error;
1309 }
1310
1311 }
Daniel Veillard4287c572003-02-04 22:48:53 +00001312 }
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001313 return;
1314error:
Daniel Veillarda507fbf2003-03-31 16:09:37 +00001315 switch (ent->etype) {
1316 case XML_INTERNAL_PARAMETER_ENTITY:
1317 case XML_EXTERNAL_PARAMETER_ENTITY:
1318 case XML_INTERNAL_PREDEFINED_ENTITY:
1319 case XML_INTERNAL_GENERAL_ENTITY:
1320 case XML_EXTERNAL_GENERAL_PARSED_ENTITY:
1321 return;
1322 case XML_EXTERNAL_GENERAL_UNPARSED_ENTITY:
1323 break;
1324 }
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001325 xmlXIncludeErr(ctxt, (xmlNodePtr) ent, XML_XINCLUDE_ENTITY_DEF_MISMATCH,
1326 "mismatch in redefinition of entity %s\n",
1327 ent->name);
Daniel Veillard4287c572003-02-04 22:48:53 +00001328}
1329
1330/**
1331 * xmlXIncludeMergeEntities:
1332 * @ctxt: an XInclude context
1333 * @doc: the including doc
1334 * @from: the included doc
1335 *
1336 * Inplements the entity merge
1337 *
1338 * Returns 0 if merge succeeded, -1 if some processing failed
1339 */
1340static int
1341xmlXIncludeMergeEntities(xmlXIncludeCtxtPtr ctxt, xmlDocPtr doc,
1342 xmlDocPtr from) {
1343 xmlNodePtr cur;
1344 xmlDtdPtr target, source;
1345
1346 if (ctxt == NULL)
1347 return(-1);
1348
1349 if ((from == NULL) || (from->intSubset == NULL))
1350 return(0);
1351
1352 target = doc->intSubset;
1353 if (target == NULL) {
1354 cur = xmlDocGetRootElement(doc);
1355 if (cur == NULL)
1356 return(-1);
1357 target = xmlCreateIntSubset(doc, cur->name, NULL, NULL);
1358 if (target == NULL)
1359 return(-1);
1360 }
1361
1362 source = from->intSubset;
1363 if ((source != NULL) && (source->entities != NULL)) {
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001364 xmlXIncludeMergeData data;
1365
1366 data.ctxt = ctxt;
1367 data.doc = doc;
1368
Daniel Veillard4287c572003-02-04 22:48:53 +00001369 xmlHashScan((xmlHashTablePtr) source->entities,
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001370 (xmlHashScanner) xmlXIncludeMergeEntity, &data);
Daniel Veillard4287c572003-02-04 22:48:53 +00001371 }
1372 source = from->extSubset;
1373 if ((source != NULL) && (source->entities != NULL)) {
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001374 xmlXIncludeMergeData data;
1375
1376 data.ctxt = ctxt;
1377 data.doc = doc;
1378
Daniel Veillard4287c572003-02-04 22:48:53 +00001379 /*
1380 * don't duplicate existing stuff when external subsets are the same
1381 */
1382 if ((!xmlStrEqual(target->ExternalID, source->ExternalID)) &&
1383 (!xmlStrEqual(target->SystemID, source->SystemID))) {
1384 xmlHashScan((xmlHashTablePtr) source->entities,
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001385 (xmlHashScanner) xmlXIncludeMergeEntity, &data);
Daniel Veillard4287c572003-02-04 22:48:53 +00001386 }
1387 }
1388 return(0);
1389}
1390
1391/**
Owen Taylor3473f882001-02-23 17:55:21 +00001392 * xmlXIncludeLoadDoc:
1393 * @ctxt: the XInclude context
1394 * @url: the associated URL
1395 * @nr: the xinclude node number
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001396 *
Owen Taylor3473f882001-02-23 17:55:21 +00001397 * Load the document, and store the result in the XInclude context
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001398 *
1399 * Returns 0 in case of success, -1 in case of failure
Owen Taylor3473f882001-02-23 17:55:21 +00001400 */
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001401static int
Owen Taylor3473f882001-02-23 17:55:21 +00001402xmlXIncludeLoadDoc(xmlXIncludeCtxtPtr ctxt, const xmlChar *url, int nr) {
1403 xmlDocPtr doc;
1404 xmlURIPtr uri;
1405 xmlChar *URL;
1406 xmlChar *fragment = NULL;
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001407 int i = 0;
William M. Brack4d59e222004-03-08 14:42:31 +00001408#ifdef LIBXML_XPTR_ENABLED
1409 int saveFlags;
1410#endif
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001411
1412#ifdef DEBUG_XINCLUDE
1413 xmlGenericError(xmlGenericErrorContext, "Loading doc %s:%d\n", url, nr);
1414#endif
Owen Taylor3473f882001-02-23 17:55:21 +00001415 /*
1416 * Check the URL and remove any fragment identifier
1417 */
1418 uri = xmlParseURI((const char *)url);
1419 if (uri == NULL) {
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001420 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001421 XML_XINCLUDE_HREF_URI,
1422 "invalid value URI %s\n", url);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001423 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00001424 }
1425 if (uri->fragment != NULL) {
1426 fragment = (xmlChar *) uri->fragment;
1427 uri->fragment = NULL;
1428 }
Daniel Veillardb98d0822003-12-24 11:06:25 +00001429 if ((ctxt->incTab != NULL) && (ctxt->incTab[nr] != NULL) &&
1430 (ctxt->incTab[nr]->fragment != NULL)) {
1431 if (fragment != NULL) xmlFree(fragment);
1432 fragment = xmlStrdup(ctxt->incTab[nr]->fragment);
1433 }
Owen Taylor3473f882001-02-23 17:55:21 +00001434 URL = xmlSaveUri(uri);
1435 xmlFreeURI(uri);
1436 if (URL == NULL) {
Daniel Veillard11ce4002006-03-10 00:36:23 +00001437 if (ctxt->incTab != NULL)
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001438 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillard11ce4002006-03-10 00:36:23 +00001439 XML_XINCLUDE_HREF_URI,
1440 "invalid value URI %s\n", url);
1441 else
1442 xmlXIncludeErr(ctxt, NULL,
1443 XML_XINCLUDE_HREF_URI,
1444 "invalid value URI %s\n", url);
Owen Taylor3473f882001-02-23 17:55:21 +00001445 if (fragment != NULL)
1446 xmlFree(fragment);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001447 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00001448 }
1449
1450 /*
1451 * Handling of references to the local document are done
1452 * directly through ctxt->doc.
1453 */
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001454 if ((URL[0] == 0) || (URL[0] == '#') ||
1455 ((ctxt->doc != NULL) && (xmlStrEqual(URL, ctxt->doc->URL)))) {
Owen Taylor3473f882001-02-23 17:55:21 +00001456 doc = NULL;
1457 goto loaded;
1458 }
1459
1460 /*
1461 * Prevent reloading twice the document.
1462 */
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001463 for (i = 0; i < ctxt->incNr; i++) {
1464 if ((xmlStrEqual(URL, ctxt->incTab[i]->URI)) &&
1465 (ctxt->incTab[i]->doc != NULL)) {
1466 doc = ctxt->incTab[i]->doc;
1467#ifdef DEBUG_XINCLUDE
1468 printf("Already loaded %s\n", URL);
1469#endif
Owen Taylor3473f882001-02-23 17:55:21 +00001470 goto loaded;
1471 }
1472 }
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001473
Owen Taylor3473f882001-02-23 17:55:21 +00001474 /*
1475 * Load it.
1476 */
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001477#ifdef DEBUG_XINCLUDE
1478 printf("loading %s\n", URL);
1479#endif
William M. Brack4d59e222004-03-08 14:42:31 +00001480#ifdef LIBXML_XPTR_ENABLED
1481 /*
1482 * If this is an XPointer evaluation, we want to assure that
1483 * all entities have been resolved prior to processing the
1484 * referenced document
1485 */
1486 saveFlags = ctxt->parseFlags;
1487 if (fragment != NULL) { /* if this is an XPointer eval */
1488 ctxt->parseFlags |= XML_PARSE_NOENT;
1489 }
1490#endif
1491
Daniel Veillard98485322003-08-14 15:44:40 +00001492 doc = xmlXIncludeParseFile(ctxt, (const char *)URL);
William M. Brack4d59e222004-03-08 14:42:31 +00001493#ifdef LIBXML_XPTR_ENABLED
1494 ctxt->parseFlags = saveFlags;
1495#endif
Owen Taylor3473f882001-02-23 17:55:21 +00001496 if (doc == NULL) {
Owen Taylor3473f882001-02-23 17:55:21 +00001497 xmlFree(URL);
1498 if (fragment != NULL)
1499 xmlFree(fragment);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001500 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00001501 }
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001502 ctxt->incTab[nr]->doc = doc;
William M. Brackb85c9202004-07-26 00:20:13 +00001503 /*
1504 * It's possible that the requested URL has been mapped to a
1505 * completely different location (e.g. through a catalog entry).
1506 * To check for this, we compare the URL with that of the doc
1507 * and change it if they disagree (bug 146988).
1508 */
1509 if (!xmlStrEqual(URL, doc->URL)) {
1510 xmlFree(URL);
1511 URL = xmlStrdup(doc->URL);
1512 }
Daniel Veillard98485322003-08-14 15:44:40 +00001513 for (i = nr + 1; i < ctxt->incNr; i++) {
1514 if (xmlStrEqual(URL, ctxt->incTab[i]->URI)) {
1515 ctxt->incTab[nr]->count++;
1516#ifdef DEBUG_XINCLUDE
1517 printf("Increasing %s count since reused\n", URL);
1518#endif
1519 break;
1520 }
1521 }
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001522
1523 /*
Daniel Veillard4287c572003-02-04 22:48:53 +00001524 * Make sure we have all entities fixed up
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001525 */
Daniel Veillard4287c572003-02-04 22:48:53 +00001526 xmlXIncludeMergeEntities(ctxt, ctxt->doc, doc);
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001527
1528 /*
1529 * We don't need the DTD anymore, free up space
1530 if (doc->intSubset != NULL) {
1531 xmlUnlinkNode((xmlNodePtr) doc->intSubset);
1532 xmlFreeNode((xmlNodePtr) doc->intSubset);
1533 doc->intSubset = NULL;
1534 }
1535 if (doc->extSubset != NULL) {
1536 xmlUnlinkNode((xmlNodePtr) doc->extSubset);
1537 xmlFreeNode((xmlNodePtr) doc->extSubset);
1538 doc->extSubset = NULL;
1539 }
1540 */
1541 xmlXIncludeRecurseDoc(ctxt, doc, URL);
Owen Taylor3473f882001-02-23 17:55:21 +00001542
1543loaded:
1544 if (fragment == NULL) {
1545 /*
1546 * Add the top children list as the replacement copy.
Owen Taylor3473f882001-02-23 17:55:21 +00001547 */
1548 if (doc == NULL)
Daniel Veillard4497e692001-06-09 14:19:02 +00001549 {
1550 /* Hopefully a DTD declaration won't be copied from
1551 * the same document */
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001552 ctxt->incTab[nr]->inc = xmlCopyNodeList(ctxt->doc->children);
Daniel Veillard4497e692001-06-09 14:19:02 +00001553 } else {
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001554 ctxt->incTab[nr]->inc = xmlXIncludeCopyNodeList(ctxt, ctxt->doc,
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00001555 doc, doc->children);
Daniel Veillard4497e692001-06-09 14:19:02 +00001556 }
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001557 }
Daniel Veillard10acc2f2003-09-01 20:59:40 +00001558#ifdef LIBXML_XPTR_ENABLED
1559 else {
Owen Taylor3473f882001-02-23 17:55:21 +00001560 /*
1561 * Computes the XPointer expression and make a copy used
1562 * as the replacement copy.
1563 */
1564 xmlXPathObjectPtr xptr;
1565 xmlXPathContextPtr xptrctxt;
Daniel Veillard39196eb2001-06-19 18:09:42 +00001566 xmlNodeSetPtr set;
Owen Taylor3473f882001-02-23 17:55:21 +00001567
1568 if (doc == NULL) {
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001569 xptrctxt = xmlXPtrNewContext(ctxt->doc, ctxt->incTab[nr]->ref,
1570 NULL);
Owen Taylor3473f882001-02-23 17:55:21 +00001571 } else {
1572 xptrctxt = xmlXPtrNewContext(doc, NULL, NULL);
1573 }
1574 if (xptrctxt == NULL) {
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001575 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001576 XML_XINCLUDE_XPTR_FAILED,
Daniel Veillarda152c4d2003-11-19 16:24:26 +00001577 "could not create XPointer context\n", NULL);
Owen Taylor3473f882001-02-23 17:55:21 +00001578 xmlFree(URL);
1579 xmlFree(fragment);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001580 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00001581 }
1582 xptr = xmlXPtrEval(fragment, xptrctxt);
1583 if (xptr == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001584 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
1585 XML_XINCLUDE_XPTR_FAILED,
1586 "XPointer evaluation failed: #%s\n",
1587 fragment);
Owen Taylor3473f882001-02-23 17:55:21 +00001588 xmlXPathFreeContext(xptrctxt);
1589 xmlFree(URL);
1590 xmlFree(fragment);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001591 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00001592 }
Daniel Veillard39196eb2001-06-19 18:09:42 +00001593 switch (xptr->type) {
1594 case XPATH_UNDEFINED:
1595 case XPATH_BOOLEAN:
1596 case XPATH_NUMBER:
1597 case XPATH_STRING:
1598 case XPATH_POINT:
1599 case XPATH_USERS:
1600 case XPATH_XSLT_TREE:
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001601 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001602 XML_XINCLUDE_XPTR_RESULT,
1603 "XPointer is not a range: #%s\n",
1604 fragment);
Daniel Veillard39196eb2001-06-19 18:09:42 +00001605 xmlXPathFreeContext(xptrctxt);
1606 xmlFree(URL);
1607 xmlFree(fragment);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001608 return(-1);
Daniel Veillard39196eb2001-06-19 18:09:42 +00001609 case XPATH_NODESET:
Daniel Veillard798ae542003-11-03 17:13:52 +00001610 if ((xptr->nodesetval == NULL) ||
1611 (xptr->nodesetval->nodeNr <= 0)) {
1612 xmlXPathFreeContext(xptrctxt);
1613 xmlFree(URL);
1614 xmlFree(fragment);
1615 return(-1);
1616 }
William M. Brackabf598b2004-06-08 02:01:28 +00001617
Daniel Veillard39196eb2001-06-19 18:09:42 +00001618 case XPATH_RANGE:
1619 case XPATH_LOCATIONSET:
1620 break;
1621 }
1622 set = xptr->nodesetval;
1623 if (set != NULL) {
1624 for (i = 0;i < set->nodeNr;i++) {
1625 if (set->nodeTab[i] == NULL)
1626 continue;
1627 switch (set->nodeTab[i]->type) {
William M. Brackb0a94e82007-07-18 18:04:55 +00001628 case XML_ELEMENT_NODE:
Daniel Veillard39196eb2001-06-19 18:09:42 +00001629 case XML_TEXT_NODE:
1630 case XML_CDATA_SECTION_NODE:
Daniel Veillard39196eb2001-06-19 18:09:42 +00001631 case XML_ENTITY_REF_NODE:
1632 case XML_ENTITY_NODE:
1633 case XML_PI_NODE:
1634 case XML_COMMENT_NODE:
1635 case XML_DOCUMENT_NODE:
1636 case XML_HTML_DOCUMENT_NODE:
1637#ifdef LIBXML_DOCB_ENABLED
1638 case XML_DOCB_DOCUMENT_NODE:
1639#endif
1640 continue;
William M. Brackabf598b2004-06-08 02:01:28 +00001641
Daniel Veillard39196eb2001-06-19 18:09:42 +00001642 case XML_ATTRIBUTE_NODE:
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001643 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001644 XML_XINCLUDE_XPTR_RESULT,
1645 "XPointer selects an attribute: #%s\n",
1646 fragment);
Daniel Veillard39196eb2001-06-19 18:09:42 +00001647 set->nodeTab[i] = NULL;
1648 continue;
1649 case XML_NAMESPACE_DECL:
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001650 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001651 XML_XINCLUDE_XPTR_RESULT,
1652 "XPointer selects a namespace: #%s\n",
1653 fragment);
Daniel Veillard39196eb2001-06-19 18:09:42 +00001654 set->nodeTab[i] = NULL;
1655 continue;
1656 case XML_DOCUMENT_TYPE_NODE:
1657 case XML_DOCUMENT_FRAG_NODE:
1658 case XML_NOTATION_NODE:
1659 case XML_DTD_NODE:
1660 case XML_ELEMENT_DECL:
1661 case XML_ATTRIBUTE_DECL:
1662 case XML_ENTITY_DECL:
1663 case XML_XINCLUDE_START:
1664 case XML_XINCLUDE_END:
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001665 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001666 XML_XINCLUDE_XPTR_RESULT,
1667 "XPointer selects unexpected nodes: #%s\n",
1668 fragment);
Daniel Veillard39196eb2001-06-19 18:09:42 +00001669 set->nodeTab[i] = NULL;
1670 set->nodeTab[i] = NULL;
1671 continue; /* for */
1672 }
1673 }
1674 }
Daniel Veillardf4b4f982003-02-13 11:02:08 +00001675 if (doc == NULL) {
1676 ctxt->incTab[nr]->xptr = xptr;
1677 ctxt->incTab[nr]->inc = NULL;
1678 } else {
1679 ctxt->incTab[nr]->inc =
1680 xmlXIncludeCopyXPointer(ctxt, ctxt->doc, doc, xptr);
1681 xmlXPathFreeObject(xptr);
1682 }
Owen Taylor3473f882001-02-23 17:55:21 +00001683 xmlXPathFreeContext(xptrctxt);
1684 xmlFree(fragment);
1685 }
Daniel Veillard10acc2f2003-09-01 20:59:40 +00001686#endif
Daniel Veillardc4bad4a2002-08-14 14:45:25 +00001687
1688 /*
1689 * Do the xml:base fixup if needed
1690 */
Alexey Neyman0b865372013-05-06 10:20:18 +08001691 if ((doc != NULL) && (URL != NULL) &&
Daniel Veillard54bd29b2008-08-26 07:26:55 +00001692 (!(ctxt->parseFlags & XML_PARSE_NOBASEFIX)) &&
1693 (!(doc->parseFlags & XML_PARSE_NOBASEFIX))) {
Daniel Veillardc4bad4a2002-08-14 14:45:25 +00001694 xmlNodePtr node;
William M. Brack0b13a092005-06-01 03:37:59 +00001695 xmlChar *base;
William M. Brackabf598b2004-06-08 02:01:28 +00001696 xmlChar *curBase;
Daniel Veillardc4bad4a2002-08-14 14:45:25 +00001697
William M. Brackf7789b12004-06-07 08:57:27 +00001698 /*
William M. Brack0b13a092005-06-01 03:37:59 +00001699 * The base is only adjusted if "necessary", i.e. if the xinclude node
1700 * has a base specified, or the URL is relative
William M. Brackf7789b12004-06-07 08:57:27 +00001701 */
William M. Brack0b13a092005-06-01 03:37:59 +00001702 base = xmlGetNsProp(ctxt->incTab[nr]->ref, BAD_CAST "base",
1703 XML_XML_NAMESPACE);
1704 if (base == NULL) {
1705 /*
1706 * No xml:base on the xinclude node, so we check whether the
1707 * URI base is different than (relative to) the context base
1708 */
1709 curBase = xmlBuildRelativeURI(URL, ctxt->base);
1710 if (curBase == NULL) { /* Error return */
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001711 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
William M. Brackf7789b12004-06-07 08:57:27 +00001712 XML_XINCLUDE_HREF_URI,
1713 "trying to build relative URI from %s\n", URL);
William M. Brack0b13a092005-06-01 03:37:59 +00001714 } else {
1715 /* If the URI doesn't contain a slash, it's not relative */
1716 if (!xmlStrchr(curBase, (xmlChar) '/'))
1717 xmlFree(curBase);
1718 else
1719 base = curBase;
William M. Brackf7789b12004-06-07 08:57:27 +00001720 }
William M. Brack0b13a092005-06-01 03:37:59 +00001721 }
1722 if (base != NULL) { /* Adjustment may be needed */
1723 node = ctxt->incTab[nr]->inc;
1724 while (node != NULL) {
1725 /* Only work on element nodes */
1726 if (node->type == XML_ELEMENT_NODE) {
1727 curBase = xmlNodeGetBase(node->doc, node);
1728 /* If no current base, set it */
1729 if (curBase == NULL) {
1730 xmlNodeSetBase(node, base);
1731 } else {
1732 /*
1733 * If the current base is the same as the
1734 * URL of the document, then reset it to be
1735 * the specified xml:base or the relative URI
1736 */
1737 if (xmlStrEqual(curBase, node->doc->URL)) {
1738 xmlNodeSetBase(node, base);
1739 } else {
1740 /*
1741 * If the element already has an xml:base
1742 * set, then relativise it if necessary
1743 */
1744 xmlChar *xmlBase;
1745 xmlBase = xmlGetNsProp(node,
1746 BAD_CAST "base",
1747 XML_XML_NAMESPACE);
1748 if (xmlBase != NULL) {
1749 xmlChar *relBase;
1750 relBase = xmlBuildURI(xmlBase, base);
1751 if (relBase == NULL) { /* error */
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001752 xmlXIncludeErr(ctxt,
William M. Brack0b13a092005-06-01 03:37:59 +00001753 ctxt->incTab[nr]->ref,
1754 XML_XINCLUDE_HREF_URI,
1755 "trying to rebuild base from %s\n",
1756 xmlBase);
1757 } else {
1758 xmlNodeSetBase(node, relBase);
1759 xmlFree(relBase);
1760 }
1761 xmlFree(xmlBase);
1762 }
1763 }
1764 xmlFree(curBase);
1765 }
1766 }
1767 node = node->next;
1768 }
1769 xmlFree(base);
Daniel Veillardc4bad4a2002-08-14 14:45:25 +00001770 }
1771 }
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001772 if ((nr < ctxt->incNr) && (ctxt->incTab[nr]->doc != NULL) &&
1773 (ctxt->incTab[nr]->count <= 1)) {
1774#ifdef DEBUG_XINCLUDE
1775 printf("freeing %s\n", ctxt->incTab[nr]->doc->URL);
1776#endif
1777 xmlFreeDoc(ctxt->incTab[nr]->doc);
1778 ctxt->incTab[nr]->doc = NULL;
1779 }
Owen Taylor3473f882001-02-23 17:55:21 +00001780 xmlFree(URL);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001781 return(0);
Owen Taylor3473f882001-02-23 17:55:21 +00001782}
1783
1784/**
1785 * xmlXIncludeLoadTxt:
1786 * @ctxt: the XInclude context
1787 * @url: the associated URL
1788 * @nr: the xinclude node number
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001789 *
Owen Taylor3473f882001-02-23 17:55:21 +00001790 * Load the content, and store the result in the XInclude context
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001791 *
1792 * Returns 0 in case of success, -1 in case of failure
Owen Taylor3473f882001-02-23 17:55:21 +00001793 */
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001794static int
Owen Taylor3473f882001-02-23 17:55:21 +00001795xmlXIncludeLoadTxt(xmlXIncludeCtxtPtr ctxt, const xmlChar *url, int nr) {
1796 xmlParserInputBufferPtr buf;
1797 xmlNodePtr node;
1798 xmlURIPtr uri;
1799 xmlChar *URL;
1800 int i;
Daniel Veillardd076a202002-11-20 13:28:31 +00001801 xmlChar *encoding = NULL;
William M. Brack78637da2003-07-31 14:47:38 +00001802 xmlCharEncoding enc = (xmlCharEncoding) 0;
Shaun McCance4cf73252012-05-10 20:59:33 +08001803 xmlParserCtxtPtr pctxt;
1804 xmlParserInputPtr inputStream;
Vitaly Ostanindce1c8b2012-08-17 20:42:52 +08001805 int xinclude_multibyte_fallback_used = 0;
Daniel Veillardd076a202002-11-20 13:28:31 +00001806
Owen Taylor3473f882001-02-23 17:55:21 +00001807 /*
1808 * Check the URL and remove any fragment identifier
1809 */
1810 uri = xmlParseURI((const char *)url);
1811 if (uri == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001812 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref, XML_XINCLUDE_HREF_URI,
1813 "invalid value URI %s\n", url);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001814 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00001815 }
1816 if (uri->fragment != NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001817 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref, XML_XINCLUDE_TEXT_FRAGMENT,
1818 "fragment identifier forbidden for text: %s\n",
1819 (const xmlChar *) uri->fragment);
Owen Taylor3473f882001-02-23 17:55:21 +00001820 xmlFreeURI(uri);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001821 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00001822 }
1823 URL = xmlSaveUri(uri);
1824 xmlFreeURI(uri);
1825 if (URL == NULL) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001826 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref, XML_XINCLUDE_HREF_URI,
1827 "invalid value URI %s\n", url);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001828 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00001829 }
1830
1831 /*
1832 * Handling of references to the local document are done
1833 * directly through ctxt->doc.
1834 */
1835 if (URL[0] == 0) {
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001836 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001837 XML_XINCLUDE_TEXT_DOCUMENT,
1838 "text serialization of document not available\n", NULL);
Owen Taylor3473f882001-02-23 17:55:21 +00001839 xmlFree(URL);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001840 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00001841 }
1842
1843 /*
1844 * Prevent reloading twice the document.
1845 */
1846 for (i = 0; i < ctxt->txtNr; i++) {
1847 if (xmlStrEqual(URL, ctxt->txturlTab[i])) {
1848 node = xmlCopyNode(ctxt->txtTab[i], 1);
1849 goto loaded;
1850 }
1851 }
1852 /*
Daniel Veillardd076a202002-11-20 13:28:31 +00001853 * Try to get the encoding if available
Owen Taylor3473f882001-02-23 17:55:21 +00001854 */
Daniel Veillardd076a202002-11-20 13:28:31 +00001855 if ((ctxt->incTab[nr] != NULL) && (ctxt->incTab[nr]->ref != NULL)) {
1856 encoding = xmlGetProp(ctxt->incTab[nr]->ref, XINCLUDE_PARSE_ENCODING);
1857 }
1858 if (encoding != NULL) {
1859 /*
1860 * TODO: we should not have to remap to the xmlCharEncoding
1861 * predefined set, a better interface than
1862 * xmlParserInputBufferCreateFilename should allow any
1863 * encoding supported by iconv
1864 */
1865 enc = xmlParseCharEncoding((const char *) encoding);
1866 if (enc == XML_CHAR_ENCODING_ERROR) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +00001867 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
1868 XML_XINCLUDE_UNKNOWN_ENCODING,
1869 "encoding %s not supported\n", encoding);
Daniel Veillardd076a202002-11-20 13:28:31 +00001870 xmlFree(encoding);
1871 xmlFree(URL);
1872 return(-1);
1873 }
1874 xmlFree(encoding);
1875 }
1876
1877 /*
1878 * Load it.
1879 */
Shaun McCance4cf73252012-05-10 20:59:33 +08001880 pctxt = xmlNewParserCtxt();
1881 inputStream = xmlLoadExternalEntity((const char*)URL, NULL, pctxt);
1882 if(inputStream == NULL) {
1883 xmlFreeParserCtxt(pctxt);
Owen Taylor3473f882001-02-23 17:55:21 +00001884 xmlFree(URL);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001885 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00001886 }
Shaun McCance4cf73252012-05-10 20:59:33 +08001887 buf = inputStream->buf;
1888 if (buf == NULL) {
1889 xmlFreeInputStream (inputStream);
1890 xmlFreeParserCtxt(pctxt);
1891 xmlFree(URL);
1892 return(-1);
1893 }
1894 if (buf->encoder)
1895 xmlCharEncCloseFunc(buf->encoder);
1896 buf->encoder = xmlGetCharEncodingHandler(enc);
Owen Taylor3473f882001-02-23 17:55:21 +00001897 node = xmlNewText(NULL);
1898
1899 /*
1900 * Scan all chars from the resource and add the to the node
1901 */
Vitaly Ostanindce1c8b2012-08-17 20:42:52 +08001902xinclude_multibyte_fallback:
Owen Taylor3473f882001-02-23 17:55:21 +00001903 while (xmlParserInputBufferRead(buf, 128) > 0) {
1904 int len;
1905 const xmlChar *content;
1906
Daniel Veillard345ee8b2012-07-16 14:40:37 +08001907 content = xmlBufContent(buf->buffer);
1908 len = xmlBufLength(buf->buffer);
Daniel Veillardd076a202002-11-20 13:28:31 +00001909 for (i = 0;i < len;) {
1910 int cur;
1911 int l;
1912
1913 cur = xmlStringCurrentChar(NULL, &content[i], &l);
1914 if (!IS_CHAR(cur)) {
Vitaly Ostanindce1c8b2012-08-17 20:42:52 +08001915 /* Handle splitted multibyte char at buffer boundary */
1916 if (((len - i) < 4) && (!xinclude_multibyte_fallback_used)) {
1917 xinclude_multibyte_fallback_used = 1;
1918 xmlBufShrink(buf->buffer, i);
1919 goto xinclude_multibyte_fallback;
1920 } else {
1921 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
1922 XML_XINCLUDE_INVALID_CHAR,
1923 "%s contains invalid char\n", URL);
1924 xmlFreeParserInputBuffer(buf);
1925 xmlFree(URL);
1926 return(-1);
1927 }
Owen Taylor3473f882001-02-23 17:55:21 +00001928 } else {
Vitaly Ostanindce1c8b2012-08-17 20:42:52 +08001929 xinclude_multibyte_fallback_used = 0;
Daniel Veillardd076a202002-11-20 13:28:31 +00001930 xmlNodeAddContentLen(node, &content[i], l);
Owen Taylor3473f882001-02-23 17:55:21 +00001931 }
Daniel Veillardd076a202002-11-20 13:28:31 +00001932 i += l;
Owen Taylor3473f882001-02-23 17:55:21 +00001933 }
Daniel Veillard345ee8b2012-07-16 14:40:37 +08001934 xmlBufShrink(buf->buffer, len);
Owen Taylor3473f882001-02-23 17:55:21 +00001935 }
Shaun McCance4cf73252012-05-10 20:59:33 +08001936 xmlFreeParserCtxt(pctxt);
Owen Taylor3473f882001-02-23 17:55:21 +00001937 xmlXIncludeAddTxt(ctxt, node, URL);
Shaun McCance4cf73252012-05-10 20:59:33 +08001938 xmlFreeInputStream(inputStream);
Owen Taylor3473f882001-02-23 17:55:21 +00001939
1940loaded:
1941 /*
1942 * Add the element as the replacement copy.
1943 */
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001944 ctxt->incTab[nr]->inc = node;
Owen Taylor3473f882001-02-23 17:55:21 +00001945 xmlFree(URL);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001946 return(0);
1947}
1948
1949/**
1950 * xmlXIncludeLoadFallback:
1951 * @ctxt: the XInclude context
1952 * @fallback: the fallback node
1953 * @nr: the xinclude node number
Daniel Veillardf8e3db02012-09-11 13:26:36 +08001954 *
Daniel Veillardbbc72c32002-09-05 10:52:10 +00001955 * Load the content of the fallback node, and store the result
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001956 * in the XInclude context
1957 *
1958 * Returns 0 in case of success, -1 in case of failure
1959 */
1960static int
1961xmlXIncludeLoadFallback(xmlXIncludeCtxtPtr ctxt, xmlNodePtr fallback, int nr) {
William M. Brackaae10522004-01-02 14:59:41 +00001962 xmlXIncludeCtxtPtr newctxt;
1963 int ret = 0;
Daniel Veillard3e62adb2012-08-09 14:24:02 +08001964
1965 if ((fallback == NULL) || (fallback->type == XML_NAMESPACE_DECL) ||
1966 (ctxt == NULL))
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001967 return(-1);
William M. Brackef245fd2004-02-06 09:33:59 +00001968 if (fallback->children != NULL) {
1969 /*
1970 * It's possible that the fallback also has 'includes'
1971 * (Bug 129969), so we re-process the fallback just in case
1972 */
1973 newctxt = xmlXIncludeNewContext(ctxt->doc);
1974 if (newctxt == NULL)
1975 return (-1);
Daniel Veillarda6585822006-12-04 09:21:28 +00001976 newctxt->_private = ctxt->_private;
Daniel Veillardce244ad2004-11-05 10:03:46 +00001977 newctxt->base = xmlStrdup(ctxt->base); /* Inherit the base from the existing context */
William M. Brackef245fd2004-02-06 09:33:59 +00001978 xmlXIncludeSetFlags(newctxt, ctxt->parseFlags);
1979 ret = xmlXIncludeDoProcess(newctxt, ctxt->doc, fallback->children);
William M. Brack87640d52004-04-17 14:58:15 +00001980 if (ctxt->nbErrors > 0)
William M. Brackef245fd2004-02-06 09:33:59 +00001981 ret = -1;
William M. Brack87640d52004-04-17 14:58:15 +00001982 else if (ret > 0)
1983 ret = 0; /* xmlXIncludeDoProcess can return +ve number */
William M. Brackef245fd2004-02-06 09:33:59 +00001984 xmlXIncludeFreeContext(newctxt);
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00001985
Daniel Veillard03a53c32004-10-26 16:06:51 +00001986 ctxt->incTab[nr]->inc = xmlDocCopyNodeList(ctxt->doc,
1987 fallback->children);
William M. Brackef245fd2004-02-06 09:33:59 +00001988 } else {
1989 ctxt->incTab[nr]->inc = NULL;
William M. Brack95af5942004-02-08 04:12:49 +00001990 ctxt->incTab[nr]->emptyFb = 1; /* flag empty callback */
William M. Brackef245fd2004-02-06 09:33:59 +00001991 }
William M. Brackaae10522004-01-02 14:59:41 +00001992 return(ret);
Owen Taylor3473f882001-02-23 17:55:21 +00001993}
1994
1995/************************************************************************
1996 * *
1997 * XInclude Processing *
1998 * *
1999 ************************************************************************/
2000
2001/**
2002 * xmlXIncludePreProcessNode:
2003 * @ctxt: an XInclude context
2004 * @node: an XInclude node
2005 *
Daniel Veillardd16df9f2001-05-23 13:44:21 +00002006 * Implement the XInclude preprocessing, currently just adding the element
2007 * for further processing.
Owen Taylor3473f882001-02-23 17:55:21 +00002008 *
2009 * Returns the result list or NULL in case of error
2010 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +00002011static xmlNodePtr
Owen Taylor3473f882001-02-23 17:55:21 +00002012xmlXIncludePreProcessNode(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node) {
2013 xmlXIncludeAddNode(ctxt, node);
Daniel Veillard24505b02005-07-28 23:49:35 +00002014 return(NULL);
Owen Taylor3473f882001-02-23 17:55:21 +00002015}
2016
Daniel Veillardbbc72c32002-09-05 10:52:10 +00002017/**
Owen Taylor3473f882001-02-23 17:55:21 +00002018 * xmlXIncludeLoadNode:
2019 * @ctxt: an XInclude context
2020 * @nr: the node number
2021 *
2022 * Find and load the infoset replacement for the given node.
2023 *
Daniel Veillardcbaf3992001-12-31 16:16:02 +00002024 * Returns 0 if substitution succeeded, -1 if some processing failed
Owen Taylor3473f882001-02-23 17:55:21 +00002025 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +00002026static int
Owen Taylor3473f882001-02-23 17:55:21 +00002027xmlXIncludeLoadNode(xmlXIncludeCtxtPtr ctxt, int nr) {
2028 xmlNodePtr cur;
2029 xmlChar *href;
2030 xmlChar *parse;
2031 xmlChar *base;
William M. Brackf7789b12004-06-07 08:57:27 +00002032 xmlChar *oldBase;
Owen Taylor3473f882001-02-23 17:55:21 +00002033 xmlChar *URI;
2034 int xml = 1; /* default Issue 64 */
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00002035 int ret;
Owen Taylor3473f882001-02-23 17:55:21 +00002036
2037 if (ctxt == NULL)
2038 return(-1);
2039 if ((nr < 0) || (nr >= ctxt->incNr))
2040 return(-1);
Daniel Veillardbbc72c32002-09-05 10:52:10 +00002041 cur = ctxt->incTab[nr]->ref;
Owen Taylor3473f882001-02-23 17:55:21 +00002042 if (cur == NULL)
2043 return(-1);
2044
Owen Taylor3473f882001-02-23 17:55:21 +00002045 /*
2046 * read the attributes
2047 */
Daniel Veillardb5fa0202003-12-08 17:41:29 +00002048 href = xmlXIncludeGetProp(ctxt, cur, XINCLUDE_HREF);
Owen Taylor3473f882001-02-23 17:55:21 +00002049 if (href == NULL) {
Daniel Veillard03c2f0a2004-01-25 19:54:59 +00002050 href = xmlStrdup(BAD_CAST ""); /* @@@@ href is now optional */
Daniel Veillardf8e3db02012-09-11 13:26:36 +08002051 if (href == NULL)
Daniel Veillard03c2f0a2004-01-25 19:54:59 +00002052 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00002053 }
Daniel Veillardb5fa0202003-12-08 17:41:29 +00002054 parse = xmlXIncludeGetProp(ctxt, cur, XINCLUDE_PARSE);
Owen Taylor3473f882001-02-23 17:55:21 +00002055 if (parse != NULL) {
2056 if (xmlStrEqual(parse, XINCLUDE_PARSE_XML))
2057 xml = 1;
2058 else if (xmlStrEqual(parse, XINCLUDE_PARSE_TEXT))
2059 xml = 0;
2060 else {
Daniel Veillardcd6ff282003-10-08 22:38:13 +00002061 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
2062 XML_XINCLUDE_PARSE_VALUE,
2063 "invalid value %s for 'parse'\n", parse);
Owen Taylor3473f882001-02-23 17:55:21 +00002064 if (href != NULL)
2065 xmlFree(href);
2066 if (parse != NULL)
2067 xmlFree(parse);
2068 return(-1);
2069 }
2070 }
2071
2072 /*
2073 * compute the URI
2074 */
2075 base = xmlNodeGetBase(ctxt->doc, cur);
2076 if (base == NULL) {
2077 URI = xmlBuildURI(href, ctxt->doc->URL);
2078 } else {
2079 URI = xmlBuildURI(href, base);
2080 }
2081 if (URI == NULL) {
2082 xmlChar *escbase;
2083 xmlChar *eschref;
2084 /*
Daniel Veillardcbaf3992001-12-31 16:16:02 +00002085 * Some escaping may be needed
Owen Taylor3473f882001-02-23 17:55:21 +00002086 */
2087 escbase = xmlURIEscape(base);
2088 eschref = xmlURIEscape(href);
2089 URI = xmlBuildURI(eschref, escbase);
2090 if (escbase != NULL)
2091 xmlFree(escbase);
2092 if (eschref != NULL)
2093 xmlFree(eschref);
2094 }
2095 if (URI == NULL) {
Daniel Veillardf8e3db02012-09-11 13:26:36 +08002096 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillardcd6ff282003-10-08 22:38:13 +00002097 XML_XINCLUDE_HREF_URI, "failed build URL\n", NULL);
Owen Taylor3473f882001-02-23 17:55:21 +00002098 if (parse != NULL)
2099 xmlFree(parse);
2100 if (href != NULL)
2101 xmlFree(href);
2102 if (base != NULL)
2103 xmlFree(base);
2104 return(-1);
2105 }
2106#ifdef DEBUG_XINCLUDE
2107 xmlGenericError(xmlGenericErrorContext, "parse: %s\n",
2108 xml ? "xml": "text");
2109 xmlGenericError(xmlGenericErrorContext, "URI: %s\n", URI);
2110#endif
2111
2112 /*
William M. Brackf7789b12004-06-07 08:57:27 +00002113 * Save the base for this include (saving the current one)
Owen Taylor3473f882001-02-23 17:55:21 +00002114 */
William M. Brackf7789b12004-06-07 08:57:27 +00002115 oldBase = ctxt->base;
2116 ctxt->base = base;
2117
Owen Taylor3473f882001-02-23 17:55:21 +00002118 if (xml) {
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00002119 ret = xmlXIncludeLoadDoc(ctxt, URI, nr);
Owen Taylor3473f882001-02-23 17:55:21 +00002120 /* xmlXIncludeGetFragment(ctxt, cur, URI); */
2121 } else {
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00002122 ret = xmlXIncludeLoadTxt(ctxt, URI, nr);
2123 }
William M. Brackf7789b12004-06-07 08:57:27 +00002124
2125 /*
2126 * Restore the original base before checking for fallback
2127 */
2128 ctxt->base = oldBase;
Daniel Veillardf8e3db02012-09-11 13:26:36 +08002129
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00002130 if (ret < 0) {
2131 xmlNodePtr children;
2132
2133 /*
2134 * Time to try a fallback if availble
2135 */
2136#ifdef DEBUG_XINCLUDE
2137 xmlGenericError(xmlGenericErrorContext, "error looking for fallback\n");
2138#endif
2139 children = cur->children;
2140 while (children != NULL) {
2141 if ((children->type == XML_ELEMENT_NODE) &&
2142 (children->ns != NULL) &&
2143 (xmlStrEqual(children->name, XINCLUDE_FALLBACK)) &&
Daniel Veillardb5fa0202003-12-08 17:41:29 +00002144 ((xmlStrEqual(children->ns->href, XINCLUDE_NS)) ||
2145 (xmlStrEqual(children->ns->href, XINCLUDE_OLD_NS)))) {
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00002146 ret = xmlXIncludeLoadFallback(ctxt, children, nr);
Daniel Veillardf8e3db02012-09-11 13:26:36 +08002147 if (ret == 0)
Daniel Veillarde3b7d9a2002-08-14 14:11:30 +00002148 break;
2149 }
2150 children = children->next;
2151 }
2152 }
2153 if (ret < 0) {
Daniel Veillardf8e3db02012-09-11 13:26:36 +08002154 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillardcd6ff282003-10-08 22:38:13 +00002155 XML_XINCLUDE_NO_FALLBACK,
2156 "could not load %s, and no fallback was found\n",
2157 URI);
Owen Taylor3473f882001-02-23 17:55:21 +00002158 }
2159
2160 /*
2161 * Cleanup
2162 */
2163 if (URI != NULL)
2164 xmlFree(URI);
2165 if (parse != NULL)
2166 xmlFree(parse);
2167 if (href != NULL)
2168 xmlFree(href);
2169 if (base != NULL)
2170 xmlFree(base);
2171 return(0);
2172}
2173
2174/**
2175 * xmlXIncludeIncludeNode:
2176 * @ctxt: an XInclude context
2177 * @nr: the node number
2178 *
2179 * Inplement the infoset replacement for the given node
2180 *
Daniel Veillardcbaf3992001-12-31 16:16:02 +00002181 * Returns 0 if substitution succeeded, -1 if some processing failed
Owen Taylor3473f882001-02-23 17:55:21 +00002182 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +00002183static int
Owen Taylor3473f882001-02-23 17:55:21 +00002184xmlXIncludeIncludeNode(xmlXIncludeCtxtPtr ctxt, int nr) {
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002185 xmlNodePtr cur, end, list, tmp;
Owen Taylor3473f882001-02-23 17:55:21 +00002186
2187 if (ctxt == NULL)
2188 return(-1);
2189 if ((nr < 0) || (nr >= ctxt->incNr))
2190 return(-1);
Daniel Veillardbbc72c32002-09-05 10:52:10 +00002191 cur = ctxt->incTab[nr]->ref;
Daniel Veillard3e62adb2012-08-09 14:24:02 +08002192 if ((cur == NULL) || (cur->type == XML_NAMESPACE_DECL))
Owen Taylor3473f882001-02-23 17:55:21 +00002193 return(-1);
2194
2195 /*
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002196 * If we stored an XPointer a late computation may be needed
2197 */
2198 if ((ctxt->incTab[nr]->inc == NULL) &&
2199 (ctxt->incTab[nr]->xptr != NULL)) {
2200 ctxt->incTab[nr]->inc =
2201 xmlXIncludeCopyXPointer(ctxt, ctxt->doc, ctxt->doc,
2202 ctxt->incTab[nr]->xptr);
2203 xmlXPathFreeObject(ctxt->incTab[nr]->xptr);
2204 ctxt->incTab[nr]->xptr = NULL;
2205 }
2206 list = ctxt->incTab[nr]->inc;
2207 ctxt->incTab[nr]->inc = NULL;
2208
2209 /*
2210 * Check against the risk of generating a multi-rooted document
2211 */
2212 if ((cur->parent != NULL) &&
2213 (cur->parent->type != XML_ELEMENT_NODE)) {
2214 int nb_elem = 0;
2215
2216 tmp = list;
2217 while (tmp != NULL) {
2218 if (tmp->type == XML_ELEMENT_NODE)
2219 nb_elem++;
2220 tmp = tmp->next;
2221 }
2222 if (nb_elem > 1) {
Daniel Veillardf8e3db02012-09-11 13:26:36 +08002223 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
Daniel Veillardcd6ff282003-10-08 22:38:13 +00002224 XML_XINCLUDE_MULTIPLE_ROOT,
2225 "XInclude error: would result in multiple root nodes\n",
2226 NULL);
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002227 return(-1);
2228 }
2229 }
2230
Daniel Veillardc14c3892004-08-16 12:34:50 +00002231 if (ctxt->parseFlags & XML_PARSE_NOXINCNODE) {
2232 /*
2233 * Add the list of nodes
2234 */
2235 while (list != NULL) {
2236 end = list;
2237 list = list->next;
Owen Taylor3473f882001-02-23 17:55:21 +00002238
Daniel Veillardc14c3892004-08-16 12:34:50 +00002239 xmlAddPrevSibling(cur, end);
2240 }
2241 xmlUnlinkNode(cur);
2242 xmlFreeNode(cur);
2243 } else {
2244 /*
2245 * Change the current node as an XInclude start one, and add an
2246 * XInclude end one
2247 */
2248 cur->type = XML_XINCLUDE_START;
Daniel Veillard03a53c32004-10-26 16:06:51 +00002249 end = xmlNewDocNode(cur->doc, cur->ns, cur->name, NULL);
Daniel Veillardc14c3892004-08-16 12:34:50 +00002250 if (end == NULL) {
2251 xmlXIncludeErr(ctxt, ctxt->incTab[nr]->ref,
2252 XML_XINCLUDE_BUILD_FAILED,
2253 "failed to build node\n", NULL);
2254 return(-1);
2255 }
2256 end->type = XML_XINCLUDE_END;
2257 xmlAddNextSibling(cur, end);
Owen Taylor3473f882001-02-23 17:55:21 +00002258
Daniel Veillardc14c3892004-08-16 12:34:50 +00002259 /*
2260 * Add the list of nodes
2261 */
2262 while (list != NULL) {
2263 cur = list;
2264 list = list->next;
2265
2266 xmlAddPrevSibling(end, cur);
2267 }
Owen Taylor3473f882001-02-23 17:55:21 +00002268 }
Daniel Veillardc5f05ad2002-02-10 11:57:22 +00002269
Daniel Veillardf8e3db02012-09-11 13:26:36 +08002270
Owen Taylor3473f882001-02-23 17:55:21 +00002271 return(0);
2272}
2273
2274/**
2275 * xmlXIncludeTestNode:
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002276 * @ctxt: the XInclude processing context
Owen Taylor3473f882001-02-23 17:55:21 +00002277 * @node: an XInclude node
2278 *
2279 * test if the node is an XInclude node
2280 *
2281 * Returns 1 true, 0 otherwise
2282 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +00002283static int
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002284xmlXIncludeTestNode(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node) {
Owen Taylor3473f882001-02-23 17:55:21 +00002285 if (node == NULL)
2286 return(0);
Daniel Veillardffe4f5e2003-07-06 17:35:43 +00002287 if (node->type != XML_ELEMENT_NODE)
2288 return(0);
Owen Taylor3473f882001-02-23 17:55:21 +00002289 if (node->ns == NULL)
2290 return(0);
Daniel Veillardb5fa0202003-12-08 17:41:29 +00002291 if ((xmlStrEqual(node->ns->href, XINCLUDE_NS)) ||
2292 (xmlStrEqual(node->ns->href, XINCLUDE_OLD_NS))) {
2293 if (xmlStrEqual(node->ns->href, XINCLUDE_OLD_NS)) {
2294 if (ctxt->legacy == 0) {
Daniel Veillard5bb9ccd2004-02-09 12:39:02 +00002295#if 0 /* wait for the XML Core Working Group to get something stable ! */
Daniel Veillardb5fa0202003-12-08 17:41:29 +00002296 xmlXIncludeWarn(ctxt, node, XML_XINCLUDE_DEPRECATED_NS,
2297 "Deprecated XInclude namespace found, use %s",
2298 XINCLUDE_NS);
Daniel Veillard5bb9ccd2004-02-09 12:39:02 +00002299#endif
Daniel Veillarde74d2e12003-12-09 11:35:37 +00002300 ctxt->legacy = 1;
Daniel Veillardb5fa0202003-12-08 17:41:29 +00002301 }
2302 }
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002303 if (xmlStrEqual(node->name, XINCLUDE_NODE)) {
2304 xmlNodePtr child = node->children;
2305 int nb_fallback = 0;
2306
2307 while (child != NULL) {
2308 if ((child->type == XML_ELEMENT_NODE) &&
2309 (child->ns != NULL) &&
Daniel Veillardb5fa0202003-12-08 17:41:29 +00002310 ((xmlStrEqual(child->ns->href, XINCLUDE_NS)) ||
2311 (xmlStrEqual(child->ns->href, XINCLUDE_OLD_NS)))) {
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002312 if (xmlStrEqual(child->name, XINCLUDE_NODE)) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +00002313 xmlXIncludeErr(ctxt, node,
2314 XML_XINCLUDE_INCLUDE_IN_INCLUDE,
2315 "%s has an 'include' child\n",
2316 XINCLUDE_NODE);
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002317 return(0);
2318 }
2319 if (xmlStrEqual(child->name, XINCLUDE_FALLBACK)) {
2320 nb_fallback++;
2321 }
2322 }
2323 child = child->next;
2324 }
2325 if (nb_fallback > 1) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +00002326 xmlXIncludeErr(ctxt, node, XML_XINCLUDE_FALLBACKS_IN_INCLUDE,
2327 "%s has multiple fallback children\n",
2328 XINCLUDE_NODE);
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002329 return(0);
2330 }
2331 return(1);
2332 }
2333 if (xmlStrEqual(node->name, XINCLUDE_FALLBACK)) {
2334 if ((node->parent == NULL) ||
2335 (node->parent->type != XML_ELEMENT_NODE) ||
2336 (node->parent->ns == NULL) ||
Daniel Veillardb5fa0202003-12-08 17:41:29 +00002337 ((!xmlStrEqual(node->parent->ns->href, XINCLUDE_NS)) &&
2338 (!xmlStrEqual(node->parent->ns->href, XINCLUDE_OLD_NS))) ||
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002339 (!xmlStrEqual(node->parent->name, XINCLUDE_NODE))) {
Daniel Veillardcd6ff282003-10-08 22:38:13 +00002340 xmlXIncludeErr(ctxt, node,
2341 XML_XINCLUDE_FALLBACK_NOT_IN_INCLUDE,
2342 "%s is not the child of an 'include'\n",
2343 XINCLUDE_FALLBACK);
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002344 }
2345 }
2346 }
Owen Taylor3473f882001-02-23 17:55:21 +00002347 return(0);
2348}
2349
2350/**
Daniel Veillardd16df9f2001-05-23 13:44:21 +00002351 * xmlXIncludeDoProcess:
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002352 * @ctxt: the XInclude processing context
Owen Taylor3473f882001-02-23 17:55:21 +00002353 * @doc: an XML document
Daniel Veillard8edf1c52003-07-22 20:52:14 +00002354 * @tree: the top of the tree to process
Owen Taylor3473f882001-02-23 17:55:21 +00002355 *
2356 * Implement the XInclude substitution on the XML document @doc
2357 *
Daniel Veillardcbaf3992001-12-31 16:16:02 +00002358 * Returns 0 if no substitution were done, -1 if some processing failed
Owen Taylor3473f882001-02-23 17:55:21 +00002359 * or the number of substitutions done.
2360 */
Daniel Veillardd16df9f2001-05-23 13:44:21 +00002361static int
Daniel Veillard8edf1c52003-07-22 20:52:14 +00002362xmlXIncludeDoProcess(xmlXIncludeCtxtPtr ctxt, xmlDocPtr doc, xmlNodePtr tree) {
Owen Taylor3473f882001-02-23 17:55:21 +00002363 xmlNodePtr cur;
2364 int ret = 0;
Daniel Veillarde0fd93f2005-08-10 13:39:10 +00002365 int i, start;
Owen Taylor3473f882001-02-23 17:55:21 +00002366
Daniel Veillard3e62adb2012-08-09 14:24:02 +08002367 if ((doc == NULL) || (tree == NULL) || (tree->type == XML_NAMESPACE_DECL))
Owen Taylor3473f882001-02-23 17:55:21 +00002368 return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00002369 if (ctxt == NULL)
2370 return(-1);
2371
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002372 if (doc->URL != NULL) {
2373 ret = xmlXIncludeURLPush(ctxt, doc->URL);
2374 if (ret < 0)
2375 return(-1);
2376 }
Daniel Veillard11ce4002006-03-10 00:36:23 +00002377 start = ctxt->incNr;
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002378
Owen Taylor3473f882001-02-23 17:55:21 +00002379 /*
2380 * First phase: lookup the elements in the document
2381 */
Daniel Veillard8edf1c52003-07-22 20:52:14 +00002382 cur = tree;
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002383 if (xmlXIncludeTestNode(ctxt, cur) == 1)
Owen Taylor3473f882001-02-23 17:55:21 +00002384 xmlXIncludePreProcessNode(ctxt, cur);
William M. Brack7b0e2762004-05-12 09:33:23 +00002385 while ((cur != NULL) && (cur != tree->parent)) {
Owen Taylor3473f882001-02-23 17:55:21 +00002386 /* TODO: need to work on entities -> stack */
2387 if ((cur->children != NULL) &&
Daniel Veillardffe4f5e2003-07-06 17:35:43 +00002388 (cur->children->type != XML_ENTITY_DECL) &&
2389 (cur->children->type != XML_XINCLUDE_START) &&
2390 (cur->children->type != XML_XINCLUDE_END)) {
Owen Taylor3473f882001-02-23 17:55:21 +00002391 cur = cur->children;
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002392 if (xmlXIncludeTestNode(ctxt, cur))
Owen Taylor3473f882001-02-23 17:55:21 +00002393 xmlXIncludePreProcessNode(ctxt, cur);
2394 } else if (cur->next != NULL) {
2395 cur = cur->next;
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002396 if (xmlXIncludeTestNode(ctxt, cur))
Owen Taylor3473f882001-02-23 17:55:21 +00002397 xmlXIncludePreProcessNode(ctxt, cur);
2398 } else {
William M. Brack5d8d10b2004-04-16 08:11:26 +00002399 if (cur == tree)
2400 break;
Owen Taylor3473f882001-02-23 17:55:21 +00002401 do {
2402 cur = cur->parent;
William M. Brack7b0e2762004-05-12 09:33:23 +00002403 if ((cur == NULL) || (cur == tree->parent))
2404 break; /* do */
Owen Taylor3473f882001-02-23 17:55:21 +00002405 if (cur->next != NULL) {
2406 cur = cur->next;
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002407 if (xmlXIncludeTestNode(ctxt, cur))
Owen Taylor3473f882001-02-23 17:55:21 +00002408 xmlXIncludePreProcessNode(ctxt, cur);
2409 break; /* do */
2410 }
2411 } while (cur != NULL);
2412 }
2413 }
2414
2415 /*
2416 * Second Phase : collect the infosets fragments
2417 */
Daniel Veillarde0fd93f2005-08-10 13:39:10 +00002418 for (i = start;i < ctxt->incNr; i++) {
Owen Taylor3473f882001-02-23 17:55:21 +00002419 xmlXIncludeLoadNode(ctxt, i);
Daniel Veillard97fd5672003-02-07 13:01:54 +00002420 ret++;
Owen Taylor3473f882001-02-23 17:55:21 +00002421 }
2422
2423 /*
2424 * Third phase: extend the original document infoset.
William M. Brack6b1a28d2004-02-06 11:24:44 +00002425 *
2426 * Originally we bypassed the inclusion if there were any errors
2427 * encountered on any of the XIncludes. A bug was raised (bug
2428 * 132588) requesting that we output the XIncludes without error,
2429 * so the check for inc!=NULL || xptr!=NULL was put in. This may
2430 * give some other problems in the future, but for now it seems to
2431 * work ok.
2432 *
Owen Taylor3473f882001-02-23 17:55:21 +00002433 */
William M. Brack6b1a28d2004-02-06 11:24:44 +00002434 for (i = ctxt->incBase;i < ctxt->incNr; i++) {
William M. Brack95af5942004-02-08 04:12:49 +00002435 if ((ctxt->incTab[i]->inc != NULL) ||
2436 (ctxt->incTab[i]->xptr != NULL) ||
2437 (ctxt->incTab[i]->emptyFb != 0)) /* (empty fallback) */
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002438 xmlXIncludeIncludeNode(ctxt, i);
Owen Taylor3473f882001-02-23 17:55:21 +00002439 }
2440
Daniel Veillardf4b4f982003-02-13 11:02:08 +00002441 if (doc->URL != NULL)
2442 xmlXIncludeURLPop(ctxt);
Daniel Veillardd16df9f2001-05-23 13:44:21 +00002443 return(ret);
2444}
2445
2446/**
Daniel Veillarde74d2e12003-12-09 11:35:37 +00002447 * xmlXIncludeSetFlags:
2448 * @ctxt: an XInclude processing context
2449 * @flags: a set of xmlParserOption used for parsing XML includes
2450 *
2451 * Set the flags used for further processing of XML resources.
2452 *
2453 * Returns 0 in case of success and -1 in case of error.
2454 */
2455int
2456xmlXIncludeSetFlags(xmlXIncludeCtxtPtr ctxt, int flags) {
2457 if (ctxt == NULL)
2458 return(-1);
2459 ctxt->parseFlags = flags;
2460 return(0);
2461}
Stefan Behnelb9590e92009-08-24 19:45:54 +02002462
2463/**
2464 * xmlXIncludeProcessTreeFlagsData:
2465 * @tree: an XML node
2466 * @flags: a set of xmlParserOption used for parsing XML includes
2467 * @data: application data that will be passed to the parser context
2468 * in the _private field of the parser context(s)
2469 *
2470 * Implement the XInclude substitution on the XML node @tree
2471 *
2472 * Returns 0 if no substitution were done, -1 if some processing failed
2473 * or the number of substitutions done.
2474 */
2475
2476int
2477xmlXIncludeProcessTreeFlagsData(xmlNodePtr tree, int flags, void *data) {
2478 xmlXIncludeCtxtPtr ctxt;
2479 int ret = 0;
2480
Daniel Veillard3e62adb2012-08-09 14:24:02 +08002481 if ((tree == NULL) || (tree->type == XML_NAMESPACE_DECL) ||
2482 (tree->doc == NULL))
Stefan Behnelb9590e92009-08-24 19:45:54 +02002483 return(-1);
2484
2485 ctxt = xmlXIncludeNewContext(tree->doc);
2486 if (ctxt == NULL)
2487 return(-1);
2488 ctxt->_private = data;
2489 ctxt->base = xmlStrdup((xmlChar *)tree->doc->URL);
2490 xmlXIncludeSetFlags(ctxt, flags);
2491 ret = xmlXIncludeDoProcess(ctxt, tree->doc, tree);
2492 if ((ret >= 0) && (ctxt->nbErrors > 0))
2493 ret = -1;
2494
2495 xmlXIncludeFreeContext(ctxt);
2496 return(ret);
2497}
2498
Daniel Veillarde74d2e12003-12-09 11:35:37 +00002499/**
Daniel Veillard681e9042006-09-29 09:16:00 +00002500 * xmlXIncludeProcessFlagsData:
Daniel Veillardd16df9f2001-05-23 13:44:21 +00002501 * @doc: an XML document
Daniel Veillarde74d2e12003-12-09 11:35:37 +00002502 * @flags: a set of xmlParserOption used for parsing XML includes
Daniel Veillard681e9042006-09-29 09:16:00 +00002503 * @data: application data that will be passed to the parser context
2504 * in the _private field of the parser context(s)
Daniel Veillardd16df9f2001-05-23 13:44:21 +00002505 *
2506 * Implement the XInclude substitution on the XML document @doc
2507 *
Daniel Veillardcbaf3992001-12-31 16:16:02 +00002508 * Returns 0 if no substitution were done, -1 if some processing failed
Daniel Veillardd16df9f2001-05-23 13:44:21 +00002509 * or the number of substitutions done.
2510 */
2511int
Daniel Veillard681e9042006-09-29 09:16:00 +00002512xmlXIncludeProcessFlagsData(xmlDocPtr doc, int flags, void *data) {
Daniel Veillard8edf1c52003-07-22 20:52:14 +00002513 xmlNodePtr tree;
Daniel Veillardd16df9f2001-05-23 13:44:21 +00002514
2515 if (doc == NULL)
2516 return(-1);
Daniel Veillard8edf1c52003-07-22 20:52:14 +00002517 tree = xmlDocGetRootElement(doc);
2518 if (tree == NULL)
2519 return(-1);
Stefan Behnelb9590e92009-08-24 19:45:54 +02002520 return(xmlXIncludeProcessTreeFlagsData(tree, flags, data));
Daniel Veillard8edf1c52003-07-22 20:52:14 +00002521}
2522
2523/**
Daniel Veillard681e9042006-09-29 09:16:00 +00002524 * xmlXIncludeProcessFlags:
2525 * @doc: an XML document
2526 * @flags: a set of xmlParserOption used for parsing XML includes
2527 *
2528 * Implement the XInclude substitution on the XML document @doc
2529 *
2530 * Returns 0 if no substitution were done, -1 if some processing failed
2531 * or the number of substitutions done.
2532 */
2533int
2534xmlXIncludeProcessFlags(xmlDocPtr doc, int flags) {
2535 return xmlXIncludeProcessFlagsData(doc, flags, NULL);
2536}
2537
2538/**
Daniel Veillarde74d2e12003-12-09 11:35:37 +00002539 * xmlXIncludeProcess:
2540 * @doc: an XML document
2541 *
2542 * Implement the XInclude substitution on the XML document @doc
2543 *
2544 * Returns 0 if no substitution were done, -1 if some processing failed
2545 * or the number of substitutions done.
2546 */
2547int
2548xmlXIncludeProcess(xmlDocPtr doc) {
2549 return(xmlXIncludeProcessFlags(doc, 0));
2550}
2551
2552/**
2553 * xmlXIncludeProcessTreeFlags:
2554 * @tree: a node in an XML document
2555 * @flags: a set of xmlParserOption used for parsing XML includes
2556 *
2557 * Implement the XInclude substitution for the given subtree
2558 *
2559 * Returns 0 if no substitution were done, -1 if some processing failed
2560 * or the number of substitutions done.
2561 */
2562int
2563xmlXIncludeProcessTreeFlags(xmlNodePtr tree, int flags) {
2564 xmlXIncludeCtxtPtr ctxt;
2565 int ret = 0;
2566
Daniel Veillard3e62adb2012-08-09 14:24:02 +08002567 if ((tree == NULL) || (tree->type == XML_NAMESPACE_DECL) ||
2568 (tree->doc == NULL))
Daniel Veillarde74d2e12003-12-09 11:35:37 +00002569 return(-1);
2570 ctxt = xmlXIncludeNewContext(tree->doc);
2571 if (ctxt == NULL)
2572 return(-1);
William M. Brackf7789b12004-06-07 08:57:27 +00002573 ctxt->base = xmlNodeGetBase(tree->doc, tree);
Daniel Veillarde74d2e12003-12-09 11:35:37 +00002574 xmlXIncludeSetFlags(ctxt, flags);
2575 ret = xmlXIncludeDoProcess(ctxt, tree->doc, tree);
2576 if ((ret >= 0) && (ctxt->nbErrors > 0))
2577 ret = -1;
2578
2579 xmlXIncludeFreeContext(ctxt);
2580 return(ret);
2581}
2582
2583/**
Daniel Veillard8edf1c52003-07-22 20:52:14 +00002584 * xmlXIncludeProcessTree:
2585 * @tree: a node in an XML document
2586 *
2587 * Implement the XInclude substitution for the given subtree
2588 *
2589 * Returns 0 if no substitution were done, -1 if some processing failed
2590 * or the number of substitutions done.
2591 */
2592int
2593xmlXIncludeProcessTree(xmlNodePtr tree) {
Daniel Veillarde74d2e12003-12-09 11:35:37 +00002594 return(xmlXIncludeProcessTreeFlags(tree, 0));
Owen Taylor3473f882001-02-23 17:55:21 +00002595}
2596
Daniel Veillard7899c5c2003-11-03 12:31:38 +00002597/**
2598 * xmlXIncludeProcessNode:
2599 * @ctxt: an existing XInclude context
2600 * @node: a node in an XML document
2601 *
2602 * Implement the XInclude substitution for the given subtree reusing
2603 * the informations and data coming from the given context.
2604 *
2605 * Returns 0 if no substitution were done, -1 if some processing failed
2606 * or the number of substitutions done.
2607 */
2608int
2609xmlXIncludeProcessNode(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node) {
2610 int ret = 0;
2611
Daniel Veillard3e62adb2012-08-09 14:24:02 +08002612 if ((node == NULL) || (node->type == XML_NAMESPACE_DECL) ||
2613 (node->doc == NULL) || (ctxt == NULL))
Daniel Veillard7899c5c2003-11-03 12:31:38 +00002614 return(-1);
2615 ret = xmlXIncludeDoProcess(ctxt, node->doc, node);
2616 if ((ret >= 0) && (ctxt->nbErrors > 0))
2617 ret = -1;
2618 return(ret);
2619}
2620
Owen Taylor3473f882001-02-23 17:55:21 +00002621#else /* !LIBXML_XINCLUDE_ENABLED */
2622#endif
Daniel Veillard5d4644e2005-04-01 13:11:58 +00002623#define bottom_xinclude
2624#include "elfgcchack.h"