This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/master by this push:
new a003a7a Fix BZ 64541 Refactor DTD
a003a7a is described below
commit a003a7ab9086d12ca91f5e7c328daf9e813cbe91
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Mon Jun 29 17:49:36 2020 +0100
Fix BZ 64541 Refactor DTD
Refactoring removes use of entities to avoid errors when XML entity
expansion is disabled
---
.../tomcat/util/modeler/mbeans-descriptors.dtd | 80 +++++++++++-----------
webapps/docs/changelog.xml | 5 ++
2 files changed, 45 insertions(+), 40 deletions(-)
diff --git a/java/org/apache/tomcat/util/modeler/mbeans-descriptors.dtd
b/java/org/apache/tomcat/util/modeler/mbeans-descriptors.dtd
index f12b8fe..28c4d12 100644
--- a/java/org/apache/tomcat/util/modeler/mbeans-descriptors.dtd
+++ b/java/org/apache/tomcat/util/modeler/mbeans-descriptors.dtd
@@ -30,7 +30,9 @@
<!-- ========== Defined Types ============================================= -->
-
+<!-- This DTD has been modified not to use these entities as their use can -->
+<!-- trigger errors when entity expansion is limited or disabled. -->
+<!-- See https://bz.apache.org/bugzilla/show_bug.cgi?id=64541 -->
<!-- A "Boolean" is the string representation of a boolean (true or false)
variable.
@@ -99,16 +101,16 @@
By default, this is set to "true".
-->
<!ELEMENT attribute (descriptor?)>
-<!ATTLIST attribute id ID #IMPLIED>
-<!ATTLIST attribute description CDATA #IMPLIED>
-<!ATTLIST attribute displayName CDATA #IMPLIED>
-<!ATTLIST attribute getMethod %MethodName; #IMPLIED>
-<!ATTLIST attribute is %Boolean; #IMPLIED>
-<!ATTLIST attribute name %VariableName; #IMPLIED>
-<!ATTLIST attribute readable %Boolean; #IMPLIED>
-<!ATTLIST attribute setMethod %MethodName; #IMPLIED>
-<!ATTLIST attribute type %ClassName; #IMPLIED>
-<!ATTLIST attribute writeable %Boolean; #IMPLIED>
+<!ATTLIST attribute id ID #IMPLIED>
+<!ATTLIST attribute description CDATA #IMPLIED>
+<!ATTLIST attribute displayName CDATA #IMPLIED>
+<!ATTLIST attribute getMethod CDATA #IMPLIED> <!--
%MethodName; -->
+<!ATTLIST attribute is (true|false|yes|no) #IMPLIED> <!--
%Boolean; -->
+<!ATTLIST attribute name CDATA #IMPLIED> <!--
%VariableName; -->
+<!ATTLIST attribute readable (true|false|yes|no) #IMPLIED> <!--
%Boolean; -->
+<!ATTLIST attribute setMethod CDATA #IMPLIED> <!--
%MethodName; -->
+<!ATTLIST attribute type CDATA #IMPLIED> <!--
%ClassName; -->
+<!ATTLIST attribute writeable (true|false|yes|no) #IMPLIED> <!--
%Boolean; -->
<!-- The "constructor" element describes a public constructor for the
@@ -122,9 +124,9 @@
be the same as the base class name).
-->
<!ELEMENT constructor (descriptor?, parameter*)>
-<!ATTLIST constructor id ID #IMPLIED>
-<!ATTLIST constructor displayName CDATA #IMPLIED>
-<!ATTLIST constructor name %VariableName; #IMPLIED>
+<!ATTLIST constructor id ID #IMPLIED>
+<!ATTLIST constructor displayName CDATA #IMPLIED>
+<!ATTLIST constructor name CDATA #IMPLIED> <!--
%VariableName; -->
<!-- The "descriptor" element groups a set of descriptor fields whose
@@ -132,7 +134,7 @@
metadata info classes.
-->
<!ELEMENT descriptor (field*)>
-<!ATTLIST descriptor id ID #IMPLIED>
+<!ATTLIST descriptor id ID #IMPLIED>
<!-- The "field" element represents a single name/value pair that will
@@ -145,9 +147,9 @@
(will be stored as a String)
-->
<!ELEMENT field EMPTY>
-<!ATTLIST field id ID #IMPLIED>
-<!ATTLIST field name CDATA #REQUIRED>
-<!ATTLIST field value CDATA #REQUIRED>
+<!ATTLIST field id ID #IMPLIED>
+<!ATTLIST field name CDATA #REQUIRED>
+<!ATTLIST field value CDATA #REQUIRED>
@@ -176,13 +178,13 @@
managed resource implementation class.
-->
<!ELEMENT mbean (descriptor?, attribute*, constructor*, notification*,
operation*)>
-<!ATTLIST mbean id ID #IMPLIED>
-<!ATTLIST mbean className %ClassName; #IMPLIED>
-<!ATTLIST mbean description CDATA #IMPLIED>
-<!ATTLIST mbean domain CDATA #IMPLIED>
-<!ATTLIST mbean group CDATA #IMPLIED>
-<!ATTLIST mbean name %MethodName; #IMPLIED>
-<!ATTLIST mbean type %ClassName; #IMPLIED>
+<!ATTLIST mbean id ID #IMPLIED>
+<!ATTLIST mbean className CDATA #IMPLIED> <!--
%ClassName; -->
+<!ATTLIST mbean description CDATA #IMPLIED>
+<!ATTLIST mbean domain CDATA #IMPLIED>
+<!ATTLIST mbean group CDATA #IMPLIED>
+<!ATTLIST mbean name CDATA #IMPLIED> <!--
%MethodName; -->
+<!ATTLIST mbean type CDATA #IMPLIED> <!--
%ClassName; -->
<!-- The "notification" element describes the notification types that are
@@ -194,16 +196,16 @@
name Name of this set of notification event types.
-->
<!ELEMENT notification (descriptor?, notification-type*)>
-<!ATTLIST notification id ID #IMPLIED>
-<!ATTLIST notification description CDATA #IMPLIED>
-<!ATTLIST notification name %VariableName; #IMPLIED>
+<!ATTLIST notification id ID #IMPLIED>
+<!ATTLIST notification description CDATA #IMPLIED>
+<!ATTLIST notification name CDATA #IMPLIED> <!--
%VariableName; -->
<!-- The nested content of the "notification-type" element is the event string
of an event that can be emitted by this MBean.
-->
<!ELEMENT notification-type (#PCDATA)>
-<!ATTLIST notification-type id ID #IMPLIED>
+<!ATTLIST notification-type id ID #IMPLIED>
<!-- The "operation" element describes a the signature of a public method
@@ -222,11 +224,11 @@
type of this method.
-->
<!ELEMENT operation (descriptor?, parameter*)>
-<!ATTLIST operation id ID #IMPLIED>
-<!ATTLIST operation description CDATA #IMPLIED>
-<!ATTLIST operation impact CDATA #IMPLIED>
-<!ATTLIST operation name %VariableName; #IMPLIED>
-<!ATTLIST operation returnType %ClassName; #IMPLIED>
+<!ATTLIST operation id ID #IMPLIED>
+<!ATTLIST operation description CDATA #IMPLIED>
+<!ATTLIST operation impact CDATA #IMPLIED>
+<!ATTLIST operation name CDATA #IMPLIED> <!--
%VariableName; -->
+<!ATTLIST operation returnType CDATA #IMPLIED> <!--
%ClassName; -->
<!-- The "parameter" element describes a single argument that will be passed
@@ -239,9 +241,7 @@
type Fully qualified Java class name of this parameter.
-->
<!ELEMENT parameter EMPTY>
-<!ATTLIST parameter id ID #IMPLIED>
-<!ATTLIST parameter description CDATA #IMPLIED>
-<!ATTLIST parameter name %VariableName; #IMPLIED>
-<!ATTLIST parameter type %ClassName; #IMPLIED>
-
-
+<!ATTLIST parameter id ID #IMPLIED>
+<!ATTLIST parameter description CDATA #IMPLIED>
+<!ATTLIST parameter name CDATA #IMPLIED> <!--
%VariableName; -->
+<!ATTLIST parameter type CDATA #IMPLIED> <!--
%ClassName; -->
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 46f9def..c95c1ec 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -79,6 +79,11 @@
Add generated classes using Tomcat embedded as an optional replacement
for the Catalina configuration files. (remm)
</add>
+ <fix>
+ <bug>64541</bug>: Refactor the DTD used to validate
+ <code>mbeans-descriptors.xml</code> files to avoid issues when XML
+ entity expansion is limited or disabled. (markt)
+ </fix>
</changelog>
</subsection>
<subsection name="Coyote">
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
