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
|
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* SonarQube is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.profiles;
import org.apache.commons.lang.StringEscapeUtils;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.server.ServerSide;
import org.sonar.api.rules.ActiveRule;
import org.sonar.api.rules.ActiveRuleParam;
import org.sonar.api.utils.SonarException;
import java.io.IOException;
import java.io.Writer;
/**
* @since 2.3
*/
@ServerSide
public class XMLProfileSerializer {
public void write(RulesProfile profile, Writer writer) {
try {
appendHeader(profile, writer);
appendRules(profile, writer);
appendFooter(writer);
} catch (IOException e) {
throw new SonarException("Fail to export the profile " + profile, e);
}
}
private static void appendHeader(RulesProfile profile, Writer writer) throws IOException {
writer.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
+ "<!-- Generated by SonarQube -->"
+ "<profile><name>");
StringEscapeUtils.escapeXml(writer, profile.getName());
writer.append("</name><language>");
StringEscapeUtils.escapeXml(writer, profile.getLanguage());
writer.append("</language>");
}
private static void appendRules(RulesProfile profile, Writer writer) throws IOException {
if (!profile.getActiveRules().isEmpty()) {
writer.append("<rules>");
for (ActiveRule activeRule : profile.getActiveRules()) {
appendRule(activeRule, writer);
}
writer.append("</rules>");
}
}
private static void appendRule(ActiveRule activeRule, Writer writer) throws IOException {
writer.append("<rule><repositoryKey>");
writer.append(activeRule.getRepositoryKey());
writer.append("</repositoryKey><key>");
StringEscapeUtils.escapeXml(writer, activeRule.getRuleKey());
writer.append("</key>");
if (activeRule.getSeverity() != null) {
writer.append("<priority>");
writer.append(activeRule.getSeverity().name());
writer.append("</priority>");
}
appendRuleParameters(activeRule, writer);
writer.append("</rule>");
}
private static void appendRuleParameters(ActiveRule activeRule, Writer writer) throws IOException {
if (activeRule.getActiveRuleParams() != null && !activeRule.getActiveRuleParams().isEmpty()) {
writer.append("<parameters>");
for (ActiveRuleParam activeRuleParam : activeRule.getActiveRuleParams()) {
appendRuleParameter(writer, activeRuleParam);
}
writer.append("</parameters>");
}
}
private static void appendRuleParameter(Writer writer, ActiveRuleParam activeRuleParam) throws IOException {
if (StringUtils.isNotBlank(activeRuleParam.getValue())) {
writer.append("<parameter><key>");
StringEscapeUtils.escapeXml(writer, activeRuleParam.getKey());
writer.append("</key><value>");
StringEscapeUtils.escapeXml(writer, activeRuleParam.getValue());
writer.append("</value>");
writer.append("</parameter>");
}
}
private static void appendFooter(Writer writer) throws IOException {
writer.append("</profile>");
}
}
|
