xref: /PHP-8.2/ext/dom/nodelist.c (revision b282dd74)
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    +----------------------------------------------------------------------+
16 */
17 
18 #ifdef HAVE_CONFIG_H
19 #include "config.h"
20 #endif
21 
22 #include "php.h"
23 #if defined(HAVE_LIBXML) && defined(HAVE_DOM)
24 #include "php_dom.h"
25 #include "zend_interfaces.h"
26 
27 /*
28 * class DOMNodeList
29 *
30 * URL: https://www.w3.org/TR/2003/WD-DOM-Level-3-Core-20030226/DOM3-Core.html#ID-536297177
31 * Since:
32 */
33 
dom_nodelist_iter_start_first_child(xmlNodePtr nodep)34 xmlNodePtr dom_nodelist_iter_start_first_child(xmlNodePtr nodep)
35 {
36 	if (nodep->type == XML_ENTITY_REF_NODE) {
37 		/* See entityreference.c */
38 		dom_entity_reference_fetch_and_sync_declaration(nodep);
39 	}
40 
41 	return nodep->children;
42 }
43 
php_dom_get_nodelist_length(dom_object * obj)44 int php_dom_get_nodelist_length(dom_object *obj)
45 {
46 	dom_nnodemap_object *objmap = (dom_nnodemap_object *) obj->ptr;
47 	if (!objmap) {
48 		return 0;
49 	}
50 
51 	if (objmap->ht) {
52 		return xmlHashSize(objmap->ht);
53 	}
54 
55 	if (objmap->nodetype == DOM_NODESET) {
56 		HashTable *nodeht = HASH_OF(&objmap->baseobj_zv);
57 		return zend_hash_num_elements(nodeht);
58 	}
59 
60 	xmlNodePtr nodep = dom_object_get_node(objmap->baseobj);
61 	if (!nodep) {
62 		return 0;
63 	}
64 
65 	int count = 0;
66 	if (objmap->nodetype == XML_ATTRIBUTE_NODE || objmap->nodetype == XML_ELEMENT_NODE) {
67 		xmlNodePtr curnode = dom_nodelist_iter_start_first_child(nodep);
68 		if (curnode) {
69 			count++;
70 			while (curnode->next != NULL) {
71 				count++;
72 				curnode = curnode->next;
73 			}
74 		}
75 	} else {
76 		if (nodep->type == XML_DOCUMENT_NODE || nodep->type == XML_HTML_DOCUMENT_NODE) {
77 			nodep = xmlDocGetRootElement((xmlDoc *) nodep);
78 		} else {
79 			nodep = nodep->children;
80 		}
81 		dom_get_elements_by_tag_name_ns_raw(
82 			nodep, (char *) objmap->ns, (char *) objmap->local, &count, -1);
83 	}
84 
85 	return count;
86 }
87 
88 /* {{{ length	int
89 readonly=yes
90 URL: http://www.w3.org/TR/2003/WD-DOM-Level-3-Core-20030226/DOM3-Core.html#ID-203510337
91 Since:
92 */
dom_nodelist_length_read(dom_object * obj,zval * retval)93 int dom_nodelist_length_read(dom_object *obj, zval *retval)
94 {
95 	ZVAL_LONG(retval, php_dom_get_nodelist_length(obj));
96 	return SUCCESS;
97 }
98 
99 
100 /* {{{ */
PHP_METHOD(DOMNodeList,count)101 PHP_METHOD(DOMNodeList, count)
102 {
103 	zval *id;
104 	dom_object *intern;
105 
106 	id = ZEND_THIS;
107 	if (zend_parse_parameters_none() == FAILURE) {
108 		RETURN_THROWS();
109 	}
110 
111 	intern = Z_DOMOBJ_P(id);
112 	RETURN_LONG(php_dom_get_nodelist_length(intern));
113 }
114 /* }}} end dom_nodelist_count */
115 
php_dom_nodelist_get_item_into_zval(dom_nnodemap_object * objmap,zend_long index,zval * return_value)116 void php_dom_nodelist_get_item_into_zval(dom_nnodemap_object *objmap, zend_long index, zval *return_value)
117 {
118 	int ret;
119 	xmlNodePtr itemnode = NULL;
120 	if (index >= 0) {
121 		if (objmap != NULL) {
122 			if (objmap->ht) {
123 				if (objmap->nodetype == XML_ENTITY_NODE) {
124 					itemnode = php_dom_libxml_hash_iter(objmap->ht, index);
125 				} else {
126 					itemnode = php_dom_libxml_notation_iter(objmap->ht, index);
127 				}
128 			} else {
129 				if (objmap->nodetype == DOM_NODESET) {
130 					HashTable *nodeht = HASH_OF(&objmap->baseobj_zv);
131 					zval *entry = zend_hash_index_find(nodeht, index);
132 					if (entry) {
133 						ZVAL_COPY(return_value, entry);
134 						return;
135 					}
136 				} else if (objmap->baseobj) {
137 					xmlNodePtr nodep = dom_object_get_node(objmap->baseobj);
138 					if (nodep) {
139 						int count = 0;
140 						if (objmap->nodetype == XML_ATTRIBUTE_NODE || objmap->nodetype == XML_ELEMENT_NODE) {
141 							xmlNodePtr curnode = dom_nodelist_iter_start_first_child(nodep);
142 							while (count < index && curnode != NULL) {
143 								count++;
144 								curnode = curnode->next;
145 							}
146 							itemnode = curnode;
147 						} else {
148 							if (nodep->type == XML_DOCUMENT_NODE || nodep->type == XML_HTML_DOCUMENT_NODE) {
149 								nodep = xmlDocGetRootElement((xmlDoc *) nodep);
150 							} else {
151 								nodep = nodep->children;
152 							}
153 							itemnode = dom_get_elements_by_tag_name_ns_raw(nodep, (char *) objmap->ns, (char *) objmap->local, &count, index);
154 						}
155 					}
156 				}
157 			}
158 		}
159 
160 		if (itemnode) {
161 			DOM_RET_OBJ(itemnode, &ret, objmap->baseobj);
162 			return;
163 		}
164 	}
165 
166 	RETVAL_NULL();
167 }
168 
169 /* {{{ URL: http://www.w3.org/TR/2003/WD-DOM-Level-3-Core-20030226/DOM3-Core.html#ID-844377136
170 Since:
171 */
PHP_METHOD(DOMNodeList,item)172 PHP_METHOD(DOMNodeList, item)
173 {
174 	zend_long index;
175 	if (zend_parse_parameters(ZEND_NUM_ARGS(), "l", &index) == FAILURE) {
176 		RETURN_THROWS();
177 	}
178 
179 	zval *id = ZEND_THIS;
180 	dom_object *intern = Z_DOMOBJ_P(id);
181 	dom_nnodemap_object *objmap = intern->ptr;
182 	php_dom_nodelist_get_item_into_zval(objmap, index, return_value);
183 }
184 /* }}} end dom_nodelist_item */
185 
ZEND_METHOD(DOMNodeList,getIterator)186 ZEND_METHOD(DOMNodeList, getIterator)
187 {
188 	if (zend_parse_parameters_none() == FAILURE) {
189 		return;
190 	}
191 
192 	zend_create_internal_iterator_zval(return_value, ZEND_THIS);
193 }
194 
195 #endif
196