Warning promotion: Throw on writing invalid XML tag names

This change throws a ValueError when an invalid tag name is passed
to XMLWriter.

The rationale is that this indicates a programming error because
tag names typically originate from string literals or application
code generating them. This translates into either a typo or a flaw
in tag generation logic.

Closes GH-6233.

diff --git a/ext/xmlwriter/php_xmlwriter.c b/ext/xmlwriter/php_xmlwriter.c
index 6ccd23b37ea66b758fd03fa17f15d9c12e4d294d..61e4a3a7d9579704becc3d6bbab8825e1a5d2ee5 100644 (file)
--- a/ext/xmlwriter/php_xmlwriter.c
+++ b/ext/xmlwriter/php_xmlwriter.c
@@ -88,10 +88,10 @@ static zend_object *xmlwriter_object_new(zend_class_entry *class_type)
 }
 /* }}} */
 
-#define XMLW_NAME_CHK(__err) \
+#define XMLW_NAME_CHK(__arg_no, __subject) \
        if (xmlValidateName((xmlChar *) name, 0) != 0) {        \
-               php_error_docref(NULL, E_WARNING, "%s", __err); \
-               RETURN_FALSE;   \
+               zend_argument_value_error(__arg_no, "must be a valid %s, \"%s\" given", __subject, name);       \
+               RETURN_THROWS();        \
        }       \
 
 /* {{{ function prototypes */
@@ -199,7 +199,7 @@ static void xmlwriter_objects_clone(void *object, void **object_clone)
 }
 }}} */
 
-static void php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAMETERS, xmlwriter_read_one_char_t internal_function, char *err_string)
+static void php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAMETERS, xmlwriter_read_one_char_t internal_function, char *subject_name)
 {
        xmlTextWriterPtr ptr;
        char *name;
@@ -212,8 +212,8 @@ static void php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAMETERS, xmlwriter_rea
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       if (err_string != NULL) {
-               XMLW_NAME_CHK(err_string);
+       if (subject_name != NULL) {
+               XMLW_NAME_CHK(2, subject_name);
        }
 
        if (ptr) {
@@ -281,7 +281,7 @@ PHP_FUNCTION(xmlwriter_set_indent_string)
 /* {{{ Create start attribute - returns FALSE on error */
 PHP_FUNCTION(xmlwriter_start_attribute)
 {
-       php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAM_PASSTHRU, xmlTextWriterStartAttribute, "Invalid Attribute Name");
+       php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAM_PASSTHRU, xmlTextWriterStartAttribute, "attribute name");
 }
 /* }}} */
 
@@ -307,7 +307,7 @@ PHP_FUNCTION(xmlwriter_start_attribute_ns)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid Attribute Name");
+       XMLW_NAME_CHK(3, "attribute name");
 
        if (ptr) {
                retval = xmlTextWriterStartAttributeNS(ptr, (xmlChar *)prefix, (xmlChar *)name, (xmlChar *)uri);
@@ -335,7 +335,7 @@ PHP_FUNCTION(xmlwriter_write_attribute)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid Attribute Name");
+       XMLW_NAME_CHK(2, "attribute name");
 
        if (ptr) {
                retval = xmlTextWriterWriteAttribute(ptr, (xmlChar *)name, (xmlChar *)content);
@@ -363,7 +363,7 @@ PHP_FUNCTION(xmlwriter_write_attribute_ns)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid Attribute Name");
+       XMLW_NAME_CHK(3, "attribute name");
 
        if (ptr) {
                retval = xmlTextWriterWriteAttributeNS(ptr, (xmlChar *)prefix, (xmlChar *)name, (xmlChar *)uri, (xmlChar *)content);
@@ -379,7 +379,7 @@ PHP_FUNCTION(xmlwriter_write_attribute_ns)
 /* {{{ Create start element tag - returns FALSE on error */
 PHP_FUNCTION(xmlwriter_start_element)
 {
-       php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAM_PASSTHRU, xmlTextWriterStartElement, "Invalid Element Name");
+       php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAM_PASSTHRU, xmlTextWriterStartElement, "element name");
 }
 /* }}} */
 
@@ -398,7 +398,7 @@ PHP_FUNCTION(xmlwriter_start_element_ns)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid Element Name");
+       XMLW_NAME_CHK(3, "element name");
 
        if (ptr) {
                retval = xmlTextWriterStartElementNS(ptr, (xmlChar *)prefix, (xmlChar *)name, (xmlChar *)uri);
@@ -441,7 +441,7 @@ PHP_FUNCTION(xmlwriter_write_element)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid Element Name");
+       XMLW_NAME_CHK(2, "element name");
 
        if (ptr) {
                if (!content) {
@@ -480,7 +480,7 @@ PHP_FUNCTION(xmlwriter_write_element_ns)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid Element Name");
+       XMLW_NAME_CHK(3, "element name");
 
        if (ptr) {
                if (!content) {
@@ -507,7 +507,7 @@ PHP_FUNCTION(xmlwriter_write_element_ns)
 /* {{{ Create start PI tag - returns FALSE on error */
 PHP_FUNCTION(xmlwriter_start_pi)
 {
-       php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAM_PASSTHRU, xmlTextWriterStartPI, "Invalid PI Target");
+       php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAM_PASSTHRU, xmlTextWriterStartPI, "PI target");
 }
 /* }}} */
 
@@ -533,7 +533,7 @@ PHP_FUNCTION(xmlwriter_write_pi)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid PI Target");
+       XMLW_NAME_CHK(2, "PI target");
 
        if (ptr) {
                retval = xmlTextWriterWritePI(ptr, (xmlChar *)name, (xmlChar *)content);
@@ -726,7 +726,7 @@ PHP_FUNCTION(xmlwriter_write_dtd)
 /* {{{ Create start DTD element - returns FALSE on error */
 PHP_FUNCTION(xmlwriter_start_dtd_element)
 {
-       php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAM_PASSTHRU, xmlTextWriterStartDTDElement, "Invalid Element Name");
+       php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAM_PASSTHRU, xmlTextWriterStartDTDElement, "element name");
 }
 /* }}} */
 
@@ -752,7 +752,7 @@ PHP_FUNCTION(xmlwriter_write_dtd_element)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid Element Name");
+       XMLW_NAME_CHK(2, "element name");
 
        if (ptr) {
                retval = xmlTextWriterWriteDTDElement(ptr, (xmlChar *)name, (xmlChar *)content);
@@ -768,7 +768,7 @@ PHP_FUNCTION(xmlwriter_write_dtd_element)
 /* {{{ Create start DTD AttList - returns FALSE on error */
 PHP_FUNCTION(xmlwriter_start_dtd_attlist)
 {
-       php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAM_PASSTHRU, xmlTextWriterStartDTDAttlist, "Invalid Element Name");
+       php_xmlwriter_string_arg(INTERNAL_FUNCTION_PARAM_PASSTHRU, xmlTextWriterStartDTDAttlist, "element name");
 }
 /* }}} */
 
@@ -794,7 +794,7 @@ PHP_FUNCTION(xmlwriter_write_dtd_attlist)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid Element Name");
+       XMLW_NAME_CHK(2, "element name");
 
        if (ptr) {
                retval = xmlTextWriterWriteDTDAttlist(ptr, (xmlChar *)name, (xmlChar *)content);
@@ -822,7 +822,7 @@ PHP_FUNCTION(xmlwriter_start_dtd_entity)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid Attribute Name");
+       XMLW_NAME_CHK(2, "attribute name");
 
        if (ptr) {
                retval = xmlTextWriterStartDTDEntity(ptr, isparm, (xmlChar *)name);
@@ -862,7 +862,7 @@ PHP_FUNCTION(xmlwriter_write_dtd_entity)
        }
        XMLWRITER_FROM_OBJECT(ptr, self);
 
-       XMLW_NAME_CHK("Invalid Element Name");
+       XMLW_NAME_CHK(2, "element name");
 
        if (ptr) {
                retval = xmlTextWriterWriteDTDEntity(ptr, pe, (xmlChar *)name, (xmlChar *)pubid, (xmlChar *)sysid, (xmlChar *)ndataid, (xmlChar *)content);

diff --git a/ext/xmlwriter/tests/010.phpt b/ext/xmlwriter/tests/010.phpt
index 2ae160fad83d1151dfae1ffe742a2e29c11b92a5..4c9b099a6801a47335b303fde332fe37b1cfe657 100644 (file)
--- a/ext/xmlwriter/tests/010.phpt
+++ b/ext/xmlwriter/tests/010.phpt
@@ -14,12 +14,27 @@ $xw = xmlwriter_open_uri($file);
 var_dump(xmlwriter_start_element($xw, "tag"));
 var_dump(xmlwriter_start_attribute($xw, "attr"));
 var_dump(xmlwriter_end_attribute($xw));
-var_dump(xmlwriter_start_attribute($xw, "-1"));
+
+try {
+    xmlwriter_start_attribute($xw, "-1");
+} catch (ValueError $e) {
+    echo $e->getMessage(), "\n";
+}
+
 var_dump(xmlwriter_end_attribute($xw));
-var_dump(xmlwriter_start_attribute($xw, "\""));
+
+try {
+    xmlwriter_start_attribute($xw, "\"");
+} catch (ValueError $e) {
+     echo $e->getMessage(), "\n";
+}
+
 var_dump(xmlwriter_end_attribute($xw));
 var_dump(xmlwriter_end_element($xw));
 
+// Force to write and empty the buffer
+xmlwriter_flush($xw, empty: true);
+
 unset($xw);
 
 var_dump(file_get_contents($file));
@@ -32,13 +47,9 @@ echo "Done\n";
 bool(true)
 bool(true)
 bool(true)
-
-Warning: xmlwriter_start_attribute(): Invalid Attribute Name in %s on line %d
-bool(false)
-bool(false)
-
-Warning: xmlwriter_start_attribute(): Invalid Attribute Name in %s on line %d
+xmlwriter_start_attribute(): Argument #2 ($name) must be a valid attribute name, "-1" given
 bool(false)
+xmlwriter_start_attribute(): Argument #2 ($name) must be a valid attribute name, """ given
 bool(false)
 bool(true)
 string(14) "<tag attr=""/>"