/* +----------------------------------------------------------------------+ | Copyright (c) The PHP Group | +----------------------------------------------------------------------+ | This source file is subject to version 3.01 of the PHP license, | | that is bundled with this package in the file LICENSE, and is | | available through the world-wide-web at the following url: | | https://www.php.net/license/3_01.txt | | If you did not receive a copy of the PHP license and are unable to | | obtain it through the world-wide-web, please send a note to | | license@php.net so we can mail you a copy immediately. | +----------------------------------------------------------------------+ | Authors: Christian Stocker | | Rob Richards | | Marcus Borger | +----------------------------------------------------------------------+ */ #ifndef PHP_DOM_H #define PHP_DOM_H extern zend_module_entry dom_module_entry; #define phpext_dom_ptr &dom_module_entry #ifdef ZTS #include "TSRM.h" #endif #include #include #include #include #include #include #include #include #ifdef LIBXML_HTML_ENABLED #include #include #endif #ifdef LIBXML_XPATH_ENABLED #include #include #endif #ifdef LIBXML_XPTR_ENABLED #include #endif #ifdef PHP_WIN32 #ifndef DOM_EXPORTS #define DOM_EXPORTS #endif #endif #include "xml_common.h" #include "ext/libxml/php_libxml.h" #include "xpath_callbacks.h" #include "zend_exceptions.h" #include "dom_ce.h" /* DOM API_VERSION, please bump it up, if you change anything in the API therefore it's easier for the script-programmers to check, what's working how Can be checked with phpversion("dom"); */ #define DOM_API_VERSION "20031129" /* Define a custom type for iterating using an unused nodetype */ #define DOM_NODESET XML_XINCLUDE_START typedef struct _dom_xpath_object { php_dom_xpath_callbacks xpath_callbacks; bool register_node_ns; dom_object dom; } dom_xpath_object; static inline dom_xpath_object *php_xpath_obj_from_obj(zend_object *obj) { return (dom_xpath_object*)((char*)(obj) - XtOffsetOf(dom_xpath_object, dom) - XtOffsetOf(dom_object, std)); } #define Z_XPATHOBJ_P(zv) php_xpath_obj_from_obj(Z_OBJ_P((zv))) typedef struct _dom_nnodemap_object { dom_object *baseobj; zval baseobj_zv; int nodetype; int cached_length; xmlHashTable *ht; xmlChar *local, *local_lower; xmlChar *ns; php_libxml_cache_tag cache_tag; dom_object *cached_obj; int cached_obj_index; bool free_local : 1; bool free_ns : 1; } dom_nnodemap_object; typedef struct { zend_object_iterator intern; zval curobj; HashPosition pos; php_libxml_cache_tag cache_tag; } php_dom_iterator; typedef struct { /* This may be a fake object that isn't actually in the children list of the parent. * This is because some namespace declaration nodes aren't stored on the parent in libxml2, so we have to fake it. * We could use a zval for this, but since this is always going to be an object let's save space... */ dom_object *parent_intern; dom_object dom; } dom_object_namespace_node; typedef enum _dom_iterator_type { DOM_NODELIST, DOM_NAMEDNODEMAP, DOM_DTD_NAMEDNODEMAP, DOM_HTMLCOLLECTION, } dom_iterator_type; static inline dom_object_namespace_node *php_dom_namespace_node_obj_from_obj(zend_object *obj) { return (dom_object_namespace_node*)((char*)(obj) - XtOffsetOf(dom_object_namespace_node, dom.std)); } #include "domexception.h" #define DOM_HTML_NO_DEFAULT_NS (1U << 31) void dom_objects_free_storage(zend_object *object); dom_doc_propsptr dom_get_doc_props(php_libxml_ref_obj *document); libxml_doc_props const* dom_get_doc_props_read_only(const php_libxml_ref_obj *document); zend_object *dom_objects_new(zend_class_entry *class_type); zend_object *dom_nnodemap_objects_new(zend_class_entry *class_type); #ifdef LIBXML_XPATH_ENABLED zend_object *dom_xpath_objects_new(zend_class_entry *class_type); #endif bool dom_get_strict_error(php_libxml_ref_obj *document); void node_list_unlink(xmlNodePtr node); int dom_check_qname(char *qname, char **localname, char **prefix, int uri_len, int name_len); xmlNsPtr dom_get_ns(xmlNodePtr node, char *uri, int *errorcode, char *prefix); xmlNsPtr dom_get_ns_unchecked(xmlNodePtr nodep, char *uri, char *prefix); void dom_reconcile_ns(xmlDocPtr doc, xmlNodePtr nodep); void dom_reconcile_ns_list(xmlDocPtr doc, xmlNodePtr nodep, xmlNodePtr last); xmlNsPtr dom_get_nsdecl(xmlNode *node, xmlChar *localName); void php_dom_normalize_legacy(xmlNodePtr nodep); void php_dom_normalize_modern(xmlNodePtr nodep); xmlNode *dom_get_elements_by_tag_name_ns_raw(xmlNodePtr basep, xmlNodePtr nodep, xmlChar *ns, xmlChar *local, xmlChar *local_lower, int *cur, int index); void php_dom_create_implementation(zval *retval, bool modern); int dom_hierarchy(xmlNodePtr parent, xmlNodePtr child); bool dom_has_feature(zend_string *feature, zend_string *version); int dom_node_is_read_only(const xmlNode *node); bool dom_node_children_valid(const xmlNode *node); void php_dom_create_iterator(zval *return_value, dom_iterator_type iterator_type, bool modern); 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); xmlNodePtr create_notation(const xmlChar *name, const xmlChar *ExternalID, const xmlChar *SystemID); xmlNode *php_dom_libxml_hash_iter(dom_nnodemap_object *objmap, int index); zend_object_iterator *php_dom_get_iterator(zend_class_entry *ce, zval *object, int by_ref); void dom_set_doc_classmap(php_libxml_ref_obj *document, zend_class_entry *basece, zend_class_entry *ce); xmlNodePtr php_dom_create_fake_namespace_decl(xmlNodePtr nodep, xmlNsPtr original, zval *return_value, dom_object *parent_intern); void php_dom_get_content_into_zval(const xmlNode *nodep, zval *target, bool default_is_null); zend_string *dom_node_concatenated_name_helper(size_t name_len, const char *name, size_t prefix_len, const char *prefix); zend_string *dom_node_get_node_name_attribute_or_element(const xmlNode *nodep, bool uppercase); bool php_dom_is_node_connected(const xmlNode *node); bool php_dom_adopt_node(xmlNodePtr nodep, dom_object *dom_object_new_document, xmlDocPtr new_document); xmlNsPtr dom_get_ns_resolve_prefix_conflict(xmlNodePtr tree, const char *uri); int dom_validate_and_extract(const zend_string *namespace, const zend_string *qname, xmlChar **localName, xmlChar **prefix); bool dom_match_qualified_name_according_to_spec(const xmlChar *qname, const xmlNode *nodep); bool php_dom_has_sibling_following_node(xmlNodePtr node, xmlElementType type); bool php_dom_has_sibling_preceding_node(xmlNodePtr node, xmlElementType type); bool php_dom_has_child_of_type(xmlNodePtr node, xmlElementType type); void php_dom_update_document_after_clone(dom_object *original, xmlNodePtr original_node, dom_object *clone, xmlNodePtr cloned_node); xmlAttrPtr php_dom_get_attribute_node(xmlNodePtr elem, const xmlChar *name, size_t name_len); xmlChar *php_dom_libxml_fix_file_path(xmlChar *path); void dom_document_convert_to_modern(php_libxml_ref_obj *document, xmlDocPtr lxml_doc); dom_object *php_dom_instantiate_object_helper(zval *return_value, zend_class_entry *ce, xmlNodePtr obj, dom_object *parent); xmlDocPtr php_dom_create_html_doc(void); xmlEntityPtr dom_entity_reference_fetch_and_sync_declaration(xmlNodePtr reference); void dom_set_xml_class(php_libxml_ref_obj *document); const char *dom_locate_a_namespace(const xmlNode *node, const zend_string *prefix); void dom_mark_namespaces_as_attributes_too(php_dom_libxml_ns_mapper *ns_mapper, xmlDocPtr doc); bool dom_compare_value(const xmlAttr *attr, const xmlChar *value); void dom_attr_value_will_change(dom_object *obj, xmlAttrPtr attrp); typedef enum { DOM_LOAD_STRING = 0, DOM_LOAD_FILE = 1, } dom_load_mode; #define DOM_DOCUMENT_MALFORMED ((xmlDocPtr) -1) xmlDocPtr dom_document_parser(zval *id, dom_load_mode mode, const char *source, size_t source_len, size_t options, xmlCharEncodingHandlerPtr encoding); /* parentnode */ void dom_parent_node_prepend(dom_object *context, zval *nodes, uint32_t nodesc); void dom_parent_node_append(dom_object *context, zval *nodes, uint32_t nodesc); void dom_parent_node_after(dom_object *context, zval *nodes, uint32_t nodesc); void dom_parent_node_before(dom_object *context, zval *nodes, uint32_t nodesc); void dom_parent_node_replace_children(dom_object *context, zval *nodes, uint32_t nodesc); void dom_child_node_remove(dom_object *context); void dom_child_replace_with(dom_object *context, zval *nodes, uint32_t nodesc); void dom_remove_all_children(xmlNodePtr nodep); bool php_dom_fragment_insertion_hierarchy_check_pre_insertion(xmlNodePtr parent, xmlNodePtr node, xmlNodePtr child); bool php_dom_fragment_insertion_hierarchy_check_replace(xmlNodePtr parent, xmlNodePtr node, xmlNodePtr child); void php_dom_node_append(php_libxml_ref_obj *document, xmlNodePtr node, xmlNodePtr parent); bool php_dom_pre_insert(php_libxml_ref_obj *document, xmlNodePtr node, xmlNodePtr parent, xmlNodePtr insertion_point); bool php_dom_pre_insert_is_parent_invalid(xmlNodePtr parent); void dom_parent_node_query_selector(xmlNodePtr thisp, dom_object *intern, zval *return_value, const zend_string *selectors_str); void dom_parent_node_query_selector_all(xmlNodePtr thisp, dom_object *intern, zval *return_value, const zend_string *selectors_str); void dom_element_matches(xmlNodePtr thisp, dom_object *intern, zval *return_value, const zend_string *selectors_str); void dom_element_closest(xmlNodePtr thisp, dom_object *intern, zval *return_value, const zend_string *selectors_str); /* nodemap and nodelist APIs */ xmlNodePtr php_dom_named_node_map_get_named_item(dom_nnodemap_object *objmap, const zend_string *named, bool may_transform); void php_dom_named_node_map_get_named_item_into_zval(dom_nnodemap_object *objmap, const zend_string *named, zval *return_value); xmlNodePtr php_dom_named_node_map_get_item(dom_nnodemap_object *objmap, zend_long index); void php_dom_named_node_map_get_item_into_zval(dom_nnodemap_object *objmap, zend_long index, zval *return_value); int php_dom_get_namednodemap_length(dom_object *obj); xmlNodePtr dom_clone_node(php_dom_libxml_ns_mapper *ns_mapper, xmlNodePtr node, xmlDocPtr doc, bool recursive); #define DOM_GET_INTERN(__id, __intern) { \ __intern = Z_DOMOBJ_P(__id); \ if (UNEXPECTED(__intern->ptr == NULL)) { \ zend_throw_error(NULL, "Couldn't fetch %s", ZSTR_VAL(__intern->std.ce->name));\ RETURN_THROWS();\ } \ } #define DOM_GET_THIS_INTERN(__intern) DOM_GET_INTERN(ZEND_THIS, __intern) #define DOM_GET_OBJ(__ptr, __id, __prtype, __intern) { \ DOM_GET_INTERN(__id, __intern); \ __ptr = (__prtype)((php_libxml_node_ptr *)__intern->ptr)->node; \ } 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) { ZEND_ASSERT(doc_ptr != NULL); return php_libxml_is_cache_tag_stale(cache_tag, &doc_ptr->cache_tag); } static zend_always_inline bool php_dom_is_cache_tag_stale_from_node(const php_libxml_cache_tag *cache_tag, const xmlNodePtr node) { ZEND_ASSERT(node != NULL); php_libxml_node_ptr *_private = node->_private; if (!_private) { return true; } php_libxml_node_object *object_private = _private->_private; if (!object_private || !object_private->document) { return true; } return php_dom_is_cache_tag_stale_from_doc_ptr(cache_tag, object_private->document); } static zend_always_inline void php_dom_mark_cache_tag_up_to_date_from_node(php_libxml_cache_tag *cache_tag, const xmlNodePtr node) { ZEND_ASSERT(cache_tag != NULL); php_libxml_node_ptr *_private = node->_private; if (_private) { php_libxml_node_object *object_private = _private->_private; if (object_private->document) { cache_tag->modification_nr = object_private->document->cache_tag.modification_nr; } } } static zend_always_inline void php_dom_mark_cache_tag_up_to_date_from_doc_ref(php_libxml_cache_tag *cache_tag, php_libxml_ref_obj *document) { ZEND_ASSERT(cache_tag != NULL); ZEND_ASSERT(document != NULL); cache_tag->modification_nr = document->cache_tag.modification_nr; } static zend_always_inline bool php_dom_follow_spec_node(const xmlNode *node) { ZEND_ASSERT(node != NULL); php_libxml_node_ptr *_private = node->_private; if (_private) { php_libxml_node_object *object_private = _private->_private; if (object_private->document) { return php_dom_follow_spec_doc_ref(object_private->document); } } return false; } /* Returns the first child of a container node (e.g. elements, fragments, documents, ...). */ static zend_always_inline xmlNodePtr php_dom_first_child_of_container_node(xmlNodePtr parent) { if (parent->type == XML_DOCUMENT_NODE || parent->type == XML_HTML_DOCUMENT_NODE) { return xmlDocGetRootElement((xmlDoc *) parent); } else { return parent->children; } } PHP_MINIT_FUNCTION(dom); PHP_MSHUTDOWN_FUNCTION(dom); PHP_MINFO_FUNCTION(dom); #endif /* PHP_DOM_H */