1 |
|
|
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
12 |
|
|
13 |
|
|
14 |
|
|
15 |
|
|
16 |
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
|
package com.xpn.xwiki.script.display; |
21 |
|
|
22 |
|
import java.lang.reflect.Field; |
23 |
|
import java.util.Collections; |
24 |
|
import java.util.HashMap; |
25 |
|
import java.util.Map; |
26 |
|
|
27 |
|
import javax.inject.Inject; |
28 |
|
import javax.inject.Named; |
29 |
|
import javax.inject.Singleton; |
30 |
|
|
31 |
|
import org.slf4j.Logger; |
32 |
|
import org.xwiki.bridge.DocumentModelBridge; |
33 |
|
import org.xwiki.component.annotation.Component; |
34 |
|
import org.xwiki.component.manager.ComponentManager; |
35 |
|
import org.xwiki.context.Execution; |
36 |
|
import org.xwiki.display.internal.DocumentDisplayer; |
37 |
|
import org.xwiki.display.internal.DocumentDisplayerParameters; |
38 |
|
import org.xwiki.rendering.block.XDOM; |
39 |
|
import org.xwiki.rendering.renderer.BlockRenderer; |
40 |
|
import org.xwiki.rendering.renderer.printer.DefaultWikiPrinter; |
41 |
|
import org.xwiki.rendering.renderer.printer.WikiPrinter; |
42 |
|
import org.xwiki.rendering.syntax.Syntax; |
43 |
|
import org.xwiki.rendering.syntax.SyntaxFactory; |
44 |
|
import org.xwiki.rendering.transformation.RenderingContext; |
45 |
|
import org.xwiki.script.service.ScriptService; |
46 |
|
|
47 |
|
import com.xpn.xwiki.XWikiContext; |
48 |
|
import com.xpn.xwiki.XWikiException; |
49 |
|
import com.xpn.xwiki.api.Document; |
50 |
|
import com.xpn.xwiki.internal.cache.rendering.RenderingCache; |
51 |
|
|
52 |
|
|
53 |
|
@link |
54 |
|
|
55 |
|
@version |
56 |
|
@since |
57 |
|
|
58 |
|
@Component |
59 |
|
@Named("display") |
60 |
|
@Singleton |
|
|
| 72.8% |
Uncovered Elements: 28 (103) |
Complexity: 25 |
Complexity Density: 0.34 |
|
61 |
|
public class DisplayScriptService implements ScriptService |
62 |
|
{ |
63 |
|
|
64 |
|
|
65 |
|
|
66 |
|
private static final String DISPLAYER_PARAMETERS_KEY = "displayerParameters"; |
67 |
|
|
68 |
|
|
69 |
|
@Inject |
70 |
|
private Logger logger; |
71 |
|
|
72 |
|
|
73 |
|
|
74 |
|
|
75 |
|
@Inject |
76 |
|
private ComponentManager componentManager; |
77 |
|
|
78 |
|
|
79 |
|
|
80 |
|
|
81 |
|
@Inject |
82 |
|
private RenderingCache renderingCache; |
83 |
|
|
84 |
|
|
85 |
|
|
86 |
|
|
87 |
|
@Inject |
88 |
|
private Execution execution; |
89 |
|
|
90 |
|
|
91 |
|
|
92 |
|
|
93 |
|
@Inject |
94 |
|
private SyntaxFactory syntaxFactory; |
95 |
|
|
96 |
|
@Inject |
97 |
|
private RenderingContext renderingContext; |
98 |
|
|
|
|
| 78.6% |
Uncovered Elements: 3 (14) |
Complexity: 4 |
Complexity Density: 0.4 |
|
99 |
341 |
private Syntax getOutputSyntax(Map<String, Object> parameters)... |
100 |
|
{ |
101 |
341 |
Syntax outputSyntax = (Syntax) parameters.get("outputSyntax"); |
102 |
341 |
if (outputSyntax == null) { |
103 |
341 |
String outputSyntaxId = (String) parameters.get("outputSyntaxId"); |
104 |
341 |
if (outputSyntaxId != null) { |
105 |
107 |
try { |
106 |
107 |
outputSyntax = this.syntaxFactory.createSyntaxFromIdString(outputSyntaxId); |
107 |
|
} catch (Exception e) { |
108 |
0 |
this.logger.error("Failed to parse output syntax ID [{}].", outputSyntaxId, e); |
109 |
0 |
return null; |
110 |
|
} |
111 |
|
} else { |
112 |
234 |
outputSyntax = renderingContext.getTargetSyntax(); |
113 |
|
} |
114 |
|
} |
115 |
|
|
116 |
341 |
return outputSyntax; |
117 |
|
} |
118 |
|
|
119 |
|
|
120 |
|
|
121 |
|
|
122 |
|
@param |
123 |
|
@param |
124 |
|
@return |
125 |
|
|
|
|
| 68.8% |
Uncovered Elements: 5 (16) |
Complexity: 4 |
Complexity Density: 0.33 |
|
126 |
341 |
private String document(Document document, Map<String, Object> parameters, Syntax outputSyntax)... |
127 |
|
{ |
128 |
341 |
DocumentDisplayerParameters displayerParameters = |
129 |
|
(DocumentDisplayerParameters) parameters.get(DISPLAYER_PARAMETERS_KEY); |
130 |
341 |
if (displayerParameters == null) { |
131 |
0 |
displayerParameters = new DocumentDisplayerParameters(); |
132 |
0 |
displayerParameters.setTargetSyntax(outputSyntax); |
133 |
|
} |
134 |
|
|
135 |
341 |
String displayerHint = (String) parameters.get("displayerHint"); |
136 |
341 |
if (displayerHint == null) { |
137 |
158 |
displayerHint = "configured"; |
138 |
|
} |
139 |
341 |
try { |
140 |
341 |
DocumentDisplayer displayer = this.componentManager.getInstance(DocumentDisplayer.class, displayerHint); |
141 |
341 |
return renderXDOM(displayer.display(getDocument(document), displayerParameters), outputSyntax); |
142 |
|
} catch (Exception e) { |
143 |
0 |
this.logger.error("Failed to display document [{}].", document.getPrefixedFullName(), e); |
144 |
0 |
return null; |
145 |
|
} |
146 |
|
} |
147 |
|
|
148 |
|
|
149 |
|
@return@link |
150 |
|
|
|
|
| 0% |
Uncovered Elements: 1 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
151 |
0 |
public DocumentDisplayerParameters createDocumentDisplayerParameters()... |
152 |
|
{ |
153 |
0 |
return new DocumentDisplayerParameters(); |
154 |
|
} |
155 |
|
|
156 |
|
|
157 |
|
@param |
158 |
|
@return |
159 |
|
@see |
160 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
161 |
158 |
public String content(Document document)... |
162 |
|
{ |
163 |
158 |
return content(document, Collections.<String, Object>emptyMap()); |
164 |
|
} |
165 |
|
|
166 |
|
|
167 |
|
|
168 |
|
|
169 |
|
@param |
170 |
|
@param |
171 |
|
@return |
172 |
|
|
|
|
| 71.9% |
Uncovered Elements: 9 (32) |
Complexity: 6 |
Complexity Density: 0.25 |
|
173 |
158 |
public String content(Document document, Map<String, Object> parameters)... |
174 |
|
{ |
175 |
158 |
XWikiContext context = getXWikiContext(); |
176 |
158 |
String content = null; |
177 |
158 |
try { |
178 |
158 |
content = document.getTranslatedContent(); |
179 |
|
} catch (XWikiException e) { |
180 |
0 |
this.logger.warn("Failed to get the translated content of document [{}].", document.getPrefixedFullName(), |
181 |
|
e); |
182 |
0 |
return null; |
183 |
|
} |
184 |
158 |
String renderedContent = |
185 |
|
this.renderingCache.getRenderedContent(document.getDocumentReference(), content, context); |
186 |
158 |
if (renderedContent == null) { |
187 |
158 |
Map<String, Object> actualParameters = new HashMap<String, Object>(parameters); |
188 |
158 |
DocumentDisplayerParameters displayerParameters = |
189 |
|
(DocumentDisplayerParameters) parameters.get(DISPLAYER_PARAMETERS_KEY); |
190 |
158 |
if (displayerParameters == null) { |
191 |
158 |
displayerParameters = new DocumentDisplayerParameters(); |
192 |
|
|
193 |
158 |
displayerParameters.setExecutionContextIsolated(true); |
194 |
158 |
displayerParameters.setContentTranslated(true); |
195 |
0 |
} else if (displayerParameters.isTitleDisplayed()) { |
196 |
|
|
197 |
0 |
displayerParameters = displayerParameters.clone(); |
198 |
|
} |
199 |
|
|
200 |
158 |
displayerParameters.setTitleDisplayed(false); |
201 |
158 |
Syntax outputSyntax = getOutputSyntax(parameters); |
202 |
158 |
displayerParameters.setTargetSyntax(outputSyntax); |
203 |
158 |
actualParameters.put(DISPLAYER_PARAMETERS_KEY, displayerParameters); |
204 |
158 |
renderedContent = document(document, actualParameters, outputSyntax); |
205 |
158 |
if (renderedContent != null) { |
206 |
158 |
this.renderingCache.setRenderedContent(document.getDocumentReference(), content, renderedContent, |
207 |
|
context); |
208 |
|
} |
209 |
|
} |
210 |
158 |
return renderedContent; |
211 |
|
} |
212 |
|
|
213 |
|
|
214 |
|
|
215 |
|
|
216 |
|
|
217 |
|
|
218 |
|
@param |
219 |
|
@param |
220 |
|
@return |
221 |
|
|
|
|
| 68.8% |
Uncovered Elements: 5 (16) |
Complexity: 3 |
Complexity Density: 0.25 |
|
222 |
183 |
public String title(Document document, Map<String, Object> parameters)... |
223 |
|
{ |
224 |
183 |
Map<String, Object> actualParameters = new HashMap<String, Object>(parameters); |
225 |
183 |
DocumentDisplayerParameters displayerParameters = |
226 |
|
(DocumentDisplayerParameters) parameters.get(DISPLAYER_PARAMETERS_KEY); |
227 |
183 |
if (displayerParameters == null) { |
228 |
183 |
displayerParameters = new DocumentDisplayerParameters(); |
229 |
|
|
230 |
183 |
displayerParameters.setExecutionContextIsolated(true); |
231 |
0 |
} else if (!displayerParameters.isTitleDisplayed()) { |
232 |
|
|
233 |
0 |
displayerParameters = displayerParameters.clone(); |
234 |
|
} |
235 |
|
|
236 |
183 |
displayerParameters.setTitleDisplayed(true); |
237 |
183 |
Syntax outputSyntax = getOutputSyntax(parameters); |
238 |
183 |
displayerParameters.setTargetSyntax(outputSyntax); |
239 |
183 |
actualParameters.put(DISPLAYER_PARAMETERS_KEY, displayerParameters); |
240 |
183 |
return document(document, actualParameters, outputSyntax); |
241 |
|
} |
242 |
|
|
243 |
|
|
244 |
|
@param |
245 |
|
@return |
246 |
|
@see |
247 |
|
|
|
|
| 0% |
Uncovered Elements: 1 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
248 |
0 |
public String title(Document document)... |
249 |
|
{ |
250 |
0 |
return title(document, Collections.<String, Object>emptyMap()); |
251 |
|
} |
252 |
|
|
253 |
|
|
254 |
|
|
255 |
|
|
256 |
|
@param@link |
257 |
|
@return@link |
258 |
|
|
259 |
|
|
|
|
| 80% |
Uncovered Elements: 1 (5) |
Complexity: 2 |
Complexity Density: 0.4 |
|
260 |
341 |
private DocumentModelBridge getDocument(Document document)... |
261 |
|
{ |
262 |
341 |
try { |
263 |
|
|
264 |
|
|
265 |
341 |
Field docField = Document.class.getDeclaredField("doc"); |
266 |
341 |
docField.setAccessible(true); |
267 |
341 |
return (DocumentModelBridge) docField.get(document); |
268 |
|
} catch (Exception e) { |
269 |
0 |
throw new RuntimeException("Failed to access the XWikiDocument instance wrapped by the document API.", e); |
270 |
|
} |
271 |
|
} |
272 |
|
|
273 |
|
|
274 |
|
|
275 |
|
|
276 |
|
@param |
277 |
|
@param |
278 |
|
@return |
279 |
|
@throws |
280 |
|
|
|
|
| 83.3% |
Uncovered Elements: 1 (6) |
Complexity: 2 |
Complexity Density: 0.33 |
|
281 |
341 |
private String renderXDOM(XDOM content, Syntax targetSyntax) throws XWikiException... |
282 |
|
{ |
283 |
341 |
try { |
284 |
341 |
BlockRenderer renderer = this.componentManager.getInstance(BlockRenderer.class, targetSyntax.toIdString()); |
285 |
341 |
WikiPrinter printer = new DefaultWikiPrinter(); |
286 |
341 |
renderer.render(content, printer); |
287 |
341 |
return printer.toString(); |
288 |
|
} catch (Exception e) { |
289 |
0 |
throw new XWikiException(XWikiException.MODULE_XWIKI_RENDERING, XWikiException.ERROR_XWIKI_UNKNOWN, |
290 |
|
"Failed to render XDOM to syntax [" + targetSyntax + "]", e); |
291 |
|
} |
292 |
|
} |
293 |
|
|
294 |
|
|
295 |
|
@return |
296 |
|
@deprecated |
297 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
298 |
158 |
@Deprecated... |
299 |
|
private XWikiContext getXWikiContext() |
300 |
|
{ |
301 |
158 |
return (XWikiContext) this.execution.getContext().getProperty("xwikicontext"); |
302 |
|
} |
303 |
|
} |