Skip to content

Commit da390a6

Browse files
angelozerrangelozerr
committed
Separate instructions for testing well formed XML files and validation
against DTD See redhat-developer/vscode-xml#947 Signed-off-by: azerr <[email protected]>
1 parent def27a7 commit da390a6

File tree

9 files changed

+187
-16
lines changed

9 files changed

+187
-16
lines changed

‎org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/XMLLanguageServer.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -338,8 +338,9 @@ public Collection<DOMDocument> getAllDocuments() {
338338
}
339339

340340
@Override
341-
public void validate(DOMDocument document, Map<String, Object> validationArgs) {
342-
xmlTextDocumentService.validate(document, validationArgs);
341+
public void validate(DOMDocument document, Map<String, Object> validationArgs,
342+
XMLValidationRootSettings validationSettings) {
343+
xmlTextDocumentService.validate(document, validationArgs, validationSettings);
343344
}
344345

345346
public XMLCapabilityManager getCapabilityManager() {

‎org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/XMLTextDocumentService.java

+10-7
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ public XMLTextDocumentService(XMLLanguageServer xmlLanguageServer) {
204204
this.limitExceededWarner = null;
205205
this.xmlValidatorDelayer = new ModelValidatorDelayer<DOMDocument>((document) -> {
206206
DOMDocument xmlDocument = document.getModel();
207-
validate(xmlDocument, Collections.emptyMap());
207+
validate(xmlDocument, Collections.emptyMap(), null);
208208

209209
getXMLLanguageService().getDocumentLifecycleParticipants().forEach(participant -> {
210210
try {
@@ -653,7 +653,7 @@ private void triggerValidationFor(Collection<ModelTextDocument<DOMDocument>> doc
653653
xmlLanguageServer.schedule(() -> {
654654
documents.forEach(document -> {
655655
try {
656-
validate(document.getModel(), Collections.emptyMap());
656+
validate(document.getModel(), Collections.emptyMap(), null);
657657
} catch (CancellationException e) {
658658
// Ignore the error and continue to validate other documents
659659
}
@@ -692,7 +692,7 @@ void validate(TextDocument document, boolean withDelay) throws CancellationExcep
692692
} else {
693693
CompletableFuture.runAsync(() -> {
694694
DOMDocument xmlDocument = ((ModelTextDocument<DOMDocument>) document).getModel();
695-
validate(xmlDocument, Collections.emptyMap());
695+
validate(xmlDocument, Collections.emptyMap(), null);
696696
getXMLLanguageService().getDocumentLifecycleParticipants().forEach(participant -> {
697697
try {
698698
participant.didOpen(xmlDocument);
@@ -708,19 +708,22 @@ void validate(TextDocument document, boolean withDelay) throws CancellationExcep
708708
/**
709709
* Validate and publish diagnostics for the given DOM document.
710710
*
711-
* @param xmlDocument the DOM document.
712-
* @param validationArgs the validation arguments.
711+
* @param xmlDocument the DOM document.
712+
* @param validationArgs the validation arguments.
713+
* @param validationSettings
713714
*
714715
* @throws CancellationException when the DOM document content changed and
715716
* diagnostics must be stopped.
716717
*/
717-
void validate(DOMDocument xmlDocument, Map<String, Object> validationArgs) throws CancellationException {
718+
void validate(DOMDocument xmlDocument, Map<String, Object> validationArgs,
719+
XMLValidationRootSettings validationSettings)
720+
throws CancellationException {
718721
CancelChecker cancelChecker = xmlDocument.getCancelChecker();
719722
cancelChecker.checkCanceled();
720723
getXMLLanguageService().publishDiagnostics(xmlDocument,
721724
params -> xmlLanguageServer.getLanguageClient().publishDiagnostics(params),
722725
(doc) -> triggerValidationFor(doc, TriggeredBy.Other),
723-
sharedSettings.getValidationSettings(),
726+
validationSettings != null ? validationSettings : sharedSettings.getValidationSettings(),
724727
validationArgs, cancelChecker);
725728
}
726729

‎org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/commands/XMLValidationFileCommand.java

+13-2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
import org.eclipse.lemminx.dom.DOMDocument;
1717
import org.eclipse.lemminx.extensions.contentmodel.model.ContentModelManager;
18+
import org.eclipse.lemminx.extensions.contentmodel.settings.XMLValidationRootSettings;
1819
import org.eclipse.lemminx.services.IXMLDocumentProvider;
1920
import org.eclipse.lemminx.services.IXMLValidationService;
2021
import org.eclipse.lemminx.services.extensions.commands.AbstractDOMDocumentCommandHandler;
@@ -59,15 +60,25 @@ protected Object executeCommand(DOMDocument document, ExecuteCommandParams param
5960
CancelChecker cancelChecker) throws Exception {
6061
// Validation args can contains the external resource ('url' as key map) to
6162
// force do download.
62-
JsonObject validationArgs = params.getArguments().size() > 1 ? (JsonObject) params.getArguments().get(1) : null;
63+
JsonObject validationArgs = getJsonObject(params, 1);
64+
JsonObject validationSettings = getJsonObject(params, 2);
6365
// 1. remove the referenced grammar in the XML file from the Xerces grammar pool
6466
// (used by the Xerces validation) and the content model documents cache (used
6567
// by the XML completion/hover based on the grammar)
6668
contentModelManager.evictCacheFor(document);
6769
// 2. trigger the validation for the given XML file
6870
Map map = JSONUtility.toModel(validationArgs, Map.class);
69-
validationService.validate(document, map);
71+
XMLValidationRootSettings settings = JSONUtility.toModel(validationSettings, XMLValidationRootSettings.class);
72+
validationService.validate(document, map, settings);
7073
return null;
7174
}
7275

76+
private static JsonObject getJsonObject(ExecuteCommandParams params, int index) {
77+
if (params.getArguments().size() <= index) {
78+
return null;
79+
}
80+
Object result = params.getArguments().get(index);
81+
return result instanceof JsonObject ? (JsonObject) result : null;
82+
}
83+
7384
}

‎org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/participants/diagnostics/XMLValidator.java

+38-3
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,10 @@
3535
import org.eclipse.lemminx.dom.XMLModel;
3636
import org.eclipse.lemminx.extensions.contentmodel.model.ContentModelManager;
3737
import org.eclipse.lemminx.extensions.contentmodel.participants.XMLSyntaxErrorCode;
38+
import org.eclipse.lemminx.extensions.contentmodel.settings.DTDEnabled;
3839
import org.eclipse.lemminx.extensions.contentmodel.settings.NamespacesEnabled;
3940
import org.eclipse.lemminx.extensions.contentmodel.settings.SchemaEnabled;
41+
import org.eclipse.lemminx.extensions.contentmodel.settings.XMLDTDSettings;
4042
import org.eclipse.lemminx.extensions.contentmodel.settings.XMLNamespacesSettings;
4143
import org.eclipse.lemminx.extensions.contentmodel.settings.XMLSchemaSettings;
4244
import org.eclipse.lemminx.extensions.contentmodel.settings.XMLValidationSettings;
@@ -86,8 +88,10 @@ public static void doDiagnostics(DOMDocument document, XMLEntityResolver entityR
8688
LSPXMLEntityManager entityManager = new LSPXMLEntityManager(reporterForXML, grammarPool);
8789
try {
8890

91+
boolean dtdValidationEnabled = !isDisableOnlyDTDValidation(document, validationSettings);
8992
LSPXMLParserConfiguration configuration = new LSPXMLParserConfiguration(grammarPool,
90-
isDisableOnlyDTDValidation(document), reporterForXML, reporterForGrammar, entityManager,
93+
!dtdValidationEnabled, reporterForXML, reporterForGrammar,
94+
entityManager,
9195
validationSettings);
9296

9397
if (entityResolver != null) {
@@ -119,6 +123,8 @@ && isSchemaValidationEnabled(document, validationSettings)
119123
|| (!hasRelaxNG && document.hasExternalGrammar());
120124
if (hasSchemaGrammar && !schemaValidationEnabled) {
121125
hasGrammar = false;
126+
} else if (document.hasDTD() && !dtdValidationEnabled) {
127+
hasGrammar = false;
122128
}
123129
parser.setFeature("http://xml.org/sax/features/validation", hasGrammar); //$NON-NLS-1$
124130

@@ -324,7 +330,7 @@ private static boolean hasExternalSchemaGrammar(DOMDocument document) {
324330
* @param document the DOM document
325331
* @return true is DTD validation must be disabled and false otherwise.
326332
*/
327-
private static boolean isDisableOnlyDTDValidation(DOMDocument document) {
333+
private static boolean isDisableOnlyDTDValidation(DOMDocument document, XMLValidationSettings validationSettings) {
328334
Map<String, String> externalGrammarLocation = document.getExternalGrammarLocation();
329335
if (externalGrammarLocation != null
330336
&& externalGrammarLocation.containsKey(IExternalGrammarLocationProvider.DOCTYPE)) {
@@ -343,12 +349,41 @@ private static boolean isDisableOnlyDTDValidation(DOMDocument document) {
343349
}
344350
DOMDocumentType docType = document.getDoctype();
345351
if (docType.getKindNode() != null) {
346-
return false;
352+
return !isDTDValidationEnabled(document, validationSettings);
347353
}
348354
// Disable the DTD validation only if there are not <!ELEMENT or an <!ATTRLIST
349355
return !docType.getChildren().stream().anyMatch(node -> node.isDTDElementDecl() || node.isDTDAttListDecl());
350356
}
351357

358+
private static boolean isValidDTDLocation(DOMDocument document) {
359+
DOMDocumentType docType = document.getDoctype();
360+
if (docType == null) {
361+
return false;
362+
}
363+
return isValidLocation(document.getDocumentURI(), docType.getPublicId());
364+
}
365+
366+
private static boolean isDTDValidationEnabled(DOMDocument document, XMLValidationSettings validationSettings) {
367+
if (validationSettings == null) {
368+
return true;
369+
}
370+
DTDEnabled enabled = DTDEnabled.always;
371+
XMLDTDSettings dtdSettings = validationSettings.getDtd();
372+
if (dtdSettings != null && dtdSettings.getEnabled() != null) {
373+
enabled = dtdSettings.getEnabled();
374+
}
375+
switch (enabled) {
376+
case always:
377+
return true;
378+
case never:
379+
return false;
380+
case onValidDTD:
381+
return isValidDTDLocation(document);
382+
default:
383+
return true;
384+
}
385+
}
386+
352387
/**
353388
* Warn if XML document is not bound to a grammar according the settings
354389
*

‎org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/settings/DTDEnabled.java

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/**
2+
* Copyright (c) 2023 Red Hat Inc. and others.
3+
* All rights reserved. This program and the accompanying materials
4+
* are made available under the terms of the Eclipse Public License v2.0
5+
* which accompanies this distribution, and is available at
6+
* http://www.eclipse.org/legal/epl-v20.html
7+
*
8+
* SPDX-License-Identifier: EPL-2.0
9+
*
10+
* Contributors:
11+
* Red Hat Inc. - initial API and implementation
12+
*/
13+
package org.eclipse.lemminx.extensions.contentmodel.settings;
14+
15+
public enum DTDEnabled {
16+
always, never, onValidDTD;
17+
}

‎org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/settings/XMLDTDSettings.java

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/**
2+
* Copyright (c) 2023 Red Hat Inc. and others.
3+
* All rights reserved. This program and the accompanying materials
4+
* are made available under the terms of the Eclipse Public License v2.0
5+
* which accompanies this distribution, and is available at
6+
* http://www.eclipse.org/legal/epl-v20.html
7+
*
8+
* SPDX-License-Identifier: EPL-2.0
9+
*
10+
* Contributors:
11+
* Red Hat Inc. - initial API and implementation
12+
*/
13+
package org.eclipse.lemminx.extensions.contentmodel.settings;
14+
15+
/**
16+
* XML DTD settings.
17+
*
18+
*/
19+
public class XMLDTDSettings {
20+
21+
public XMLDTDSettings() {
22+
setEnabled(DTDEnabled.always);
23+
}
24+
25+
private DTDEnabled enabled;
26+
27+
public void setEnabled(DTDEnabled enabled) {
28+
this.enabled = enabled;
29+
}
30+
31+
@Override
32+
public int hashCode() {
33+
final int prime = 31;
34+
int result = 1;
35+
result = prime * result + ((enabled == null) ? 0 : enabled.hashCode());
36+
return result;
37+
}
38+
39+
@Override
40+
public boolean equals(Object obj) {
41+
if (this == obj) {
42+
return true;
43+
}
44+
if (obj == null) {
45+
return false;
46+
}
47+
if (getClass() != obj.getClass()) {
48+
return false;
49+
}
50+
XMLDTDSettings other = (XMLDTDSettings) obj;
51+
if (enabled != other.enabled) {
52+
return false;
53+
}
54+
return true;
55+
}
56+
57+
public DTDEnabled getEnabled() {
58+
return enabled;
59+
}
60+
}

‎org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/settings/XMLValidationSettings.java

+30
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ public class XMLValidationSettings {
2626
private XMLNamespacesSettings namespaces;
2727

2828
private XMLSchemaSettings schema;
29+
30+
private XMLDTDSettings dtd;
2931

3032
private boolean disallowDocTypeDecl;
3133

@@ -50,6 +52,7 @@ public XMLValidationSettings() {
5052
setResolveExternalEntities(false);
5153
setNamespaces(new XMLNamespacesSettings());
5254
setSchema(new XMLSchemaSettings());
55+
setDtd(new XMLDTDSettings());
5356
setXInclude(new XMLXIncludeSettings());
5457
}
5558

@@ -107,6 +110,24 @@ public void setSchema(XMLSchemaSettings schema) {
107110
this.schema = schema;
108111
}
109112

113+
/**
114+
* Returns the XML DTD validation settings.
115+
*
116+
* @return the XML DTD validation settings.
117+
*/
118+
public XMLDTDSettings getDtd() {
119+
return dtd;
120+
}
121+
122+
/**
123+
* Set the XML DTD validation settings.
124+
*
125+
* @param schema the XML DTD validation settings.
126+
*/
127+
public void setDtd(XMLDTDSettings dtd) {
128+
this.dtd = dtd;
129+
}
130+
110131
public void setNoGrammar(String noGrammar) {
111132
this.noGrammar = noGrammar;
112133
}
@@ -203,6 +224,7 @@ public XMLValidationSettings merge(XMLValidationSettings settings) {
203224
if (settings != null) {
204225
this.namespaces = settings.namespaces;
205226
this.schema = settings.schema;
227+
this.dtd = settings.dtd;
206228
this.enabled = settings.enabled;
207229
this.noGrammar = settings.noGrammar;
208230
this.disallowDocTypeDecl = settings.disallowDocTypeDecl;
@@ -231,6 +253,7 @@ public int hashCode() {
231253
result = prime * result + ((noGrammar == null) ? 0 : noGrammar.hashCode());
232254
result = prime * result + (resolveExternalEntities ? 1231 : 1237);
233255
result = prime * result + ((schema == null) ? 0 : schema.hashCode());
256+
result = prime * result + ((dtd == null) ? 0 : dtd.hashCode());
234257
result = prime * result + ((xInclude == null) ? 0 : xInclude.hashCode());
235258
return result;
236259
}
@@ -288,6 +311,13 @@ public boolean equals(Object obj) {
288311
} else if (!schema.equals(other.schema)) {
289312
return false;
290313
}
314+
if (dtd == null) {
315+
if (other.dtd != null) {
316+
return false;
317+
}
318+
} else if (!dtd.equals(other.dtd)) {
319+
return false;
320+
}
291321
return true;
292322
}
293323

‎org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/services/IXMLValidationService.java

+4-2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
import java.util.Map;
1717

1818
import org.eclipse.lemminx.dom.DOMDocument;
19+
import org.eclipse.lemminx.extensions.contentmodel.settings.XMLValidationRootSettings;
1920

2021
/**
2122
* XML Document validation service available to XML LS extensions
@@ -31,15 +32,16 @@ public interface IXMLValidationService {
3132
* @param document the XML document
3233
* @param validationArgs validation arguments.
3334
*/
34-
void validate(DOMDocument document, Map<String, Object> validationArgs);
35+
void validate(DOMDocument document, Map<String, Object> validationArgs,
36+
XMLValidationRootSettings validationSettings);
3537

3638
/**
3739
* Performs XML document validation
3840
*
3941
* @param document the XML document
4042
*/
4143
default void validate(DOMDocument document) {
42-
validate(document, Collections.emptyMap());
44+
validate(document, Collections.emptyMap(), null);
4345
}
4446

4547
}

‎org.eclipse.lemminx/src/main/resources/META-INF/native-image/reflect-config.json

+12
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,18 @@
409409
"name": "org.eclipse.lemminx.extensions.contentmodel.settings.SchemaEnabled",
410410
"allDeclaredFields": true
411411
},
412+
{
413+
"name": "org.eclipse.lemminx.extensions.contentmodel.settings.XMLDTDSettings",
414+
"allDeclaredFields": true,
415+
"methods": [{
416+
"name": "<init>",
417+
"parameterTypes": []
418+
}]
419+
},
420+
{
421+
"name": "org.eclipse.lemminx.extensions.contentmodel.settings.DTDEnabled",
422+
"allDeclaredFields": true
423+
},
412424
{
413425
"name": "org.eclipse.lemminx.settings.XMLSymbolExpressionFilter",
414426
"allDeclaredFields": true,

0 commit comments

Comments
 (0)