/
RuleSetWriter.java
375 lines (327 loc) · 17.2 KB
/
RuleSetWriter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
/**
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
package net.sourceforge.pmd;
import java.io.OutputStream;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.FactoryConfigurationError;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.apache.commons.io.IOUtils;
import org.w3c.dom.CDATASection;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
import net.sourceforge.pmd.lang.Language;
import net.sourceforge.pmd.lang.LanguageVersion;
import net.sourceforge.pmd.lang.rule.ImmutableLanguage;
import net.sourceforge.pmd.lang.rule.RuleReference;
import net.sourceforge.pmd.lang.rule.XPathRule;
import net.sourceforge.pmd.properties.PropertyDescriptor;
import net.sourceforge.pmd.properties.PropertyDescriptorField;
import net.sourceforge.pmd.properties.PropertyTypeId;
/**
* This class represents a way to serialize a RuleSet to an XML configuration
* file.
*/
public class RuleSetWriter {
public static final String RULESET_2_0_0_NS_URI = "http://pmd.sourceforge.net/ruleset/2.0.0";
/**
* @deprecated use {@link #RULESET_2_0_0_NS_URI} instead
*/
@Deprecated // To be removed in PMD 7.0.0
public static final String RULESET_NS_URI = RULESET_2_0_0_NS_URI;
private final OutputStream outputStream;
private Document document;
private Set<String> ruleSetFileNames;
public RuleSetWriter(OutputStream outputStream) {
this.outputStream = outputStream;
}
public void close() {
IOUtils.closeQuietly(outputStream);
}
public void write(RuleSet ruleSet) {
try {
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
document = documentBuilder.newDocument();
ruleSetFileNames = new HashSet<>();
Element ruleSetElement = createRuleSetElement(ruleSet);
document.appendChild(ruleSetElement);
TransformerFactory transformerFactory = TransformerFactory.newInstance();
try {
transformerFactory.setAttribute("indent-number", 3);
} catch (IllegalArgumentException iae) {
// ignore it, specific to one parser
}
Transformer transformer = transformerFactory.newTransformer();
transformer.setOutputProperty(OutputKeys.METHOD, "xml");
// This is as close to pretty printing as we'll get using standard
// Java APIs.
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
transformer.transform(new DOMSource(document), new StreamResult(outputStream));
} catch (DOMException e) {
throw new RuntimeException(e);
} catch (FactoryConfigurationError e) {
throw new RuntimeException(e);
} catch (ParserConfigurationException e) {
throw new RuntimeException(e);
} catch (TransformerException e) {
throw new RuntimeException(e);
}
}
private Element createRuleSetElement(RuleSet ruleSet) {
Element ruleSetElement = document.createElementNS(RULESET_2_0_0_NS_URI, "ruleset");
ruleSetElement.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
ruleSetElement.setAttributeNS("http://www.w3.org/2001/XMLSchema-instance", "xsi:schemaLocation",
RULESET_2_0_0_NS_URI + " http://pmd.sourceforge.net/ruleset_2_0_0.xsd");
ruleSetElement.setAttribute("name", ruleSet.getName());
Element descriptionElement = createDescriptionElement(ruleSet.getDescription());
ruleSetElement.appendChild(descriptionElement);
for (String excludePattern : ruleSet.getExcludePatterns()) {
Element excludePatternElement = createExcludePatternElement(excludePattern);
ruleSetElement.appendChild(excludePatternElement);
}
for (String includePattern : ruleSet.getIncludePatterns()) {
Element includePatternElement = createIncludePatternElement(includePattern);
ruleSetElement.appendChild(includePatternElement);
}
for (Rule rule : ruleSet.getRules()) {
Element ruleElement = createRuleElement(rule);
if (ruleElement != null) {
ruleSetElement.appendChild(ruleElement);
}
}
return ruleSetElement;
}
private Element createDescriptionElement(String description) {
return createTextElement("description", description);
}
private Element createExcludePatternElement(String excludePattern) {
return createTextElement("exclude-pattern", excludePattern);
}
private Element createIncludePatternElement(String includePattern) {
return createTextElement("include-pattern", includePattern);
}
private Element createRuleElement() {
return document.createElementNS(RULESET_2_0_0_NS_URI, "rule");
}
private Element createExcludeElement(String exclude) {
Element element = document.createElementNS(RULESET_2_0_0_NS_URI, "exclude");
element.setAttribute("name", exclude);
return element;
}
private Element createExampleElement(String example) {
return createCDATASectionElement("example", example);
}
private Element createPriorityElement(RulePriority priority) {
return createTextElement("priority", String.valueOf(priority.getPriority()));
}
private Element createPropertiesElement() {
return document.createElementNS(RULESET_2_0_0_NS_URI, "properties");
}
private Element createRuleElement(Rule rule) {
if (rule instanceof RuleReference) {
RuleReference ruleReference = (RuleReference) rule;
RuleSetReference ruleSetReference = ruleReference.getRuleSetReference();
if (ruleSetReference.isAllRules()) {
if (!ruleSetFileNames.contains(ruleSetReference.getRuleSetFileName())) {
ruleSetFileNames.add(ruleSetReference.getRuleSetFileName());
Element ruleSetReferenceElement = createRuleSetReferenceElement(ruleSetReference);
return ruleSetReferenceElement;
} else {
return null;
}
} else {
Language language = ruleReference.getOverriddenLanguage();
LanguageVersion minimumLanguageVersion = ruleReference.getOverriddenMinimumLanguageVersion();
LanguageVersion maximumLanguageVersion = ruleReference.getOverriddenMaximumLanguageVersion();
Boolean deprecated = ruleReference.isOverriddenDeprecated();
String name = ruleReference.getOverriddenName();
String ref = ruleReference.getRuleSetReference().getRuleSetFileName() + "/"
+ ruleReference.getRule().getName();
String message = ruleReference.getOverriddenMessage();
String externalInfoUrl = ruleReference.getOverriddenExternalInfoUrl();
String description = ruleReference.getOverriddenDescription();
RulePriority priority = ruleReference.getOverriddenPriority();
List<PropertyDescriptor<?>> propertyDescriptors = ruleReference.getOverriddenPropertyDescriptors();
Map<PropertyDescriptor<?>, Object> propertiesByPropertyDescriptor = ruleReference
.getOverriddenPropertiesByPropertyDescriptor();
List<String> examples = ruleReference.getOverriddenExamples();
return createSingleRuleElement(language, minimumLanguageVersion, maximumLanguageVersion, deprecated,
name, null, ref, message, externalInfoUrl, null, null, null, null, description, priority,
propertyDescriptors, propertiesByPropertyDescriptor, examples);
}
} else {
return createSingleRuleElement(rule instanceof ImmutableLanguage ? null : rule.getLanguage(),
rule.getMinimumLanguageVersion(), rule.getMaximumLanguageVersion(), rule.isDeprecated(),
rule.getName(), rule.getSince(), null, rule.getMessage(), rule.getExternalInfoUrl(),
rule.getRuleClass(), rule.isDfa(), rule.isTypeResolution(), rule.isMultifile(),
rule.getDescription(),
rule.getPriority(), rule.getPropertyDescriptors(), rule.getPropertiesByPropertyDescriptor(),
rule.getExamples());
}
}
private void setIfNonNull(Object value, Element target, String id) {
if (value != null) {
target.setAttribute(id, value.toString());
}
}
private Element createSingleRuleElement(Language language, LanguageVersion minimumLanguageVersion,
LanguageVersion maximumLanguageVersion, Boolean deprecated, String name, String since, String ref,
String message, String externalInfoUrl, String clazz, Boolean dfa, Boolean typeResolution,
Boolean multifile,
String description, RulePriority priority, List<PropertyDescriptor<?>> propertyDescriptors,
Map<PropertyDescriptor<?>, Object> propertiesByPropertyDescriptor, List<String> examples) {
Element ruleElement = createRuleElement();
if (language != null) {
ruleElement.setAttribute("language", language.getTerseName());
}
if (minimumLanguageVersion != null) {
ruleElement.setAttribute("minimumLanguageVersion", minimumLanguageVersion.getVersion());
}
if (maximumLanguageVersion != null) {
ruleElement.setAttribute("maximumLanguageVersion", maximumLanguageVersion.getVersion());
}
setIfNonNull(deprecated, ruleElement, "deprecated");
setIfNonNull(name, ruleElement, "name");
setIfNonNull(since, ruleElement, "since");
setIfNonNull(ref, ruleElement, "ref");
setIfNonNull(message, ruleElement, "message");
setIfNonNull(clazz, ruleElement, "class");
setIfNonNull(externalInfoUrl, ruleElement, "externalInfoUrl");
setIfNonNull(dfa, ruleElement, "dfa");
setIfNonNull(typeResolution, ruleElement, "typeResolution");
//TODO multifile: setIfNonNull(multifile, ruleElement, "multifile");
if (description != null) {
Element descriptionElement = createDescriptionElement(description);
ruleElement.appendChild(descriptionElement);
}
if (priority != null) {
Element priorityElement = createPriorityElement(priority);
ruleElement.appendChild(priorityElement);
}
Element propertiesElement = createPropertiesElement(propertyDescriptors, propertiesByPropertyDescriptor);
if (propertiesElement != null) {
ruleElement.appendChild(propertiesElement);
}
if (examples != null) {
for (String example : examples) {
Element exampleElement = createExampleElement(example);
ruleElement.appendChild(exampleElement);
}
}
return ruleElement;
}
private Element createRuleSetReferenceElement(RuleSetReference ruleSetReference) {
Element ruleSetReferenceElement = createRuleElement();
ruleSetReferenceElement.setAttribute("ref", ruleSetReference.getRuleSetFileName());
for (String exclude : ruleSetReference.getExcludes()) {
Element excludeElement = createExcludeElement(exclude);
ruleSetReferenceElement.appendChild(excludeElement);
}
return ruleSetReferenceElement;
}
@SuppressWarnings("PMD.CompareObjectsWithEquals")
private Element createPropertiesElement(List<PropertyDescriptor<?>> propertyDescriptors,
Map<PropertyDescriptor<?>, Object> propertiesByPropertyDescriptor) {
Element propertiesElement = null;
if (propertyDescriptors != null) {
for (PropertyDescriptor<?> propertyDescriptor : propertyDescriptors) {
// For each provided PropertyDescriptor
if (propertyDescriptor.isDefinedExternally()) {
// Any externally defined property needs to go out as a definition.
if (propertiesElement == null) {
propertiesElement = createPropertiesElement();
}
Element propertyElement = createPropertyDefinitionElementBR(propertyDescriptor);
propertiesElement.appendChild(propertyElement);
} else {
if (propertiesByPropertyDescriptor != null) {
// Otherwise, any property which has a value different than the default needs to go out as a value.
Object defaultValue = propertyDescriptor.defaultValue();
Object value = propertiesByPropertyDescriptor.get(propertyDescriptor);
if (value != defaultValue && (value == null || !value.equals(defaultValue))) {
if (propertiesElement == null) {
propertiesElement = createPropertiesElement();
}
Element propertyElement = createPropertyValueElement(propertyDescriptor, value);
propertiesElement.appendChild(propertyElement);
}
}
}
}
}
if (propertiesByPropertyDescriptor != null) {
// Then, for each PropertyDescriptor not explicitly provided
for (Map.Entry<PropertyDescriptor<?>, Object> entry : propertiesByPropertyDescriptor.entrySet()) {
// If not explicitly given...
PropertyDescriptor<?> propertyDescriptor = entry.getKey();
if (!propertyDescriptors.contains(propertyDescriptor)) {
// Otherwise, any property which has a value different than
// the
// default needs to go out as a value.
Object defaultValue = propertyDescriptor.defaultValue();
Object value = entry.getValue();
if (value != defaultValue && (value == null || !value.equals(defaultValue))) {
if (propertiesElement == null) {
propertiesElement = createPropertiesElement();
}
Element propertyElement = createPropertyValueElement(propertyDescriptor, value);
propertiesElement.appendChild(propertyElement);
}
}
}
}
return propertiesElement;
}
private Element createPropertyValueElement(PropertyDescriptor propertyDescriptor, Object value) {
Element propertyElement = document.createElementNS(RULESET_2_0_0_NS_URI, "property");
propertyElement.setAttribute("name", propertyDescriptor.name());
String valueString = propertyDescriptor.asDelimitedString(value);
if (XPathRule.XPATH_DESCRIPTOR.equals(propertyDescriptor)) {
Element valueElement = createCDATASectionElement("value", valueString);
propertyElement.appendChild(valueElement);
} else {
propertyElement.setAttribute("value", valueString);
}
return propertyElement;
}
private Element createPropertyDefinitionElementBR(PropertyDescriptor<?> propertyDescriptor) {
final Element propertyElement = createPropertyValueElement(propertyDescriptor,
propertyDescriptor.defaultValue());
propertyElement.setAttribute(PropertyDescriptorField.TYPE.attributeName(),
PropertyTypeId.typeIdFor(propertyDescriptor.type(),
propertyDescriptor.isMultiValue()));
Map<PropertyDescriptorField, String> propertyValuesById = propertyDescriptor.attributeValuesById();
for (Map.Entry<PropertyDescriptorField, String> entry : propertyValuesById.entrySet()) {
propertyElement.setAttribute(entry.getKey().attributeName(), entry.getValue());
}
return propertyElement;
}
private Element createTextElement(String name, String value) {
Element element = document.createElementNS(RULESET_2_0_0_NS_URI, name);
Text text = document.createTextNode(value);
element.appendChild(text);
return element;
}
private Element createCDATASectionElement(String name, String value) {
Element element = document.createElementNS(RULESET_2_0_0_NS_URI, name);
CDATASection cdataSection = document.createCDATASection(value);
element.appendChild(cdataSection);
return element;
}
}