2 * xinclude.c : Code to implement XInclude processing
4 * World Wide Web Consortium W3C Last Call Working Draft 10 November 2003
5 * http://www.w3.org/TR/2003/WD-xinclude-20031110
7 * See Copyright for the status of this software.
16 #include <libxml/xmlmemory.h>
17 #include <libxml/tree.h>
18 #include <libxml/parser.h>
19 #include <libxml/uri.h>
20 #include <libxml/xpath.h>
21 #include <libxml/xpointer.h>
22 #include <libxml/parserInternals.h>
23 #include <libxml/xmlerror.h>
24 #include <libxml/encoding.h>
25 #include <libxml/globals.h>
27 #ifdef LIBXML_XINCLUDE_ENABLED
28 #include <libxml/xinclude.h>
32 #define XINCLUDE_MAX_DEPTH 40
34 /* #define DEBUG_XINCLUDE */
36 #ifdef LIBXML_DEBUG_ENABLED
37 #include <libxml/debugXML.h>
41 /************************************************************************
43 * XInclude context handling *
45 ************************************************************************/
50 typedef xmlChar
*xmlURL
;
52 typedef struct _xmlXIncludeRef xmlXIncludeRef
;
53 typedef xmlXIncludeRef
*xmlXIncludeRefPtr
;
54 struct _xmlXIncludeRef
{
55 xmlChar
*URI
; /* the fully resolved resource URL */
56 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 */
62 int fallback
; /* fallback was loaded */
63 int emptyFb
; /* flag to show fallback empty */
66 struct _xmlXIncludeCtxt
{
67 xmlDocPtr doc
; /* the source document */
68 int incBase
; /* the first include for this document */
69 int incNr
; /* number of includes */
70 int incMax
; /* size of includes tab */
71 xmlXIncludeRefPtr
*incTab
; /* array of included references */
73 int txtNr
; /* number of unparsed documents */
74 int txtMax
; /* size of unparsed documents tab */
75 xmlChar
* *txtTab
; /* array of unparsed text strings */
76 xmlURL
*txturlTab
; /* array of unparsed text URLs */
78 xmlChar
* url
; /* the current URL processed */
79 int urlNr
; /* number of URLs stacked */
80 int urlMax
; /* size of URL stack */
81 xmlChar
* *urlTab
; /* URL stack */
83 int nbErrors
; /* the number of errors detected */
84 int legacy
; /* using XINCLUDE_OLD_NS */
85 int parseFlags
; /* the flags used for parsing XML documents */
86 xmlChar
* base
; /* the current xml:base */
88 void *_private
; /* application data */
90 unsigned long incTotal
; /* total number of processed inclusions */
94 xmlXIncludeDoProcess(xmlXIncludeCtxtPtr ctxt
, xmlDocPtr doc
, xmlNodePtr tree
,
98 /************************************************************************
100 * XInclude error handler *
102 ************************************************************************/
105 * xmlXIncludeErrMemory:
106 * @extra: extra information
108 * Handle an out of memory condition
111 xmlXIncludeErrMemory(xmlXIncludeCtxtPtr ctxt
, xmlNodePtr node
,
116 __xmlRaiseError(NULL
, NULL
, NULL
, ctxt
, node
, XML_FROM_XINCLUDE
,
117 XML_ERR_NO_MEMORY
, XML_ERR_ERROR
, NULL
, 0,
118 extra
, NULL
, NULL
, 0, 0,
119 "Memory allocation failed : %s\n", extra
);
124 * @ctxt: the XInclude context
125 * @node: the context node
126 * @msg: the error message
127 * @extra: extra information
129 * Handle an XInclude error
131 static void LIBXML_ATTR_FORMAT(4,0)
132 xmlXIncludeErr(xmlXIncludeCtxtPtr ctxt
, xmlNodePtr node
, int error
,
133 const char *msg
, const xmlChar
*extra
)
137 __xmlRaiseError(NULL
, NULL
, NULL
, ctxt
, node
, XML_FROM_XINCLUDE
,
138 error
, XML_ERR_ERROR
, NULL
, 0,
139 (const char *) extra
, NULL
, NULL
, 0, 0,
140 msg
, (const char *) extra
);
146 * @ctxt: the XInclude context
147 * @node: the context node
148 * @msg: the error message
149 * @extra: extra information
151 * Emit an XInclude warning.
153 static void LIBXML_ATTR_FORMAT(4,0)
154 xmlXIncludeWarn(xmlXIncludeCtxtPtr ctxt
, xmlNodePtr node
, int error
,
155 const char *msg
, const xmlChar
*extra
)
157 __xmlRaiseError(NULL
, NULL
, NULL
, ctxt
, node
, XML_FROM_XINCLUDE
,
158 error
, XML_ERR_WARNING
, NULL
, 0,
159 (const char *) extra
, NULL
, NULL
, 0, 0,
160 msg
, (const char *) extra
);
165 * xmlXIncludeGetProp:
166 * @ctxt: the XInclude context
168 * @name: the attribute name
170 * Get an XInclude attribute
172 * Returns the value (to be freed) or NULL if not found
175 xmlXIncludeGetProp(xmlXIncludeCtxtPtr ctxt
, xmlNodePtr cur
,
176 const xmlChar
*name
) {
179 ret
= xmlGetNsProp(cur
, XINCLUDE_NS
, name
);
182 if (ctxt
->legacy
!= 0) {
183 ret
= xmlGetNsProp(cur
, XINCLUDE_OLD_NS
, name
);
187 ret
= xmlGetProp(cur
, name
);
191 * xmlXIncludeFreeRef:
192 * @ref: the XInclude reference
194 * Free an XInclude reference
197 xmlXIncludeFreeRef(xmlXIncludeRefPtr ref
) {
200 #ifdef DEBUG_XINCLUDE
201 xmlGenericError(xmlGenericErrorContext
, "Freeing ref\n");
203 if (ref
->doc
!= NULL
) {
204 #ifdef DEBUG_XINCLUDE
205 xmlGenericError(xmlGenericErrorContext
, "Freeing doc %s\n", ref
->URI
);
207 xmlFreeDoc(ref
->doc
);
209 if (ref
->URI
!= NULL
)
211 if (ref
->fragment
!= NULL
)
212 xmlFree(ref
->fragment
);
218 * @ctxt: the XInclude context
219 * @URI: the resource URI
221 * Creates a new reference within an XInclude context
223 * Returns the new set
225 static xmlXIncludeRefPtr
226 xmlXIncludeNewRef(xmlXIncludeCtxtPtr ctxt
, const xmlChar
*URI
,
228 xmlXIncludeRefPtr ret
;
230 #ifdef DEBUG_XINCLUDE
231 xmlGenericError(xmlGenericErrorContext
, "New ref %s\n", URI
);
233 ret
= (xmlXIncludeRefPtr
) xmlMalloc(sizeof(xmlXIncludeRef
));
235 xmlXIncludeErrMemory(ctxt
, ref
, "growing XInclude context");
238 memset(ret
, 0, sizeof(xmlXIncludeRef
));
242 ret
->URI
= xmlStrdup(URI
);
243 ret
->fragment
= NULL
;
249 if (ctxt
->incMax
== 0) {
251 ctxt
->incTab
= (xmlXIncludeRefPtr
*) xmlMalloc(ctxt
->incMax
*
252 sizeof(ctxt
->incTab
[0]));
253 if (ctxt
->incTab
== NULL
) {
254 xmlXIncludeErrMemory(ctxt
, ref
, "growing XInclude context");
255 xmlXIncludeFreeRef(ret
);
259 if (ctxt
->incNr
>= ctxt
->incMax
) {
261 ctxt
->incTab
= (xmlXIncludeRefPtr
*) xmlRealloc(ctxt
->incTab
,
262 ctxt
->incMax
* sizeof(ctxt
->incTab
[0]));
263 if (ctxt
->incTab
== NULL
) {
264 xmlXIncludeErrMemory(ctxt
, ref
, "growing XInclude context");
265 xmlXIncludeFreeRef(ret
);
269 ctxt
->incTab
[ctxt
->incNr
++] = ret
;
274 * xmlXIncludeNewContext:
275 * @doc: an XML Document
277 * Creates a new XInclude context
279 * Returns the new set
282 xmlXIncludeNewContext(xmlDocPtr doc
) {
283 xmlXIncludeCtxtPtr ret
;
285 #ifdef DEBUG_XINCLUDE
286 xmlGenericError(xmlGenericErrorContext
, "New context\n");
290 ret
= (xmlXIncludeCtxtPtr
) xmlMalloc(sizeof(xmlXIncludeCtxt
));
292 xmlXIncludeErrMemory(NULL
, (xmlNodePtr
) doc
,
293 "creating XInclude context");
296 memset(ret
, 0, sizeof(xmlXIncludeCtxt
));
307 * xmlXIncludeURLPush:
308 * @ctxt: the parser context
311 * Pushes a new url on top of the url stack
313 * Returns -1 in case of error, the index in the stack otherwise
316 xmlXIncludeURLPush(xmlXIncludeCtxtPtr ctxt
,
317 const xmlChar
*value
)
319 if (ctxt
->urlNr
> XINCLUDE_MAX_DEPTH
) {
320 xmlXIncludeErr(ctxt
, NULL
, XML_XINCLUDE_RECURSION
,
321 "detected a recursion in %s\n", value
);
324 if (ctxt
->urlTab
== NULL
) {
327 ctxt
->urlTab
= (xmlChar
* *) xmlMalloc(
328 ctxt
->urlMax
* sizeof(ctxt
->urlTab
[0]));
329 if (ctxt
->urlTab
== NULL
) {
330 xmlXIncludeErrMemory(ctxt
, NULL
, "adding URL");
334 if (ctxt
->urlNr
>= ctxt
->urlMax
) {
337 (xmlChar
* *) xmlRealloc(ctxt
->urlTab
,
339 sizeof(ctxt
->urlTab
[0]));
340 if (ctxt
->urlTab
== NULL
) {
341 xmlXIncludeErrMemory(ctxt
, NULL
, "adding URL");
345 ctxt
->url
= ctxt
->urlTab
[ctxt
->urlNr
] = xmlStrdup(value
);
346 return (ctxt
->urlNr
++);
351 * @ctxt: the parser context
353 * Pops the top URL from the URL stack
356 xmlXIncludeURLPop(xmlXIncludeCtxtPtr ctxt
)
360 if (ctxt
->urlNr
<= 0)
364 ctxt
->url
= ctxt
->urlTab
[ctxt
->urlNr
- 1];
367 ret
= ctxt
->urlTab
[ctxt
->urlNr
];
368 ctxt
->urlTab
[ctxt
->urlNr
] = NULL
;
374 * xmlXIncludeFreeContext:
375 * @ctxt: the XInclude context
377 * Free an XInclude context
380 xmlXIncludeFreeContext(xmlXIncludeCtxtPtr ctxt
) {
383 #ifdef DEBUG_XINCLUDE
384 xmlGenericError(xmlGenericErrorContext
, "Freeing context\n");
388 while (ctxt
->urlNr
> 0)
389 xmlXIncludeURLPop(ctxt
);
390 if (ctxt
->urlTab
!= NULL
)
391 xmlFree(ctxt
->urlTab
);
392 for (i
= 0;i
< ctxt
->incNr
;i
++) {
393 if (ctxt
->incTab
[i
] != NULL
)
394 xmlXIncludeFreeRef(ctxt
->incTab
[i
]);
396 if (ctxt
->incTab
!= NULL
)
397 xmlFree(ctxt
->incTab
);
398 if (ctxt
->txtTab
!= NULL
) {
399 for (i
= 0;i
< ctxt
->txtNr
;i
++) {
400 if (ctxt
->txtTab
[i
] != NULL
)
401 xmlFree(ctxt
->txtTab
[i
]);
403 xmlFree(ctxt
->txtTab
);
405 if (ctxt
->txturlTab
!= NULL
) {
406 for (i
= 0;i
< ctxt
->txtNr
;i
++) {
407 if (ctxt
->txturlTab
[i
] != NULL
)
408 xmlFree(ctxt
->txturlTab
[i
]);
410 xmlFree(ctxt
->txturlTab
);
412 if (ctxt
->base
!= NULL
) {
419 * xmlXIncludeParseFile:
420 * @ctxt: the XInclude context
421 * @URL: the URL or file path
423 * parse a document for XInclude
426 xmlXIncludeParseFile(xmlXIncludeCtxtPtr ctxt
, const char *URL
) {
428 xmlParserCtxtPtr pctxt
;
429 xmlParserInputPtr inputStream
;
433 pctxt
= xmlNewParserCtxt();
435 xmlXIncludeErrMemory(ctxt
, NULL
, "cannot allocate parser context");
440 * pass in the application data to the parser context.
442 pctxt
->_private
= ctxt
->_private
;
445 * try to ensure that new documents included are actually
446 * built with the same dictionary as the including document.
448 if ((ctxt
->doc
!= NULL
) && (ctxt
->doc
->dict
!= NULL
)) {
449 if (pctxt
->dict
!= NULL
)
450 xmlDictFree(pctxt
->dict
);
451 pctxt
->dict
= ctxt
->doc
->dict
;
452 xmlDictReference(pctxt
->dict
);
455 xmlCtxtUseOptions(pctxt
, ctxt
->parseFlags
| XML_PARSE_DTDLOAD
);
457 /* Don't read from stdin. */
458 if ((URL
!= NULL
) && (strcmp(URL
, "-") == 0))
461 inputStream
= xmlLoadExternalEntity(URL
, NULL
, pctxt
);
462 if (inputStream
== NULL
) {
463 xmlFreeParserCtxt(pctxt
);
467 inputPush(pctxt
, inputStream
);
469 if (pctxt
->directory
== NULL
)
470 pctxt
->directory
= xmlParserGetDirectory(URL
);
472 pctxt
->loadsubset
|= XML_DETECT_IDS
;
474 xmlParseDocument(pctxt
);
476 if (pctxt
->wellFormed
) {
481 if (pctxt
->myDoc
!= NULL
)
482 xmlFreeDoc(pctxt
->myDoc
);
485 xmlFreeParserCtxt(pctxt
);
491 * xmlXIncludeAddNode:
492 * @ctxt: the XInclude context
495 * Add a new node to process to an XInclude context
498 xmlXIncludeAddNode(xmlXIncludeCtxtPtr ctxt
, xmlNodePtr cur
) {
499 xmlXIncludeRefPtr ref
;
502 xmlChar
*fragment
= NULL
;
507 int xml
= 1, i
; /* default Issue 64 */
516 #ifdef DEBUG_XINCLUDE
517 xmlGenericError(xmlGenericErrorContext
, "Add node\n");
520 * read the attributes
522 href
= xmlXIncludeGetProp(ctxt
, cur
, XINCLUDE_HREF
);
524 href
= xmlStrdup(BAD_CAST
""); /* @@@@ href is now optional */
528 if ((href
[0] == '#') || (href
[0] == 0))
530 parse
= xmlXIncludeGetProp(ctxt
, cur
, XINCLUDE_PARSE
);
532 if (xmlStrEqual(parse
, XINCLUDE_PARSE_XML
))
534 else if (xmlStrEqual(parse
, XINCLUDE_PARSE_TEXT
))
537 xmlXIncludeErr(ctxt
, cur
, XML_XINCLUDE_PARSE_VALUE
,
538 "invalid value %s for 'parse'\n", parse
);
550 base
= xmlNodeGetBase(ctxt
->doc
, cur
);
552 URI
= xmlBuildURI(href
, ctxt
->doc
->URL
);
554 URI
= xmlBuildURI(href
, base
);
560 * Some escaping may be needed
562 escbase
= xmlURIEscape(base
);
563 eschref
= xmlURIEscape(href
);
564 URI
= xmlBuildURI(eschref
, escbase
);
577 xmlXIncludeErr(ctxt
, cur
, XML_XINCLUDE_HREF_URI
,
578 "failed build URL\n", NULL
);
581 fragment
= xmlXIncludeGetProp(ctxt
, cur
, XINCLUDE_PARSE_XPOINTER
);
584 * Check the URL and remove any fragment identifier
586 uri
= xmlParseURI((const char *)URI
);
588 xmlXIncludeErr(ctxt
, cur
, XML_XINCLUDE_HREF_URI
,
589 "invalid value URI %s\n", URI
);
590 if (fragment
!= NULL
)
596 if (uri
->fragment
!= NULL
) {
597 if (ctxt
->legacy
!= 0) {
598 if (fragment
== NULL
) {
599 fragment
= (xmlChar
*) uri
->fragment
;
601 xmlFree(uri
->fragment
);
604 xmlXIncludeErr(ctxt
, cur
, XML_XINCLUDE_FRAGMENT_ID
,
605 "Invalid fragment identifier in URI %s use the xpointer attribute\n",
607 if (fragment
!= NULL
)
613 uri
->fragment
= NULL
;
615 URL
= xmlSaveUri(uri
);
619 xmlXIncludeErr(ctxt
, cur
, XML_XINCLUDE_HREF_URI
,
620 "invalid value URI %s\n", URI
);
621 if (fragment
!= NULL
)
627 * If local and xml then we need a fragment
629 if ((local
== 1) && (xml
== 1) &&
630 ((fragment
== NULL
) || (fragment
[0] == 0))) {
631 xmlXIncludeErr(ctxt
, cur
, XML_XINCLUDE_RECURSION
,
632 "detected a local recursion with no xpointer in %s\n",
640 * Check the URL against the stack for recursions
642 if ((!local
) && (xml
== 1)) {
643 for (i
= 0;i
< ctxt
->urlNr
;i
++) {
644 if (xmlStrEqual(URL
, ctxt
->urlTab
[i
])) {
645 xmlXIncludeErr(ctxt
, cur
, XML_XINCLUDE_RECURSION
,
646 "detected a recursion in %s\n", URL
);
654 ref
= xmlXIncludeNewRef(ctxt
, URL
, cur
);
659 ref
->fragment
= fragment
;
667 * xmlXIncludeRecurseDoc:
668 * @ctxt: the XInclude context
669 * @doc: the new document
670 * @url: the associated URL
672 * The XInclude recursive nature is handled at this point.
675 xmlXIncludeRecurseDoc(xmlXIncludeCtxtPtr ctxt
, xmlDocPtr doc
,
676 const xmlURL url ATTRIBUTE_UNUSED
) {
677 xmlXIncludeCtxtPtr newctxt
;
681 * Avoid recursion in already substituted resources
682 for (i = 0;i < ctxt->urlNr;i++) {
683 if (xmlStrEqual(doc->URL, ctxt->urlTab[i]))
688 #ifdef DEBUG_XINCLUDE
689 xmlGenericError(xmlGenericErrorContext
, "Recursing in doc %s\n", doc
->URL
);
692 * Handle recursion here.
695 newctxt
= xmlXIncludeNewContext(doc
);
696 if (newctxt
!= NULL
) {
698 * Copy the private user data
700 newctxt
->_private
= ctxt
->_private
;
702 * Copy the existing document set
704 newctxt
->incMax
= ctxt
->incMax
;
705 newctxt
->incNr
= ctxt
->incNr
;
706 newctxt
->incTab
= (xmlXIncludeRefPtr
*) xmlMalloc(newctxt
->incMax
*
707 sizeof(newctxt
->incTab
[0]));
708 if (newctxt
->incTab
== NULL
) {
709 xmlXIncludeErrMemory(ctxt
, (xmlNodePtr
) doc
, "processing doc");
716 newctxt
->urlMax
= ctxt
->urlMax
;
717 newctxt
->urlNr
= ctxt
->urlNr
;
718 newctxt
->urlTab
= ctxt
->urlTab
;
721 * Inherit the existing base
723 newctxt
->base
= xmlStrdup(ctxt
->base
);
726 * Inherit the documents already in use by other includes
728 newctxt
->incBase
= ctxt
->incNr
;
729 for (i
= 0;i
< ctxt
->incNr
;i
++) {
730 newctxt
->incTab
[i
] = ctxt
->incTab
[i
];
731 newctxt
->incTab
[i
]->count
++; /* prevent the recursion from
735 * The new context should also inherit the Parse Flags
738 newctxt
->parseFlags
= ctxt
->parseFlags
;
739 newctxt
->incTotal
= ctxt
->incTotal
;
740 xmlXIncludeDoProcess(newctxt
, doc
, xmlDocGetRootElement(doc
), 0);
741 ctxt
->incTotal
= newctxt
->incTotal
;
742 for (i
= 0;i
< ctxt
->incNr
;i
++) {
743 newctxt
->incTab
[i
]->count
--;
744 newctxt
->incTab
[i
] = NULL
;
747 /* urlTab may have been reallocated */
748 ctxt
->urlTab
= newctxt
->urlTab
;
749 ctxt
->urlMax
= newctxt
->urlMax
;
753 newctxt
->urlTab
= NULL
;
755 xmlXIncludeFreeContext(newctxt
);
757 #ifdef DEBUG_XINCLUDE
758 xmlGenericError(xmlGenericErrorContext
, "Done recursing in doc %s\n", url
);
764 * @ctxt: the XInclude context
765 * @txt: the new text node
766 * @url: the associated URL
768 * Add a new text node to the list
771 xmlXIncludeAddTxt(xmlXIncludeCtxtPtr ctxt
, const xmlChar
*txt
,
773 #ifdef DEBUG_XINCLUDE
774 xmlGenericError(xmlGenericErrorContext
, "Adding text %s\n", url
);
776 if (ctxt
->txtMax
== 0) {
778 ctxt
->txtTab
= (xmlChar
**) xmlMalloc(ctxt
->txtMax
*
779 sizeof(ctxt
->txtTab
[0]));
780 if (ctxt
->txtTab
== NULL
) {
781 xmlXIncludeErrMemory(ctxt
, NULL
, "processing text");
784 ctxt
->txturlTab
= (xmlURL
*) xmlMalloc(ctxt
->txtMax
*
785 sizeof(ctxt
->txturlTab
[0]));
786 if (ctxt
->txturlTab
== NULL
) {
787 xmlXIncludeErrMemory(ctxt
, NULL
, "processing text");
791 if (ctxt
->txtNr
>= ctxt
->txtMax
) {
793 ctxt
->txtTab
= (xmlChar
**) xmlRealloc(ctxt
->txtTab
,
794 ctxt
->txtMax
* sizeof(ctxt
->txtTab
[0]));
795 if (ctxt
->txtTab
== NULL
) {
796 xmlXIncludeErrMemory(ctxt
, NULL
, "processing text");
799 ctxt
->txturlTab
= (xmlURL
*) xmlRealloc(ctxt
->txturlTab
,
800 ctxt
->txtMax
* sizeof(ctxt
->txturlTab
[0]));
801 if (ctxt
->txturlTab
== NULL
) {
802 xmlXIncludeErrMemory(ctxt
, NULL
, "processing text");
806 ctxt
->txtTab
[ctxt
->txtNr
] = xmlStrdup(txt
);
807 ctxt
->txturlTab
[ctxt
->txtNr
] = xmlStrdup(url
);
811 /************************************************************************
813 * Node copy with specific semantic *
815 ************************************************************************/
818 xmlXIncludeCopyNodeList(xmlXIncludeCtxtPtr ctxt
, xmlDocPtr target
,
819 xmlDocPtr source
, xmlNodePtr elem
);
822 * xmlXIncludeCopyNode:
823 * @ctxt: the XInclude context
824 * @target: the document target
825 * @source: the document source
828 * Make a copy of the node while preserving the XInclude semantic
829 * of the Infoset copy
832 xmlXIncludeCopyNode(xmlXIncludeCtxtPtr ctxt
, xmlDocPtr target
,
833 xmlDocPtr source
, xmlNodePtr elem
) {
834 xmlNodePtr result
= NULL
;
836 if ((ctxt
== NULL
) || (target
== NULL
) || (source
== NULL
) ||
839 if (elem
->type
== XML_DTD_NODE
)
841 if (elem
->type
== XML_DOCUMENT_NODE
)
842 result
= xmlXIncludeCopyNodeList(ctxt
, target
, source
, elem
->children
);
844 result
= xmlDocCopyNode(elem
, target
, 1);
849 * xmlXIncludeCopyNodeList:
850 * @ctxt: the XInclude context
851 * @target: the document target
852 * @source: the document source
853 * @elem: the element list
855 * Make a copy of the node list while preserving the XInclude semantic
856 * of the Infoset copy
859 xmlXIncludeCopyNodeList(xmlXIncludeCtxtPtr ctxt
, xmlDocPtr target
,
860 xmlDocPtr source
, xmlNodePtr elem
) {
861 xmlNodePtr cur
, res
, result
= NULL
, last
= NULL
;
863 if ((ctxt
== NULL
) || (target
== NULL
) || (source
== NULL
) ||
867 while (cur
!= NULL
) {
868 res
= xmlXIncludeCopyNode(ctxt
, target
, source
, cur
);
870 if (result
== NULL
) {
884 * xmlXIncludeGetNthChild:
886 * @no: the child number
888 * Returns the @n'th element child of @cur or NULL
891 xmlXIncludeGetNthChild(xmlNodePtr cur
, int no
) {
893 if ((cur
== NULL
) || (cur
->type
== XML_NAMESPACE_DECL
))
896 for (i
= 0;i
<= no
;cur
= cur
->next
) {
899 if ((cur
->type
== XML_ELEMENT_NODE
) ||
900 (cur
->type
== XML_DOCUMENT_NODE
) ||
901 (cur
->type
== XML_HTML_DOCUMENT_NODE
)) {
910 xmlNodePtr
xmlXPtrAdvanceNode(xmlNodePtr cur
, int *level
); /* in xpointer.c */
912 * xmlXIncludeCopyRange:
913 * @ctxt: the XInclude context
914 * @target: the document target
915 * @source: the document source
916 * @obj: the XPointer result from the evaluation.
918 * Build a node list tree copy of the XPointer result.
920 * Returns an xmlNodePtr list or NULL.
921 * The caller has to free the node tree.
924 xmlXIncludeCopyRange(xmlXIncludeCtxtPtr ctxt
, xmlDocPtr target
,
925 xmlDocPtr source
, xmlXPathObjectPtr range
) {
926 /* pointers to generated nodes */
927 xmlNodePtr list
= NULL
, last
= NULL
, listParent
= NULL
;
928 xmlNodePtr tmp
, tmp2
;
929 /* pointers to traversal nodes */
930 xmlNodePtr start
, cur
, end
;
932 int level
= 0, lastLevel
= 0, endLevel
= 0, endFlag
= 0;
934 if ((ctxt
== NULL
) || (target
== NULL
) || (source
== NULL
) ||
937 if (range
->type
!= XPATH_RANGE
)
939 start
= (xmlNodePtr
) range
->user
;
941 if ((start
== NULL
) || (start
->type
== XML_NAMESPACE_DECL
))
945 return(xmlDocCopyNode(start
, target
, 1));
946 if (end
->type
== XML_NAMESPACE_DECL
)
950 index1
= range
->index
;
951 index2
= range
->index2
;
953 * level is depth of the current node under consideration
954 * list is the pointer to the root of the output tree
955 * listParent is a pointer to the parent of output tree (within
956 the included file) in case we need to add another level
957 * last is a pointer to the last node added to the output tree
958 * lastLevel is the depth of last (relative to the root)
960 while (cur
!= NULL
) {
962 * Check if our output tree needs a parent
966 /* copy must include namespaces and properties */
967 tmp2
= xmlDocCopyNode(listParent
, target
, 2);
968 xmlAddChild(tmp2
, list
);
970 listParent
= listParent
->parent
;
977 * Check whether we need to change our insertion point
979 while (level
< lastLevel
) {
983 if (cur
== end
) { /* Are we at the end of the range? */
984 if (cur
->type
== XML_TEXT_NODE
) {
985 const xmlChar
*content
= cur
->content
;
988 if (content
== NULL
) {
989 tmp
= xmlNewTextLen(NULL
, 0);
992 if ((cur
== start
) && (index1
> 1)) {
993 content
+= (index1
- 1);
998 tmp
= xmlNewTextLen(content
, len
);
1000 /* single sub text node selection */
1003 /* prune and return full set */
1004 if (level
== lastLevel
)
1005 xmlAddNextSibling(last
, tmp
);
1007 xmlAddChild(last
, tmp
);
1009 } else { /* ending node not a text node */
1010 endLevel
= level
; /* remember the level of the end node */
1012 /* last node - need to take care of properties + namespaces */
1013 tmp
= xmlDocCopyNode(cur
, target
, 2);
1016 listParent
= cur
->parent
;
1018 if (level
== lastLevel
)
1019 xmlAddNextSibling(last
, tmp
);
1021 xmlAddChild(last
, tmp
);
1028 end
= xmlXIncludeGetNthChild(cur
, index2
- 1);
1031 if ((cur
== start
) && (index1
> 1)) {
1032 cur
= xmlXIncludeGetNthChild(cur
, index1
- 1);
1035 cur
= cur
->children
;
1037 level
++; /* increment level to show change */
1039 * Now gather the remaining nodes from cur to end
1041 continue; /* while */
1043 } else if (cur
== start
) { /* Not at the end, are we at start? */
1044 if ((cur
->type
== XML_TEXT_NODE
) ||
1045 (cur
->type
== XML_CDATA_SECTION_NODE
)) {
1046 const xmlChar
*content
= cur
->content
;
1048 if (content
== NULL
) {
1049 tmp
= xmlNewTextLen(NULL
, 0);
1052 content
+= (index1
- 1);
1055 tmp
= xmlNewText(content
);
1058 listParent
= cur
->parent
;
1059 } else { /* Not text node */
1061 * start of the range - need to take care of
1062 * properties and namespaces
1064 tmp
= xmlDocCopyNode(cur
, target
, 2);
1066 listParent
= cur
->parent
;
1067 if (index1
> 1) { /* Do we need to position? */
1068 cur
= xmlXIncludeGetNthChild(cur
, index1
- 1);
1069 level
= lastLevel
= 1;
1072 * Now gather the remaining nodes from cur to end
1074 continue; /* while */
1079 switch (cur
->type
) {
1081 case XML_ELEMENT_DECL
:
1082 case XML_ATTRIBUTE_DECL
:
1083 case XML_ENTITY_NODE
:
1084 /* Do not copy DTD information */
1086 case XML_ENTITY_DECL
:
1087 /* handle crossing entities -> stack needed */
1089 case XML_XINCLUDE_START
:
1090 case XML_XINCLUDE_END
:
1091 /* don't consider it part of the tree content */
1093 case XML_ATTRIBUTE_NODE
:
1094 /* Humm, should not happen ! */
1098 * Middle of the range - need to take care of
1099 * properties and namespaces
1101 tmp
= xmlDocCopyNode(cur
, target
, 2);
1105 if (level
== lastLevel
)
1106 xmlAddNextSibling(last
, tmp
);
1108 xmlAddChild(last
, tmp
);
1115 * Skip to next node in document order
1117 cur
= xmlXPtrAdvanceNode(cur
, &level
);
1118 if (endFlag
&& (level
>= endLevel
))
1125 * xmlXIncludeBuildNodeList:
1126 * @ctxt: the XInclude context
1127 * @target: the document target
1128 * @source: the document source
1129 * @obj: the XPointer result from the evaluation.
1131 * Build a node list tree copy of the XPointer result.
1132 * This will drop Attributes and Namespace declarations.
1134 * Returns an xmlNodePtr list or NULL.
1135 * the caller has to free the node tree.
1138 xmlXIncludeCopyXPointer(xmlXIncludeCtxtPtr ctxt
, xmlDocPtr target
,
1139 xmlDocPtr source
, xmlXPathObjectPtr obj
) {
1140 xmlNodePtr list
= NULL
, last
= NULL
;
1145 if ((ctxt
== NULL
) || (target
== NULL
) || (source
== NULL
) ||
1148 switch (obj
->type
) {
1149 case XPATH_NODESET
: {
1150 xmlNodeSetPtr set
= obj
->nodesetval
;
1153 for (i
= 0;i
< set
->nodeNr
;i
++) {
1154 if (set
->nodeTab
[i
] == NULL
)
1156 switch (set
->nodeTab
[i
]->type
) {
1158 case XML_CDATA_SECTION_NODE
:
1159 case XML_ELEMENT_NODE
:
1160 case XML_ENTITY_REF_NODE
:
1161 case XML_ENTITY_NODE
:
1163 case XML_COMMENT_NODE
:
1164 case XML_DOCUMENT_NODE
:
1165 case XML_HTML_DOCUMENT_NODE
:
1166 #ifdef LIBXML_DOCB_ENABLED
1167 case XML_DOCB_DOCUMENT_NODE
:
1169 case XML_XINCLUDE_END
:
1171 case XML_XINCLUDE_START
: {
1172 xmlNodePtr tmp
, cur
= set
->nodeTab
[i
];
1175 while (cur
!= NULL
) {
1178 case XML_CDATA_SECTION_NODE
:
1179 case XML_ELEMENT_NODE
:
1180 case XML_ENTITY_REF_NODE
:
1181 case XML_ENTITY_NODE
:
1183 case XML_COMMENT_NODE
:
1184 tmp
= xmlXIncludeCopyNode(ctxt
, target
,
1189 xmlAddNextSibling(last
, tmp
);
1201 case XML_ATTRIBUTE_NODE
:
1202 case XML_NAMESPACE_DECL
:
1203 case XML_DOCUMENT_TYPE_NODE
:
1204 case XML_DOCUMENT_FRAG_NODE
:
1205 case XML_NOTATION_NODE
:
1207 case XML_ELEMENT_DECL
:
1208 case XML_ATTRIBUTE_DECL
:
1209 case XML_ENTITY_DECL
:
1213 list
= last
= xmlXIncludeCopyNode(ctxt
, target
, source
,
1216 xmlAddNextSibling(last
,
1217 xmlXIncludeCopyNode(ctxt
, target
, source
,
1219 if (last
->next
!= NULL
)
1225 #ifdef LIBXML_XPTR_ENABLED
1226 case XPATH_LOCATIONSET
: {
1227 xmlLocationSetPtr set
= (xmlLocationSetPtr
) obj
->user
;
1230 for (i
= 0;i
< set
->locNr
;i
++) {
1232 list
= last
= xmlXIncludeCopyXPointer(ctxt
, target
, source
,
1235 xmlAddNextSibling(last
,
1236 xmlXIncludeCopyXPointer(ctxt
, target
, source
,
1239 while (last
->next
!= NULL
)
1246 return(xmlXIncludeCopyRange(ctxt
, target
, source
, obj
));
1249 /* points are ignored in XInclude */
1256 /************************************************************************
1258 * XInclude I/O handling *
1260 ************************************************************************/
1262 typedef struct _xmlXIncludeMergeData xmlXIncludeMergeData
;
1263 typedef xmlXIncludeMergeData
*xmlXIncludeMergeDataPtr
;
1264 struct _xmlXIncludeMergeData
{
1266 xmlXIncludeCtxtPtr ctxt
;
1270 * xmlXIncludeMergeOneEntity:
1272 * @doc: the including doc
1273 * @nr: the entity name
1275 * Implements the merge of one entity
1278 xmlXIncludeMergeEntity(void *payload
, void *vdata
,
1279 const xmlChar
*name ATTRIBUTE_UNUSED
) {
1280 xmlEntityPtr ent
= (xmlEntityPtr
) payload
;
1281 xmlXIncludeMergeDataPtr data
= (xmlXIncludeMergeDataPtr
) vdata
;
1282 xmlEntityPtr ret
, prev
;
1284 xmlXIncludeCtxtPtr ctxt
;
1286 if ((ent
== NULL
) || (data
== NULL
))
1290 if ((ctxt
== NULL
) || (doc
== NULL
))
1292 switch (ent
->etype
) {
1293 case XML_INTERNAL_PARAMETER_ENTITY
:
1294 case XML_EXTERNAL_PARAMETER_ENTITY
:
1295 case XML_INTERNAL_PREDEFINED_ENTITY
:
1297 case XML_INTERNAL_GENERAL_ENTITY
:
1298 case XML_EXTERNAL_GENERAL_PARSED_ENTITY
:
1299 case XML_EXTERNAL_GENERAL_UNPARSED_ENTITY
:
1302 ret
= xmlAddDocEntity(doc
, ent
->name
, ent
->etype
, ent
->ExternalID
,
1303 ent
->SystemID
, ent
->content
);
1305 if (ent
->URI
!= NULL
)
1306 ret
->URI
= xmlStrdup(ent
->URI
);
1308 prev
= xmlGetDocEntity(doc
, ent
->name
);
1310 if (ent
->etype
!= prev
->etype
)
1313 if ((ent
->SystemID
!= NULL
) && (prev
->SystemID
!= NULL
)) {
1314 if (!xmlStrEqual(ent
->SystemID
, prev
->SystemID
))
1316 } else if ((ent
->ExternalID
!= NULL
) &&
1317 (prev
->ExternalID
!= NULL
)) {
1318 if (!xmlStrEqual(ent
->ExternalID
, prev
->ExternalID
))
1320 } else if ((ent
->content
!= NULL
) && (prev
->content
!= NULL
)) {
1321 if (!xmlStrEqual(ent
->content
, prev
->content
))
1331 switch (ent
->etype
) {
1332 case XML_INTERNAL_PARAMETER_ENTITY
:
1333 case XML_EXTERNAL_PARAMETER_ENTITY
:
1334 case XML_INTERNAL_PREDEFINED_ENTITY
:
1335 case XML_INTERNAL_GENERAL_ENTITY
:
1336 case XML_EXTERNAL_GENERAL_PARSED_ENTITY
:
1338 case XML_EXTERNAL_GENERAL_UNPARSED_ENTITY
:
1341 xmlXIncludeErr(ctxt
, (xmlNodePtr
) ent
, XML_XINCLUDE_ENTITY_DEF_MISMATCH
,
1342 "mismatch in redefinition of entity %s\n",
1347 * xmlXIncludeMergeEntities:
1348 * @ctxt: an XInclude context
1349 * @doc: the including doc
1350 * @from: the included doc
1352 * Implements the entity merge
1354 * Returns 0 if merge succeeded, -1 if some processing failed
1357 xmlXIncludeMergeEntities(xmlXIncludeCtxtPtr ctxt
, xmlDocPtr doc
,
1360 xmlDtdPtr target
, source
;
1365 if ((from
== NULL
) || (from
->intSubset
== NULL
))
1368 target
= doc
->intSubset
;
1369 if (target
== NULL
) {
1370 cur
= xmlDocGetRootElement(doc
);
1373 target
= xmlCreateIntSubset(doc
, cur
->name
, NULL
, NULL
);
1378 source
= from
->intSubset
;
1379 if ((source
!= NULL
) && (source
->entities
!= NULL
)) {
1380 xmlXIncludeMergeData data
;
1385 xmlHashScan((xmlHashTablePtr
) source
->entities
,
1386 xmlXIncludeMergeEntity
, &data
);
1388 source
= from
->extSubset
;
1389 if ((source
!= NULL
) && (source
->entities
!= NULL
)) {
1390 xmlXIncludeMergeData data
;
1396 * don't duplicate existing stuff when external subsets are the same
1398 if ((!xmlStrEqual(target
->ExternalID
, source
->ExternalID
)) &&
1399 (!xmlStrEqual(target
->SystemID
, source
->SystemID
))) {
1400 xmlHashScan((xmlHashTablePtr
) source
->entities
,
1401 xmlXIncludeMergeEntity
, &data
);
1408 * xmlXIncludeLoadDoc:
1409 * @ctxt: the XInclude context
1410 * @url: the associated URL
1411 * @nr: the xinclude node number
1413 * Load the document, and store the result in the XInclude context
1415 * Returns 0 in case of success, -1 in case of failure
1418 xmlXIncludeLoadDoc(xmlXIncludeCtxtPtr ctxt
, const xmlChar
*url
, int nr
) {
1422 xmlChar
*fragment
= NULL
;
1424 #ifdef LIBXML_XPTR_ENABLED
1428 #ifdef DEBUG_XINCLUDE
1429 xmlGenericError(xmlGenericErrorContext
, "Loading doc %s:%d\n", url
, nr
);
1432 * Check the URL and remove any fragment identifier
1434 uri
= xmlParseURI((const char *)url
);
1436 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1437 XML_XINCLUDE_HREF_URI
,
1438 "invalid value URI %s\n", url
);
1441 if (uri
->fragment
!= NULL
) {
1442 fragment
= (xmlChar
*) uri
->fragment
;
1443 uri
->fragment
= NULL
;
1445 if ((ctxt
->incTab
!= NULL
) && (ctxt
->incTab
[nr
] != NULL
) &&
1446 (ctxt
->incTab
[nr
]->fragment
!= NULL
)) {
1447 if (fragment
!= NULL
) xmlFree(fragment
);
1448 fragment
= xmlStrdup(ctxt
->incTab
[nr
]->fragment
);
1450 URL
= xmlSaveUri(uri
);
1453 if (ctxt
->incTab
!= NULL
)
1454 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1455 XML_XINCLUDE_HREF_URI
,
1456 "invalid value URI %s\n", url
);
1458 xmlXIncludeErr(ctxt
, NULL
,
1459 XML_XINCLUDE_HREF_URI
,
1460 "invalid value URI %s\n", url
);
1461 if (fragment
!= NULL
)
1467 * Handling of references to the local document are done
1468 * directly through ctxt->doc.
1470 if ((URL
[0] == 0) || (URL
[0] == '#') ||
1471 ((ctxt
->doc
!= NULL
) && (xmlStrEqual(URL
, ctxt
->doc
->URL
)))) {
1477 * Prevent reloading twice the document.
1479 for (i
= 0; i
< ctxt
->incNr
; i
++) {
1480 if ((xmlStrEqual(URL
, ctxt
->incTab
[i
]->URI
)) &&
1481 (ctxt
->incTab
[i
]->doc
!= NULL
)) {
1482 doc
= ctxt
->incTab
[i
]->doc
;
1483 #ifdef DEBUG_XINCLUDE
1484 printf("Already loaded %s\n", URL
);
1493 #ifdef DEBUG_XINCLUDE
1494 printf("loading %s\n", URL
);
1496 #ifdef LIBXML_XPTR_ENABLED
1498 * If this is an XPointer evaluation, we want to assure that
1499 * all entities have been resolved prior to processing the
1500 * referenced document
1502 saveFlags
= ctxt
->parseFlags
;
1503 if (fragment
!= NULL
) { /* if this is an XPointer eval */
1504 ctxt
->parseFlags
|= XML_PARSE_NOENT
;
1508 doc
= xmlXIncludeParseFile(ctxt
, (const char *)URL
);
1509 #ifdef LIBXML_XPTR_ENABLED
1510 ctxt
->parseFlags
= saveFlags
;
1514 if (fragment
!= NULL
)
1518 ctxt
->incTab
[nr
]->doc
= doc
;
1520 * It's possible that the requested URL has been mapped to a
1521 * completely different location (e.g. through a catalog entry).
1522 * To check for this, we compare the URL with that of the doc
1523 * and change it if they disagree (bug 146988).
1525 if (!xmlStrEqual(URL
, doc
->URL
)) {
1527 URL
= xmlStrdup(doc
->URL
);
1529 for (i
= nr
+ 1; i
< ctxt
->incNr
; i
++) {
1530 if (xmlStrEqual(URL
, ctxt
->incTab
[i
]->URI
)) {
1531 ctxt
->incTab
[nr
]->count
++;
1532 #ifdef DEBUG_XINCLUDE
1533 printf("Increasing %s count since reused\n", URL
);
1540 * Make sure we have all entities fixed up
1542 xmlXIncludeMergeEntities(ctxt
, ctxt
->doc
, doc
);
1545 * We don't need the DTD anymore, free up space
1546 if (doc->intSubset != NULL) {
1547 xmlUnlinkNode((xmlNodePtr) doc->intSubset);
1548 xmlFreeNode((xmlNodePtr) doc->intSubset);
1549 doc->intSubset = NULL;
1551 if (doc->extSubset != NULL) {
1552 xmlUnlinkNode((xmlNodePtr) doc->extSubset);
1553 xmlFreeNode((xmlNodePtr) doc->extSubset);
1554 doc->extSubset = NULL;
1557 xmlXIncludeRecurseDoc(ctxt
, doc
, URL
);
1560 if (fragment
== NULL
) {
1562 * Add the top children list as the replacement copy.
1564 ctxt
->incTab
[nr
]->inc
= xmlXIncludeCopyNodeList(ctxt
, ctxt
->doc
,
1565 doc
, doc
->children
);
1567 #ifdef LIBXML_XPTR_ENABLED
1570 * Computes the XPointer expression and make a copy used
1571 * as the replacement copy.
1573 xmlXPathObjectPtr xptr
;
1574 xmlXPathContextPtr xptrctxt
;
1577 xptrctxt
= xmlXPtrNewContext(doc
, NULL
, NULL
);
1578 if (xptrctxt
== NULL
) {
1579 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1580 XML_XINCLUDE_XPTR_FAILED
,
1581 "could not create XPointer context\n", NULL
);
1586 xptr
= xmlXPtrEval(fragment
, xptrctxt
);
1588 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1589 XML_XINCLUDE_XPTR_FAILED
,
1590 "XPointer evaluation failed: #%s\n",
1592 xmlXPathFreeContext(xptrctxt
);
1597 switch (xptr
->type
) {
1598 case XPATH_UNDEFINED
:
1604 case XPATH_XSLT_TREE
:
1605 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1606 XML_XINCLUDE_XPTR_RESULT
,
1607 "XPointer is not a range: #%s\n",
1609 xmlXPathFreeObject(xptr
);
1610 xmlXPathFreeContext(xptrctxt
);
1615 if ((xptr
->nodesetval
== NULL
) ||
1616 (xptr
->nodesetval
->nodeNr
<= 0)) {
1617 xmlXPathFreeObject(xptr
);
1618 xmlXPathFreeContext(xptrctxt
);
1625 case XPATH_LOCATIONSET
:
1628 set
= xptr
->nodesetval
;
1630 for (i
= 0;i
< set
->nodeNr
;i
++) {
1631 if (set
->nodeTab
[i
] == NULL
)
1633 switch (set
->nodeTab
[i
]->type
) {
1634 case XML_ELEMENT_NODE
:
1636 case XML_CDATA_SECTION_NODE
:
1637 case XML_ENTITY_REF_NODE
:
1638 case XML_ENTITY_NODE
:
1640 case XML_COMMENT_NODE
:
1641 case XML_DOCUMENT_NODE
:
1642 case XML_HTML_DOCUMENT_NODE
:
1643 #ifdef LIBXML_DOCB_ENABLED
1644 case XML_DOCB_DOCUMENT_NODE
:
1648 case XML_ATTRIBUTE_NODE
:
1649 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1650 XML_XINCLUDE_XPTR_RESULT
,
1651 "XPointer selects an attribute: #%s\n",
1653 set
->nodeTab
[i
] = NULL
;
1655 case XML_NAMESPACE_DECL
:
1656 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1657 XML_XINCLUDE_XPTR_RESULT
,
1658 "XPointer selects a namespace: #%s\n",
1660 set
->nodeTab
[i
] = NULL
;
1662 case XML_DOCUMENT_TYPE_NODE
:
1663 case XML_DOCUMENT_FRAG_NODE
:
1664 case XML_NOTATION_NODE
:
1666 case XML_ELEMENT_DECL
:
1667 case XML_ATTRIBUTE_DECL
:
1668 case XML_ENTITY_DECL
:
1669 case XML_XINCLUDE_START
:
1670 case XML_XINCLUDE_END
:
1671 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1672 XML_XINCLUDE_XPTR_RESULT
,
1673 "XPointer selects unexpected nodes: #%s\n",
1675 set
->nodeTab
[i
] = NULL
;
1676 set
->nodeTab
[i
] = NULL
;
1681 ctxt
->incTab
[nr
]->inc
=
1682 xmlXIncludeCopyXPointer(ctxt
, ctxt
->doc
, doc
, xptr
);
1683 xmlXPathFreeObject(xptr
);
1684 xmlXPathFreeContext(xptrctxt
);
1690 * Do the xml:base fixup if needed
1692 if ((doc
!= NULL
) && (URL
!= NULL
) &&
1693 (!(ctxt
->parseFlags
& XML_PARSE_NOBASEFIX
)) &&
1694 (!(doc
->parseFlags
& XML_PARSE_NOBASEFIX
))) {
1700 * The base is only adjusted if "necessary", i.e. if the xinclude node
1701 * has a base specified, or the URL is relative
1703 base
= xmlGetNsProp(ctxt
->incTab
[nr
]->ref
, BAD_CAST
"base",
1707 * No xml:base on the xinclude node, so we check whether the
1708 * URI base is different than (relative to) the context base
1710 curBase
= xmlBuildRelativeURI(URL
, ctxt
->base
);
1711 if (curBase
== NULL
) { /* Error return */
1712 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1713 XML_XINCLUDE_HREF_URI
,
1714 "trying to build relative URI from %s\n", URL
);
1716 /* If the URI doesn't contain a slash, it's not relative */
1717 if (!xmlStrchr(curBase
, (xmlChar
) '/'))
1723 if (base
!= NULL
) { /* Adjustment may be needed */
1724 node
= ctxt
->incTab
[nr
]->inc
;
1725 while (node
!= NULL
) {
1726 /* Only work on element nodes */
1727 if (node
->type
== XML_ELEMENT_NODE
) {
1728 curBase
= xmlNodeGetBase(node
->doc
, node
);
1729 /* If no current base, set it */
1730 if (curBase
== NULL
) {
1731 xmlNodeSetBase(node
, base
);
1734 * If the current base is the same as the
1735 * URL of the document, then reset it to be
1736 * the specified xml:base or the relative URI
1738 if (xmlStrEqual(curBase
, node
->doc
->URL
)) {
1739 xmlNodeSetBase(node
, base
);
1742 * If the element already has an xml:base
1743 * set, then relativise it if necessary
1746 xmlBase
= xmlGetNsProp(node
,
1749 if (xmlBase
!= NULL
) {
1751 relBase
= xmlBuildURI(xmlBase
, base
);
1752 if (relBase
== NULL
) { /* error */
1753 xmlXIncludeErr(ctxt
,
1754 ctxt
->incTab
[nr
]->ref
,
1755 XML_XINCLUDE_HREF_URI
,
1756 "trying to rebuild base from %s\n",
1759 xmlNodeSetBase(node
, relBase
);
1773 if ((nr
< ctxt
->incNr
) && (ctxt
->incTab
[nr
]->doc
!= NULL
) &&
1774 (ctxt
->incTab
[nr
]->count
<= 1)) {
1775 #ifdef DEBUG_XINCLUDE
1776 printf("freeing %s\n", ctxt
->incTab
[nr
]->doc
->URL
);
1778 xmlFreeDoc(ctxt
->incTab
[nr
]->doc
);
1779 ctxt
->incTab
[nr
]->doc
= NULL
;
1786 * xmlXIncludeLoadTxt:
1787 * @ctxt: the XInclude context
1788 * @url: the associated URL
1789 * @nr: the xinclude node number
1791 * Load the content, and store the result in the XInclude context
1793 * Returns 0 in case of success, -1 in case of failure
1796 xmlXIncludeLoadTxt(xmlXIncludeCtxtPtr ctxt
, const xmlChar
*url
, int nr
) {
1797 xmlParserInputBufferPtr buf
;
1802 xmlChar
*encoding
= NULL
;
1803 xmlCharEncoding enc
= (xmlCharEncoding
) 0;
1804 xmlParserCtxtPtr pctxt
;
1805 xmlParserInputPtr inputStream
;
1806 int xinclude_multibyte_fallback_used
= 0;
1808 /* Don't read from stdin. */
1809 if (xmlStrcmp(url
, BAD_CAST
"-") == 0)
1810 url
= BAD_CAST
"./-";
1813 * Check the URL and remove any fragment identifier
1815 uri
= xmlParseURI((const char *)url
);
1817 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
, XML_XINCLUDE_HREF_URI
,
1818 "invalid value URI %s\n", url
);
1821 if (uri
->fragment
!= NULL
) {
1822 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
, XML_XINCLUDE_TEXT_FRAGMENT
,
1823 "fragment identifier forbidden for text: %s\n",
1824 (const xmlChar
*) uri
->fragment
);
1828 URL
= xmlSaveUri(uri
);
1831 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
, XML_XINCLUDE_HREF_URI
,
1832 "invalid value URI %s\n", url
);
1837 * Handling of references to the local document are done
1838 * directly through ctxt->doc.
1841 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1842 XML_XINCLUDE_TEXT_DOCUMENT
,
1843 "text serialization of document not available\n", NULL
);
1849 * Prevent reloading twice the document.
1851 for (i
= 0; i
< ctxt
->txtNr
; i
++) {
1852 if (xmlStrEqual(URL
, ctxt
->txturlTab
[i
])) {
1853 node
= xmlNewText(ctxt
->txtTab
[i
]);
1858 * Try to get the encoding if available
1860 if ((ctxt
->incTab
[nr
] != NULL
) && (ctxt
->incTab
[nr
]->ref
!= NULL
)) {
1861 encoding
= xmlGetProp(ctxt
->incTab
[nr
]->ref
, XINCLUDE_PARSE_ENCODING
);
1863 if (encoding
!= NULL
) {
1865 * TODO: we should not have to remap to the xmlCharEncoding
1866 * predefined set, a better interface than
1867 * xmlParserInputBufferCreateFilename should allow any
1868 * encoding supported by iconv
1870 enc
= xmlParseCharEncoding((const char *) encoding
);
1871 if (enc
== XML_CHAR_ENCODING_ERROR
) {
1872 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1873 XML_XINCLUDE_UNKNOWN_ENCODING
,
1874 "encoding %s not supported\n", encoding
);
1885 pctxt
= xmlNewParserCtxt();
1886 inputStream
= xmlLoadExternalEntity((const char*)URL
, NULL
, pctxt
);
1887 if(inputStream
== NULL
) {
1888 xmlFreeParserCtxt(pctxt
);
1892 buf
= inputStream
->buf
;
1894 xmlFreeInputStream (inputStream
);
1895 xmlFreeParserCtxt(pctxt
);
1900 xmlCharEncCloseFunc(buf
->encoder
);
1901 buf
->encoder
= xmlGetCharEncodingHandler(enc
);
1902 node
= xmlNewText(NULL
);
1905 * Scan all chars from the resource and add the to the node
1907 xinclude_multibyte_fallback
:
1908 while (xmlParserInputBufferRead(buf
, 128) > 0) {
1910 const xmlChar
*content
;
1912 content
= xmlBufContent(buf
->buffer
);
1913 len
= xmlBufLength(buf
->buffer
);
1914 for (i
= 0;i
< len
;) {
1918 cur
= xmlStringCurrentChar(NULL
, &content
[i
], &l
);
1919 if (!IS_CHAR(cur
)) {
1920 /* Handle split multibyte char at buffer boundary */
1921 if (((len
- i
) < 4) && (!xinclude_multibyte_fallback_used
)) {
1922 xinclude_multibyte_fallback_used
= 1;
1923 xmlBufShrink(buf
->buffer
, i
);
1924 goto xinclude_multibyte_fallback
;
1926 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
1927 XML_XINCLUDE_INVALID_CHAR
,
1928 "%s contains invalid char\n", URL
);
1929 xmlFreeParserCtxt(pctxt
);
1930 xmlFreeParserInputBuffer(buf
);
1935 xinclude_multibyte_fallback_used
= 0;
1936 xmlNodeAddContentLen(node
, &content
[i
], l
);
1940 xmlBufShrink(buf
->buffer
, len
);
1942 xmlFreeParserCtxt(pctxt
);
1943 xmlXIncludeAddTxt(ctxt
, node
->content
, URL
);
1944 xmlFreeInputStream(inputStream
);
1948 * Add the element as the replacement copy.
1950 ctxt
->incTab
[nr
]->inc
= node
;
1956 * xmlXIncludeLoadFallback:
1957 * @ctxt: the XInclude context
1958 * @fallback: the fallback node
1959 * @nr: the xinclude node number
1961 * Load the content of the fallback node, and store the result
1962 * in the XInclude context
1964 * Returns 0 in case of success, -1 in case of failure
1967 xmlXIncludeLoadFallback(xmlXIncludeCtxtPtr ctxt
, xmlNodePtr fallback
, int nr
) {
1968 xmlXIncludeCtxtPtr newctxt
;
1970 int oldNbErrors
= ctxt
->nbErrors
;
1972 if ((fallback
== NULL
) || (fallback
->type
== XML_NAMESPACE_DECL
) ||
1975 if (fallback
->children
!= NULL
) {
1977 * It's possible that the fallback also has 'includes'
1978 * (Bug 129969), so we re-process the fallback just in case
1980 newctxt
= xmlXIncludeNewContext(ctxt
->doc
);
1981 if (newctxt
== NULL
)
1983 newctxt
->_private
= ctxt
->_private
;
1984 newctxt
->base
= xmlStrdup(ctxt
->base
); /* Inherit the base from the existing context */
1985 xmlXIncludeSetFlags(newctxt
, ctxt
->parseFlags
);
1986 newctxt
->incTotal
= ctxt
->incTotal
;
1987 if (xmlXIncludeDoProcess(newctxt
, ctxt
->doc
, fallback
, 1) < 0)
1989 ctxt
->incTotal
= newctxt
->incTotal
;
1990 if (ctxt
->nbErrors
> oldNbErrors
)
1992 xmlXIncludeFreeContext(newctxt
);
1994 ctxt
->incTab
[nr
]->inc
= xmlDocCopyNodeList(ctxt
->doc
,
1995 fallback
->children
);
1996 if (ctxt
->incTab
[nr
]->inc
== NULL
)
1997 ctxt
->incTab
[nr
]->emptyFb
= 1;
1999 ctxt
->incTab
[nr
]->inc
= NULL
;
2000 ctxt
->incTab
[nr
]->emptyFb
= 1; /* flag empty callback */
2002 ctxt
->incTab
[nr
]->fallback
= 1;
2006 /************************************************************************
2008 * XInclude Processing *
2010 ************************************************************************/
2013 * xmlXIncludePreProcessNode:
2014 * @ctxt: an XInclude context
2015 * @node: an XInclude node
2017 * Implement the XInclude preprocessing, currently just adding the element
2018 * for further processing.
2020 * Returns the result list or NULL in case of error
2023 xmlXIncludePreProcessNode(xmlXIncludeCtxtPtr ctxt
, xmlNodePtr node
) {
2024 xmlXIncludeAddNode(ctxt
, node
);
2029 * xmlXIncludeLoadNode:
2030 * @ctxt: an XInclude context
2031 * @nr: the node number
2033 * Find and load the infoset replacement for the given node.
2035 * Returns 0 if substitution succeeded, -1 if some processing failed
2038 xmlXIncludeLoadNode(xmlXIncludeCtxtPtr ctxt
, int nr
) {
2045 int xml
= 1; /* default Issue 64 */
2050 if ((nr
< 0) || (nr
>= ctxt
->incNr
))
2052 cur
= ctxt
->incTab
[nr
]->ref
;
2057 * read the attributes
2059 href
= xmlXIncludeGetProp(ctxt
, cur
, XINCLUDE_HREF
);
2061 href
= xmlStrdup(BAD_CAST
""); /* @@@@ href is now optional */
2065 parse
= xmlXIncludeGetProp(ctxt
, cur
, XINCLUDE_PARSE
);
2066 if (parse
!= NULL
) {
2067 if (xmlStrEqual(parse
, XINCLUDE_PARSE_XML
))
2069 else if (xmlStrEqual(parse
, XINCLUDE_PARSE_TEXT
))
2072 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
2073 XML_XINCLUDE_PARSE_VALUE
,
2074 "invalid value %s for 'parse'\n", parse
);
2086 base
= xmlNodeGetBase(ctxt
->doc
, cur
);
2088 URI
= xmlBuildURI(href
, ctxt
->doc
->URL
);
2090 URI
= xmlBuildURI(href
, base
);
2096 * Some escaping may be needed
2098 escbase
= xmlURIEscape(base
);
2099 eschref
= xmlURIEscape(href
);
2100 URI
= xmlBuildURI(eschref
, escbase
);
2101 if (escbase
!= NULL
)
2103 if (eschref
!= NULL
)
2107 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
2108 XML_XINCLUDE_HREF_URI
, "failed build URL\n", NULL
);
2117 #ifdef DEBUG_XINCLUDE
2118 xmlGenericError(xmlGenericErrorContext
, "parse: %s\n",
2119 xml
? "xml": "text");
2120 xmlGenericError(xmlGenericErrorContext
, "URI: %s\n", URI
);
2124 * Save the base for this include (saving the current one)
2126 oldBase
= ctxt
->base
;
2130 ret
= xmlXIncludeLoadDoc(ctxt
, URI
, nr
);
2131 /* xmlXIncludeGetFragment(ctxt, cur, URI); */
2133 ret
= xmlXIncludeLoadTxt(ctxt
, URI
, nr
);
2137 * Restore the original base before checking for fallback
2139 ctxt
->base
= oldBase
;
2142 xmlNodePtr children
;
2145 * Time to try a fallback if available
2147 #ifdef DEBUG_XINCLUDE
2148 xmlGenericError(xmlGenericErrorContext
, "error looking for fallback\n");
2150 children
= cur
->children
;
2151 while (children
!= NULL
) {
2152 if ((children
->type
== XML_ELEMENT_NODE
) &&
2153 (children
->ns
!= NULL
) &&
2154 (xmlStrEqual(children
->name
, XINCLUDE_FALLBACK
)) &&
2155 ((xmlStrEqual(children
->ns
->href
, XINCLUDE_NS
)) ||
2156 (xmlStrEqual(children
->ns
->href
, XINCLUDE_OLD_NS
)))) {
2157 ret
= xmlXIncludeLoadFallback(ctxt
, children
, nr
);
2160 children
= children
->next
;
2164 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
2165 XML_XINCLUDE_NO_FALLBACK
,
2166 "could not load %s, and no fallback was found\n",
2185 * xmlXIncludeIncludeNode:
2186 * @ctxt: an XInclude context
2187 * @nr: the node number
2189 * Implement the infoset replacement for the given node
2191 * Returns 0 if substitution succeeded, -1 if some processing failed
2194 xmlXIncludeIncludeNode(xmlXIncludeCtxtPtr ctxt
, int nr
) {
2195 xmlNodePtr cur
, end
, list
, tmp
;
2199 if ((nr
< 0) || (nr
>= ctxt
->incNr
))
2201 cur
= ctxt
->incTab
[nr
]->ref
;
2202 if ((cur
== NULL
) || (cur
->type
== XML_NAMESPACE_DECL
))
2205 list
= ctxt
->incTab
[nr
]->inc
;
2206 ctxt
->incTab
[nr
]->inc
= NULL
;
2207 ctxt
->incTab
[nr
]->emptyFb
= 0;
2210 * Check against the risk of generating a multi-rooted document
2212 if ((cur
->parent
!= NULL
) &&
2213 (cur
->parent
->type
!= XML_ELEMENT_NODE
)) {
2217 while (tmp
!= NULL
) {
2218 if (tmp
->type
== XML_ELEMENT_NODE
)
2223 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
2224 XML_XINCLUDE_MULTIPLE_ROOT
,
2225 "XInclude error: would result in multiple root nodes\n",
2227 xmlFreeNodeList(list
);
2232 if (ctxt
->parseFlags
& XML_PARSE_NOXINCNODE
) {
2234 * Add the list of nodes
2236 while (list
!= NULL
) {
2240 xmlAddPrevSibling(cur
, end
);
2245 xmlNodePtr child
, next
;
2248 * Change the current node as an XInclude start one, and add an
2251 if (ctxt
->incTab
[nr
]->fallback
)
2252 xmlUnsetProp(cur
, BAD_CAST
"href");
2253 cur
->type
= XML_XINCLUDE_START
;
2254 /* Remove fallback children */
2255 for (child
= cur
->children
; child
!= NULL
; child
= next
) {
2257 xmlUnlinkNode(child
);
2260 end
= xmlNewDocNode(cur
->doc
, cur
->ns
, cur
->name
, NULL
);
2262 xmlXIncludeErr(ctxt
, ctxt
->incTab
[nr
]->ref
,
2263 XML_XINCLUDE_BUILD_FAILED
,
2264 "failed to build node\n", NULL
);
2265 xmlFreeNodeList(list
);
2268 end
->type
= XML_XINCLUDE_END
;
2269 xmlAddNextSibling(cur
, end
);
2272 * Add the list of nodes
2274 while (list
!= NULL
) {
2278 xmlAddPrevSibling(end
, cur
);
2287 * xmlXIncludeTestNode:
2288 * @ctxt: the XInclude processing context
2289 * @node: an XInclude node
2291 * test if the node is an XInclude node
2293 * Returns 1 true, 0 otherwise
2296 xmlXIncludeTestNode(xmlXIncludeCtxtPtr ctxt
, xmlNodePtr node
) {
2299 if (node
->type
!= XML_ELEMENT_NODE
)
2301 if (node
->ns
== NULL
)
2303 if ((xmlStrEqual(node
->ns
->href
, XINCLUDE_NS
)) ||
2304 (xmlStrEqual(node
->ns
->href
, XINCLUDE_OLD_NS
))) {
2305 if (xmlStrEqual(node
->ns
->href
, XINCLUDE_OLD_NS
)) {
2306 if (ctxt
->legacy
== 0) {
2307 #if 0 /* wait for the XML Core Working Group to get something stable ! */
2308 xmlXIncludeWarn(ctxt
, node
, XML_XINCLUDE_DEPRECATED_NS
,
2309 "Deprecated XInclude namespace found, use %s",
2315 if (xmlStrEqual(node
->name
, XINCLUDE_NODE
)) {
2316 xmlNodePtr child
= node
->children
;
2317 int nb_fallback
= 0;
2319 while (child
!= NULL
) {
2320 if ((child
->type
== XML_ELEMENT_NODE
) &&
2321 (child
->ns
!= NULL
) &&
2322 ((xmlStrEqual(child
->ns
->href
, XINCLUDE_NS
)) ||
2323 (xmlStrEqual(child
->ns
->href
, XINCLUDE_OLD_NS
)))) {
2324 if (xmlStrEqual(child
->name
, XINCLUDE_NODE
)) {
2325 xmlXIncludeErr(ctxt
, node
,
2326 XML_XINCLUDE_INCLUDE_IN_INCLUDE
,
2327 "%s has an 'include' child\n",
2331 if (xmlStrEqual(child
->name
, XINCLUDE_FALLBACK
)) {
2335 child
= child
->next
;
2337 if (nb_fallback
> 1) {
2338 xmlXIncludeErr(ctxt
, node
, XML_XINCLUDE_FALLBACKS_IN_INCLUDE
,
2339 "%s has multiple fallback children\n",
2345 if (xmlStrEqual(node
->name
, XINCLUDE_FALLBACK
)) {
2346 if ((node
->parent
== NULL
) ||
2347 (node
->parent
->type
!= XML_ELEMENT_NODE
) ||
2348 (node
->parent
->ns
== NULL
) ||
2349 ((!xmlStrEqual(node
->parent
->ns
->href
, XINCLUDE_NS
)) &&
2350 (!xmlStrEqual(node
->parent
->ns
->href
, XINCLUDE_OLD_NS
))) ||
2351 (!xmlStrEqual(node
->parent
->name
, XINCLUDE_NODE
))) {
2352 xmlXIncludeErr(ctxt
, node
,
2353 XML_XINCLUDE_FALLBACK_NOT_IN_INCLUDE
,
2354 "%s is not the child of an 'include'\n",
2363 * xmlXIncludeDoProcess:
2364 * @ctxt: the XInclude processing context
2365 * @doc: an XML document
2366 * @tree: the top of the tree to process
2367 * @skipRoot: don't process the root node of the tree
2369 * Implement the XInclude substitution on the XML document @doc
2371 * Returns 0 if no substitution were done, -1 if some processing failed
2372 * or the number of substitutions done.
2375 xmlXIncludeDoProcess(xmlXIncludeCtxtPtr ctxt
, xmlDocPtr doc
, xmlNodePtr tree
,
2381 if ((doc
== NULL
) || (tree
== NULL
) || (tree
->type
== XML_NAMESPACE_DECL
))
2383 if ((skipRoot
) && (tree
->children
== NULL
))
2388 if (doc
->URL
!= NULL
) {
2389 ret
= xmlXIncludeURLPush(ctxt
, doc
->URL
);
2393 start
= ctxt
->incNr
;
2396 * TODO: The phases must run separately for recursive inclusions.
2398 * - Phase 1 should start with top-level XInclude nodes, load documents,
2399 * execute XPointer expressions, then process only the result nodes
2400 * (not whole document, see bug #324081) and only for phase 1
2401 * recursively. We will need a backreference from xmlNodes to
2402 * xmlIncludeRefs to detect references that were already visited.
2403 * This can also be used for proper cycle detection, see bug #344240.
2405 * - Phase 2 should visit all top-level XInclude nodes and expand
2406 * possible subreferences in the replacement recursively.
2408 * - Phase 3 should finally replace the top-level XInclude nodes.
2409 * It could also be run together with phase 2.
2413 * First phase: lookup the elements in the document
2416 cur
= tree
->children
;
2420 /* TODO: need to work on entities -> stack */
2421 if (xmlXIncludeTestNode(ctxt
, cur
) == 1) {
2422 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
2424 * Avoid superlinear expansion by limiting the total number
2427 if (ctxt
->incTotal
>= 20)
2431 xmlXIncludePreProcessNode(ctxt
, cur
);
2432 } else if ((cur
->children
!= NULL
) &&
2433 ((cur
->type
== XML_DOCUMENT_NODE
) ||
2434 (cur
->type
== XML_ELEMENT_NODE
))) {
2435 cur
= cur
->children
;
2441 if (cur
->next
!= NULL
) {
2446 } while (cur
!= NULL
);
2447 } while ((cur
!= NULL
) && (cur
!= tree
));
2450 * Second Phase : collect the infosets fragments
2452 for (i
= start
;i
< ctxt
->incNr
; i
++) {
2453 xmlXIncludeLoadNode(ctxt
, i
);
2458 * Third phase: extend the original document infoset.
2460 * Originally we bypassed the inclusion if there were any errors
2461 * encountered on any of the XIncludes. A bug was raised (bug
2462 * 132588) requesting that we output the XIncludes without error,
2463 * so the check for inc!=NULL || xptr!=NULL was put in. This may
2464 * give some other problems in the future, but for now it seems to
2468 for (i
= ctxt
->incBase
;i
< ctxt
->incNr
; i
++) {
2469 if ((ctxt
->incTab
[i
]->inc
!= NULL
) ||
2470 (ctxt
->incTab
[i
]->emptyFb
!= 0)) /* (empty fallback) */
2471 xmlXIncludeIncludeNode(ctxt
, i
);
2474 if (doc
->URL
!= NULL
)
2475 xmlXIncludeURLPop(ctxt
);
2480 * xmlXIncludeSetFlags:
2481 * @ctxt: an XInclude processing context
2482 * @flags: a set of xmlParserOption used for parsing XML includes
2484 * Set the flags used for further processing of XML resources.
2486 * Returns 0 in case of success and -1 in case of error.
2489 xmlXIncludeSetFlags(xmlXIncludeCtxtPtr ctxt
, int flags
) {
2492 ctxt
->parseFlags
= flags
;
2497 * xmlXIncludeProcessTreeFlagsData:
2498 * @tree: an XML node
2499 * @flags: a set of xmlParserOption used for parsing XML includes
2500 * @data: application data that will be passed to the parser context
2501 * in the _private field of the parser context(s)
2503 * Implement the XInclude substitution on the XML node @tree
2505 * Returns 0 if no substitution were done, -1 if some processing failed
2506 * or the number of substitutions done.
2510 xmlXIncludeProcessTreeFlagsData(xmlNodePtr tree
, int flags
, void *data
) {
2511 xmlXIncludeCtxtPtr ctxt
;
2514 if ((tree
== NULL
) || (tree
->type
== XML_NAMESPACE_DECL
) ||
2515 (tree
->doc
== NULL
))
2518 ctxt
= xmlXIncludeNewContext(tree
->doc
);
2521 ctxt
->_private
= data
;
2522 ctxt
->base
= xmlStrdup((xmlChar
*)tree
->doc
->URL
);
2523 xmlXIncludeSetFlags(ctxt
, flags
);
2524 ret
= xmlXIncludeDoProcess(ctxt
, tree
->doc
, tree
, 0);
2525 if ((ret
>= 0) && (ctxt
->nbErrors
> 0))
2528 xmlXIncludeFreeContext(ctxt
);
2533 * xmlXIncludeProcessFlagsData:
2534 * @doc: an XML document
2535 * @flags: a set of xmlParserOption used for parsing XML includes
2536 * @data: application data that will be passed to the parser context
2537 * in the _private field of the parser context(s)
2539 * Implement the XInclude substitution on the XML document @doc
2541 * Returns 0 if no substitution were done, -1 if some processing failed
2542 * or the number of substitutions done.
2545 xmlXIncludeProcessFlagsData(xmlDocPtr doc
, int flags
, void *data
) {
2550 tree
= xmlDocGetRootElement(doc
);
2553 return(xmlXIncludeProcessTreeFlagsData(tree
, flags
, data
));
2557 * xmlXIncludeProcessFlags:
2558 * @doc: an XML document
2559 * @flags: a set of xmlParserOption used for parsing XML includes
2561 * Implement the XInclude substitution on the XML document @doc
2563 * Returns 0 if no substitution were done, -1 if some processing failed
2564 * or the number of substitutions done.
2567 xmlXIncludeProcessFlags(xmlDocPtr doc
, int flags
) {
2568 return xmlXIncludeProcessFlagsData(doc
, flags
, NULL
);
2572 * xmlXIncludeProcess:
2573 * @doc: an XML document
2575 * Implement the XInclude substitution on the XML document @doc
2577 * Returns 0 if no substitution were done, -1 if some processing failed
2578 * or the number of substitutions done.
2581 xmlXIncludeProcess(xmlDocPtr doc
) {
2582 return(xmlXIncludeProcessFlags(doc
, 0));
2586 * xmlXIncludeProcessTreeFlags:
2587 * @tree: a node in an XML document
2588 * @flags: a set of xmlParserOption used for parsing XML includes
2590 * Implement the XInclude substitution for the given subtree
2592 * Returns 0 if no substitution were done, -1 if some processing failed
2593 * or the number of substitutions done.
2596 xmlXIncludeProcessTreeFlags(xmlNodePtr tree
, int flags
) {
2597 xmlXIncludeCtxtPtr ctxt
;
2600 if ((tree
== NULL
) || (tree
->type
== XML_NAMESPACE_DECL
) ||
2601 (tree
->doc
== NULL
))
2603 ctxt
= xmlXIncludeNewContext(tree
->doc
);
2606 ctxt
->base
= xmlNodeGetBase(tree
->doc
, tree
);
2607 xmlXIncludeSetFlags(ctxt
, flags
);
2608 ret
= xmlXIncludeDoProcess(ctxt
, tree
->doc
, tree
, 0);
2609 if ((ret
>= 0) && (ctxt
->nbErrors
> 0))
2612 xmlXIncludeFreeContext(ctxt
);
2617 * xmlXIncludeProcessTree:
2618 * @tree: a node in an XML document
2620 * Implement the XInclude substitution for the given subtree
2622 * Returns 0 if no substitution were done, -1 if some processing failed
2623 * or the number of substitutions done.
2626 xmlXIncludeProcessTree(xmlNodePtr tree
) {
2627 return(xmlXIncludeProcessTreeFlags(tree
, 0));
2631 * xmlXIncludeProcessNode:
2632 * @ctxt: an existing XInclude context
2633 * @node: a node in an XML document
2635 * Implement the XInclude substitution for the given subtree reusing
2636 * the information and data coming from the given context.
2638 * Returns 0 if no substitution were done, -1 if some processing failed
2639 * or the number of substitutions done.
2642 xmlXIncludeProcessNode(xmlXIncludeCtxtPtr ctxt
, xmlNodePtr node
) {
2645 if ((node
== NULL
) || (node
->type
== XML_NAMESPACE_DECL
) ||
2646 (node
->doc
== NULL
) || (ctxt
== NULL
))
2648 ret
= xmlXIncludeDoProcess(ctxt
, node
->doc
, node
, 0);
2649 if ((ret
>= 0) && (ctxt
->nbErrors
> 0))
2654 #else /* !LIBXML_XINCLUDE_ENABLED */
2656 #define bottom_xinclude
2657 #include "elfgcchack.h"