xref: /PHP-8.3/ext/dom/php_dom.h (revision 5cb38e9d) 
1 /*
2    +----------------------------------------------------------------------+
3    | Copyright (c) The PHP Group                                          |
4    +----------------------------------------------------------------------+
5    | This source file is subject to version 3.01 of the PHP license,      |
6    | that is bundled with this package in the file LICENSE, and is        |
7    | available through the world-wide-web at the following url:           |
8    | https://www.php.net/license/3_01.txt                                 |
9    | If you did not receive a copy of the PHP license and are unable to   |
10    | obtain it through the world-wide-web, please send a note to          |
11    | license@php.net so we can mail you a copy immediately.               |
12    +----------------------------------------------------------------------+
13    | Authors: Christian Stocker <chregu@php.net>                          |
14    |          Rob Richards <rrichards@php.net>							  |
15    |          Marcus Borger <helly@php.net>                               |
16    +----------------------------------------------------------------------+
17 */
18 
19 #ifndef PHP_DOM_H
20 #define PHP_DOM_H
21 
22 extern zend_module_entry dom_module_entry;
23 #define phpext_dom_ptr &dom_module_entry
24 
25 #ifdef ZTS
26 #include "TSRM.h"
27 #endif
28 
29 #include <libxml/parser.h>
30 #include <libxml/parserInternals.h>
31 #include <libxml/tree.h>
32 #include <libxml/uri.h>
33 #include <libxml/xmlerror.h>
34 #include <libxml/xinclude.h>
35 #include <libxml/hash.h>
36 #include <libxml/c14n.h>
37 #ifdef LIBXML_HTML_ENABLED
38 #include <libxml/HTMLparser.h>
39 #include <libxml/HTMLtree.h>
40 #endif
41 #ifdef LIBXML_XPATH_ENABLED
42 #include <libxml/xpath.h>
43 #include <libxml/xpathInternals.h>
44 #endif
45 #ifdef LIBXML_XPTR_ENABLED
46 #include <libxml/xpointer.h>
47 #endif
48 #ifdef PHP_WIN32
49 #ifndef DOM_EXPORTS
50 #define DOM_EXPORTS
51 #endif
52 #endif
53 
54 #include "xml_common.h"
55 #include "ext/libxml/php_libxml.h"
56 #include "zend_exceptions.h"
57 #include "dom_ce.h"
58 /* DOM API_VERSION, please bump it up, if you change anything in the API
59     therefore it's easier for the script-programmers to check, what's working how
60    Can be checked with phpversion("dom");
61 */
62 #define DOM_API_VERSION "20031129"
63 /* Define a custom type for iterating using an unused nodetype */
64 #define DOM_NODESET XML_XINCLUDE_START
65 
66 typedef struct _dom_xpath_object {
67 	int registerPhpFunctions;
68 	int register_node_ns;
69 	HashTable *registered_phpfunctions;
70 	HashTable *node_list;
71 	dom_object dom;
72 } dom_xpath_object;
73 
php_xpath_obj_from_obj(zend_object * obj)74 static inline dom_xpath_object *php_xpath_obj_from_obj(zend_object *obj) {
75 	return (dom_xpath_object*)((char*)(obj)
76 		- XtOffsetOf(dom_xpath_object, dom) - XtOffsetOf(dom_object, std));
77 }
78 
79 #define Z_XPATHOBJ_P(zv)  php_xpath_obj_from_obj(Z_OBJ_P((zv)))
80 
81 typedef struct _dom_nnodemap_object {
82 	dom_object *baseobj;
83 	zval baseobj_zv;
84 	int nodetype;
85 	int cached_length;
86 	xmlHashTable *ht;
87 	xmlChar *local;
88 	xmlChar *ns;
89 	php_libxml_cache_tag cache_tag;
90 	dom_object *cached_obj;
91 	zend_long cached_obj_index;
92 	bool free_local : 1;
93 	bool free_ns : 1;
94 } dom_nnodemap_object;
95 
96 typedef struct {
97 	zend_object_iterator intern;
98 	zval curobj;
99 	HashPosition pos;
100 	php_libxml_cache_tag cache_tag;
101 } php_dom_iterator;
102 
103 typedef struct {
104 	/* This may be a fake object that isn't actually in the children list of the parent.
105 	 * This is because some namespace declaration nodes aren't stored on the parent in libxml2, so we have to fake it.
106 	 * We could use a zval for this, but since this is always going to be an object let's save space... */
107 	dom_object *parent_intern;
108 	dom_object dom;
109 } dom_object_namespace_node;
110 
php_dom_namespace_node_obj_from_obj(zend_object * obj)111 static inline dom_object_namespace_node *php_dom_namespace_node_obj_from_obj(zend_object *obj) {
112 	return (dom_object_namespace_node*)((char*)(obj) - XtOffsetOf(dom_object_namespace_node, dom.std));
113 }
114 
115 #include "domexception.h"
116 
117 dom_object *dom_object_get_data(xmlNodePtr obj);
118 dom_doc_propsptr dom_get_doc_props(php_libxml_ref_obj *document);
119 libxml_doc_props const* dom_get_doc_props_read_only(const php_libxml_ref_obj *document);
120 zend_object *dom_objects_new(zend_class_entry *class_type);
121 zend_object *dom_nnodemap_objects_new(zend_class_entry *class_type);
122 #ifdef LIBXML_XPATH_ENABLED
123 zend_object *dom_xpath_objects_new(zend_class_entry *class_type);
124 #endif
125 int dom_get_strict_error(php_libxml_ref_obj *document);
126 void php_dom_throw_error(int error_code, int strict_error);
127 void php_dom_throw_error_with_message(int error_code, char *error_message, int strict_error);
128 void node_list_unlink(xmlNodePtr node);
129 int dom_check_qname(char *qname, char **localname, char **prefix, int uri_len, int name_len);
130 xmlNsPtr dom_get_ns(xmlNodePtr node, char *uri, int *errorcode, char *prefix);
131 xmlNsPtr dom_get_ns_unchecked(xmlNodePtr nodep, char *uri, char *prefix);
132 void dom_reconcile_ns(xmlDocPtr doc, xmlNodePtr nodep);
133 void dom_reconcile_ns_list(xmlDocPtr doc, xmlNodePtr nodep, xmlNodePtr last);
134 xmlNsPtr dom_get_nsdecl(xmlNode *node, xmlChar *localName);
135 void dom_normalize (xmlNodePtr nodep);
136 xmlNode *dom_get_elements_by_tag_name_ns_raw(xmlNodePtr basep, xmlNodePtr nodep, char *ns, char *local, zend_long *cur, zend_long index);
137 void php_dom_create_implementation(zval *retval);
138 int dom_hierarchy(xmlNodePtr parent, xmlNodePtr child);
139 bool dom_has_feature(zend_string *feature, zend_string *version);
140 int dom_node_is_read_only(xmlNodePtr node);
141 int dom_node_children_valid(xmlNodePtr node);
142 void php_dom_create_iterator(zval *return_value, int ce_type);
143 void dom_namednode_iter(dom_object *basenode, int ntype, dom_object *intern, xmlHashTablePtr ht, const char *local, size_t local_len, const char *ns, size_t ns_len);
144 xmlNodePtr create_notation(const xmlChar *name, const xmlChar *ExternalID, const xmlChar *SystemID);
145 xmlNode *php_dom_libxml_hash_iter(xmlHashTable *ht, int index);
146 xmlNode *php_dom_libxml_notation_iter(xmlHashTable *ht, int index);
147 zend_object_iterator *php_dom_get_iterator(zend_class_entry *ce, zval *object, int by_ref);
148 void dom_set_doc_classmap(php_libxml_ref_obj *document, zend_class_entry *basece, zend_class_entry *ce);
149 xmlNodePtr php_dom_create_fake_namespace_decl(xmlNodePtr nodep, xmlNsPtr original, zval *return_value, dom_object *parent_intern);
150 void php_dom_get_content_into_zval(const xmlNode *nodep, zval *target, bool default_is_null);
151 zend_string *dom_node_concatenated_name_helper(size_t name_len, const char *name, size_t prefix_len, const char *prefix);
152 zend_string *dom_node_get_node_name_attribute_or_element(const xmlNode *nodep);
153 bool php_dom_is_node_connected(const xmlNode *node);
154 bool php_dom_adopt_node(xmlNodePtr nodep, dom_object *dom_object_new_document, xmlDocPtr new_document);
155 xmlNsPtr dom_get_ns_resolve_prefix_conflict(xmlNodePtr tree, const char *uri);
156 xmlEntityPtr dom_entity_reference_fetch_and_sync_declaration(xmlNodePtr reference);
157 void dom_set_document_ref_pointers(xmlNodePtr node, php_libxml_ref_obj *document);
158 void dom_set_document_ref_pointers_attr(xmlAttrPtr attr, php_libxml_ref_obj *document);
159 
160 /* parentnode */
161 void dom_parent_node_prepend(dom_object *context, zval *nodes, uint32_t nodesc);
162 void dom_parent_node_append(dom_object *context, zval *nodes, uint32_t nodesc);
163 void dom_parent_node_after(dom_object *context, zval *nodes, uint32_t nodesc);
164 void dom_parent_node_before(dom_object *context, zval *nodes, uint32_t nodesc);
165 void dom_parent_node_replace_children(dom_object *context, zval *nodes, uint32_t nodesc);
166 void dom_child_node_remove(dom_object *context);
167 void dom_child_replace_with(dom_object *context, zval *nodes, uint32_t nodesc);
168 
169 void dom_remove_all_children(xmlNodePtr nodep);
170 
171 /* nodemap and nodelist APIs */
172 xmlNodePtr php_dom_named_node_map_get_named_item(dom_nnodemap_object *objmap, const char *named, bool may_transform);
173 void php_dom_named_node_map_get_named_item_into_zval(dom_nnodemap_object *objmap, const char *named, zval *return_value);
174 xmlNodePtr php_dom_named_node_map_get_item(dom_nnodemap_object *objmap, zend_long index);
175 void php_dom_named_node_map_get_item_into_zval(dom_nnodemap_object *objmap, zend_long index, zval *return_value);
176 void php_dom_nodelist_get_item_into_zval(dom_nnodemap_object *objmap, zend_long index, zval *return_value);
177 int php_dom_get_namednodemap_length(dom_object *obj);
178 int php_dom_get_nodelist_length(dom_object *obj);
179 xmlNodePtr dom_nodelist_iter_start_first_child(xmlNodePtr nodep);
180 
181 #define DOM_GET_INTERN(__id, __intern) { \
182 	__intern = Z_DOMOBJ_P(__id); \
183 	if (UNEXPECTED(__intern->ptr == NULL)) { \
184 		zend_throw_error(NULL, "Couldn't fetch %s", ZSTR_VAL(__intern->std.ce->name));\
185 		RETURN_THROWS();\
186   	} \
187 }
188 
189 #define DOM_GET_THIS_INTERN(__intern) DOM_GET_INTERN(ZEND_THIS, __intern)
190 
191 #define DOM_GET_OBJ(__ptr, __id, __prtype, __intern) { \
192 	DOM_GET_INTERN(__id, __intern); \
193 	__ptr = (__prtype)((php_libxml_node_ptr *)__intern->ptr)->node; \
194 }
195 
196 #define DOM_NO_ARGS() \
197 	if (zend_parse_parameters_none() == FAILURE) { \
198 		RETURN_THROWS(); \
199 	}
200 
201 #define DOM_NOT_IMPLEMENTED() \
202 	zend_throw_error(NULL, "Not yet implemented"); \
203 	RETURN_THROWS();
204 
205 #define DOM_NODELIST 0
206 #define DOM_NAMEDNODEMAP 1
207 
php_dom_is_cache_tag_stale_from_doc_ptr(const php_libxml_cache_tag * cache_tag,const php_libxml_ref_obj * doc_ptr)208 static zend_always_inline bool php_dom_is_cache_tag_stale_from_doc_ptr(const php_libxml_cache_tag *cache_tag, const php_libxml_ref_obj *doc_ptr)
209 {
210 	ZEND_ASSERT(cache_tag != NULL);
211 	ZEND_ASSERT(doc_ptr != NULL);
212 	/* See overflow comment in php_libxml_invalidate_node_list_cache(). */
213 #if SIZEOF_SIZE_T == 8
214 	return cache_tag->modification_nr != doc_ptr->cache_tag.modification_nr;
215 #else
216 	return cache_tag->modification_nr != doc_ptr->cache_tag.modification_nr || UNEXPECTED(doc_ptr->cache_tag.modification_nr == SIZE_MAX);
217 #endif
218 }
219 
php_dom_is_cache_tag_stale_from_node(const php_libxml_cache_tag * cache_tag,const xmlNodePtr node)220 static zend_always_inline bool php_dom_is_cache_tag_stale_from_node(const php_libxml_cache_tag *cache_tag, const xmlNodePtr node)
221 {
222 	ZEND_ASSERT(node != NULL);
223 	php_libxml_node_ptr *private = node->_private;
224 	if (!private) {
225 		return true;
226 	}
227 	php_libxml_node_object *object_private = private->_private;
228 	if (!object_private || !object_private->document) {
229 		return true;
230 	}
231 	return php_dom_is_cache_tag_stale_from_doc_ptr(cache_tag, object_private->document);
232 }
233 
php_dom_mark_cache_tag_up_to_date_from_node(php_libxml_cache_tag * cache_tag,const xmlNodePtr node)234 static zend_always_inline void php_dom_mark_cache_tag_up_to_date_from_node(php_libxml_cache_tag *cache_tag, const xmlNodePtr node)
235 {
236 	ZEND_ASSERT(cache_tag != NULL);
237 	php_libxml_node_ptr *private = node->_private;
238 	if (private) {
239 		php_libxml_node_object *object_private = private->_private;
240 		if (object_private->document) {
241 			cache_tag->modification_nr = object_private->document->cache_tag.modification_nr;
242 		}
243 	}
244 }
245 
246 PHP_MINIT_FUNCTION(dom);
247 PHP_MSHUTDOWN_FUNCTION(dom);
248 PHP_MINFO_FUNCTION(dom);
249 
250 #endif /* PHP_DOM_H */
251