1 |
|
|
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
12 |
|
|
13 |
|
|
14 |
|
|
15 |
|
|
16 |
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
|
package org.xwiki.xml.internal.html; |
21 |
|
|
22 |
|
import java.io.Reader; |
23 |
|
import java.io.StringReader; |
24 |
|
import java.util.Arrays; |
25 |
|
|
26 |
|
import javax.inject.Inject; |
27 |
|
import javax.inject.Named; |
28 |
|
import javax.inject.Singleton; |
29 |
|
import javax.xml.parsers.DocumentBuilderFactory; |
30 |
|
import javax.xml.parsers.ParserConfigurationException; |
31 |
|
|
32 |
|
import org.htmlcleaner.CleanerProperties; |
33 |
|
import org.htmlcleaner.CleanerTransformations; |
34 |
|
import org.htmlcleaner.HtmlCleaner; |
35 |
|
import org.htmlcleaner.TagNode; |
36 |
|
import org.htmlcleaner.TagTransformation; |
37 |
|
import org.w3c.dom.DOMImplementation; |
38 |
|
import org.w3c.dom.Document; |
39 |
|
import org.w3c.dom.DocumentType; |
40 |
|
import org.xwiki.component.annotation.Component; |
41 |
|
import org.xwiki.component.phase.Initializable; |
42 |
|
import org.xwiki.component.phase.InitializationException; |
43 |
|
import org.xwiki.xml.html.HTMLCleaner; |
44 |
|
import org.xwiki.xml.html.HTMLCleanerConfiguration; |
45 |
|
import org.xwiki.xml.html.HTMLConstants; |
46 |
|
import org.xwiki.xml.html.filter.HTMLFilter; |
47 |
|
|
48 |
|
|
49 |
|
@link |
50 |
|
|
51 |
|
|
52 |
|
@version |
53 |
|
@since |
54 |
|
|
55 |
|
@Component |
56 |
|
@Singleton |
|
|
| 94.4% |
Uncovered Elements: 3 (54) |
Complexity: 9 |
Complexity Density: 0.2 |
|
57 |
|
public class DefaultHTMLCleaner implements HTMLCleaner, Initializable |
58 |
|
{ |
59 |
|
|
60 |
|
@link |
61 |
|
|
62 |
|
private static final String QUALIFIED_NAME_HTML = "html"; |
63 |
|
|
64 |
|
|
65 |
|
@link |
66 |
|
|
67 |
|
@Inject |
68 |
|
@Named("list") |
69 |
|
private HTMLFilter listFilter; |
70 |
|
|
71 |
|
|
72 |
|
@link |
73 |
|
|
74 |
|
@Inject |
75 |
|
@Named("listitem") |
76 |
|
private HTMLFilter listItemFilter; |
77 |
|
|
78 |
|
|
79 |
|
@link |
80 |
|
|
81 |
|
@Inject |
82 |
|
@Named("font") |
83 |
|
private HTMLFilter fontFilter; |
84 |
|
|
85 |
|
|
86 |
|
@link |
87 |
|
|
88 |
|
@Inject |
89 |
|
@Named("body") |
90 |
|
private HTMLFilter bodyFilter; |
91 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
92 |
10
|
@Override... |
93 |
|
public void initialize() throws InitializationException |
94 |
|
{ |
95 |
|
|
96 |
|
|
97 |
|
|
98 |
|
|
99 |
|
|
100 |
|
|
101 |
|
|
102 |
|
|
103 |
|
|
104 |
|
|
105 |
|
|
106 |
10
|
clean(new StringReader("")); |
107 |
|
} |
108 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
109 |
52
|
@Override... |
110 |
|
public Document clean(Reader originalHtmlContent) |
111 |
|
{ |
112 |
52
|
return clean(originalHtmlContent, getDefaultConfiguration()); |
113 |
|
} |
114 |
|
|
|
|
| 88.9% |
Uncovered Elements: 2 (18) |
Complexity: 3 |
Complexity Density: 0.17 |
|
115 |
53
|
@Override... |
116 |
|
public Document clean(Reader originalHtmlContent, HTMLCleanerConfiguration configuration) |
117 |
|
{ |
118 |
53
|
Document result; |
119 |
|
|
120 |
|
|
121 |
|
|
122 |
|
|
123 |
53
|
CleanerProperties cleanerProperties = getDefaultCleanerProperties(configuration); |
124 |
53
|
HtmlCleaner cleaner = new HtmlCleaner(cleanerProperties); |
125 |
|
|
126 |
53
|
cleaner.setTransformations(getDefaultCleanerTransformations()); |
127 |
53
|
TagNode cleanedNode; |
128 |
53
|
try { |
129 |
53
|
cleanedNode = cleaner.clean(originalHtmlContent); |
130 |
|
} catch (Exception e) { |
131 |
|
|
132 |
|
|
133 |
0
|
throw new RuntimeException("Unhandled error when cleaning HTML", e); |
134 |
|
} |
135 |
|
|
136 |
|
|
137 |
|
|
138 |
|
|
139 |
|
|
140 |
|
|
141 |
|
|
142 |
|
|
143 |
|
|
144 |
|
|
145 |
|
|
146 |
53
|
try { |
147 |
|
|
148 |
|
|
149 |
|
|
150 |
|
|
151 |
|
|
152 |
53
|
Document tempDoc = new XWikiDOMSerializer(cleanerProperties, false).createDOM(cleanedNode); |
153 |
53
|
DOMImplementation domImpl = |
154 |
|
DocumentBuilderFactory.newInstance().newDocumentBuilder().getDOMImplementation(); |
155 |
53
|
DocumentType docType = domImpl.createDocumentType(QUALIFIED_NAME_HTML, "-//W3C//DTD XHTML 1.0 Strict//EN", |
156 |
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"); |
157 |
53
|
result = domImpl.createDocument(null, QUALIFIED_NAME_HTML, docType); |
158 |
53
|
result.replaceChild(result.adoptNode(tempDoc.getDocumentElement()), result.getDocumentElement()); |
159 |
|
} catch (ParserConfigurationException ex) { |
160 |
0
|
throw new RuntimeException("Error while serializing TagNode into w3c dom.", ex); |
161 |
|
} |
162 |
|
|
163 |
|
|
164 |
53
|
for (HTMLFilter filter : configuration.getFilters()) { |
165 |
208
|
filter.filter(result, configuration.getParameters()); |
166 |
|
} |
167 |
|
|
168 |
53
|
return result; |
169 |
|
} |
170 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (3) |
Complexity: 1 |
Complexity Density: 0.33 |
|
171 |
53
|
@Override... |
172 |
|
public HTMLCleanerConfiguration getDefaultConfiguration() |
173 |
|
{ |
174 |
53
|
HTMLCleanerConfiguration configuration = new DefaultHTMLCleanerConfiguration(); |
175 |
53
|
configuration.setFilters(Arrays.asList( |
176 |
|
this.bodyFilter, |
177 |
|
this.listItemFilter, |
178 |
|
this.listFilter, |
179 |
|
this.fontFilter)); |
180 |
53
|
return configuration; |
181 |
|
} |
182 |
|
|
183 |
|
|
184 |
|
@param |
185 |
|
@return@link |
186 |
|
|
|
|
| 90% |
Uncovered Elements: 1 (10) |
Complexity: 2 |
Complexity Density: 0.25 |
|
187 |
53
|
private CleanerProperties getDefaultCleanerProperties(HTMLCleanerConfiguration configuration)... |
188 |
|
{ |
189 |
53
|
CleanerProperties defaultProperties = new CleanerProperties(); |
190 |
53
|
defaultProperties.setOmitUnknownTags(true); |
191 |
|
|
192 |
|
|
193 |
|
|
194 |
|
|
195 |
53
|
defaultProperties.setUseEmptyElementTags(false); |
196 |
|
|
197 |
|
|
198 |
53
|
defaultProperties.setUseCdataForScriptAndStyle(true); |
199 |
|
|
200 |
|
|
201 |
53
|
String param = configuration.getParameters().get(HTMLCleanerConfiguration.NAMESPACES_AWARE); |
202 |
53
|
boolean namespacesAware = (param != null) ? Boolean.parseBoolean(param) : true; |
203 |
53
|
defaultProperties.setNamespacesAware(namespacesAware); |
204 |
|
|
205 |
53
|
return defaultProperties; |
206 |
|
} |
207 |
|
|
208 |
|
|
209 |
|
@return |
210 |
|
|
211 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (15) |
Complexity: 1 |
Complexity Density: 0.07 |
|
212 |
53
|
private CleanerTransformations getDefaultCleanerTransformations()... |
213 |
|
{ |
214 |
53
|
CleanerTransformations defaultTransformations = new CleanerTransformations(); |
215 |
|
|
216 |
53
|
TagTransformation tt = new TagTransformation(HTMLConstants.TAG_B, HTMLConstants.TAG_STRONG, false); |
217 |
53
|
defaultTransformations.addTransformation(tt); |
218 |
|
|
219 |
53
|
tt = new TagTransformation(HTMLConstants.TAG_I, HTMLConstants.TAG_EM, false); |
220 |
53
|
defaultTransformations.addTransformation(tt); |
221 |
|
|
222 |
53
|
tt = new TagTransformation(HTMLConstants.TAG_U, HTMLConstants.TAG_INS, false); |
223 |
53
|
defaultTransformations.addTransformation(tt); |
224 |
|
|
225 |
53
|
tt = new TagTransformation(HTMLConstants.TAG_S, HTMLConstants.TAG_DEL, false); |
226 |
53
|
defaultTransformations.addTransformation(tt); |
227 |
|
|
228 |
53
|
tt = new TagTransformation(HTMLConstants.TAG_STRIKE, HTMLConstants.TAG_DEL, false); |
229 |
53
|
defaultTransformations.addTransformation(tt); |
230 |
|
|
231 |
53
|
tt = new TagTransformation(HTMLConstants.TAG_CENTER, HTMLConstants.TAG_P, false); |
232 |
53
|
tt.addAttributeTransformation(HTMLConstants.ATTRIBUTE_STYLE, "text-align:center"); |
233 |
53
|
defaultTransformations.addTransformation(tt); |
234 |
|
|
235 |
53
|
return defaultTransformations; |
236 |
|
} |
237 |
|
} |