1 |
|
|
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
12 |
|
|
13 |
|
|
14 |
|
|
15 |
|
|
16 |
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
|
package org.xwiki.watchlist.internal.api; |
21 |
|
|
22 |
|
import java.util.ArrayList; |
23 |
|
import java.util.Date; |
24 |
|
import java.util.List; |
25 |
|
|
26 |
|
import javax.inject.Provider; |
27 |
|
|
28 |
|
import org.apache.commons.lang3.StringUtils; |
29 |
|
import org.xwiki.model.EntityType; |
30 |
|
import org.xwiki.model.reference.DocumentReference; |
31 |
|
import org.xwiki.model.reference.EntityReferenceProvider; |
32 |
|
import org.xwiki.model.reference.EntityReferenceSerializer; |
33 |
|
import org.xwiki.model.reference.SpaceReference; |
34 |
|
import org.xwiki.watchlist.internal.WatchListEventHTMLDiffExtractor; |
35 |
|
|
36 |
|
import com.xpn.xwiki.XWikiContext; |
37 |
|
import com.xpn.xwiki.XWikiException; |
38 |
|
import com.xpn.xwiki.doc.XWikiDocument; |
39 |
|
import com.xpn.xwiki.plugin.activitystream.api.ActivityEventType; |
40 |
|
import com.xpn.xwiki.user.api.XWikiRightService; |
41 |
|
import com.xpn.xwiki.web.Utils; |
42 |
|
|
43 |
|
|
44 |
|
|
45 |
|
|
46 |
|
|
47 |
|
@version |
48 |
|
|
|
|
| 83.1% |
Uncovered Elements: 31 (183) |
Complexity: 57 |
Complexity Density: 0.52 |
|
49 |
|
public class WatchListEvent implements Comparable<WatchListEvent> |
50 |
|
{ |
51 |
|
|
52 |
|
|
53 |
|
|
54 |
|
private static final String INITIAL_DOCUMENT_VERSION = "1.1"; |
55 |
|
|
56 |
|
|
57 |
|
|
58 |
|
|
59 |
|
private static final String PREINITIAL_DOCUMENT_VERSION = "1.0"; |
60 |
|
|
61 |
|
|
62 |
|
|
63 |
|
|
64 |
|
private final int hashCode; |
65 |
|
|
66 |
|
|
67 |
|
|
68 |
|
|
69 |
|
private String type; |
70 |
|
|
71 |
|
|
72 |
|
|
73 |
|
|
74 |
|
private String previousVersion; |
75 |
|
|
76 |
|
|
77 |
|
|
78 |
|
|
79 |
|
private List<String> versions; |
80 |
|
|
81 |
|
|
82 |
|
|
83 |
|
|
84 |
|
private List<String> authors; |
85 |
|
|
86 |
|
|
87 |
|
|
88 |
|
|
89 |
|
private List<Date> dates; |
90 |
|
|
91 |
|
|
92 |
|
|
93 |
|
|
94 |
|
private String htmlDiff; |
95 |
|
|
96 |
|
private DocumentReference documentReference; |
97 |
|
|
98 |
|
private DocumentReference authorReference; |
99 |
|
|
100 |
|
private List<DocumentReference> authorReferences; |
101 |
|
|
102 |
|
private String version; |
103 |
|
|
104 |
|
private Date date; |
105 |
|
|
106 |
|
private List<WatchListEvent> events; |
107 |
|
|
108 |
|
private EntityReferenceSerializer<String> serializer; |
109 |
|
|
110 |
|
private EntityReferenceSerializer<String> localSerializer; |
111 |
|
|
112 |
|
private EntityReferenceProvider defaultEntityReferenceProvider; |
113 |
|
|
114 |
|
|
115 |
|
|
116 |
|
|
117 |
|
@param |
118 |
|
@param |
119 |
|
@param |
120 |
|
@param |
121 |
|
@param |
122 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (13) |
Complexity: 2 |
Complexity Density: 0.18 |
|
123 |
96 |
public WatchListEvent(DocumentReference documentReference, String type, DocumentReference userReference,... |
124 |
|
String version, Date date) |
125 |
|
{ |
126 |
96 |
this.documentReference = documentReference; |
127 |
96 |
this.type = type; |
128 |
96 |
this.authorReference = userReference; |
129 |
96 |
this.version = version; |
130 |
96 |
this.date = date; |
131 |
|
|
132 |
96 |
this.events = new ArrayList<>(); |
133 |
96 |
this.events.add(this); |
134 |
|
|
135 |
96 |
int hash = 3; |
136 |
96 |
if (ActivityEventType.UPDATE.equals(type)) { |
137 |
74 |
hashCode = 42 * hash + documentReference.hashCode() + type.hashCode(); |
138 |
|
} else { |
139 |
22 |
hashCode = 42 * hash + documentReference.hashCode() + type.hashCode() + date.hashCode(); |
140 |
|
} |
141 |
|
} |
142 |
|
|
143 |
|
|
144 |
|
|
145 |
|
|
146 |
|
@param |
147 |
|
|
|
|
| 53.8% |
Uncovered Elements: 6 (13) |
Complexity: 4 |
Complexity Density: 0.44 |
|
148 |
21 |
public void addEvent(WatchListEvent event)... |
149 |
|
{ |
150 |
21 |
if (ActivityEventType.DELETE.equals(event.getType())) { |
151 |
|
|
152 |
0 |
type = event.getType(); |
153 |
0 |
versions = null; |
154 |
0 |
authors = null; |
155 |
0 |
previousVersion = null; |
156 |
0 |
htmlDiff = null; |
157 |
21 |
} else if (ActivityEventType.UPDATE.equals(event.getType()) && ActivityEventType.DELETE.equals(getType())) { |
158 |
|
|
159 |
2 |
return; |
160 |
|
} |
161 |
|
|
162 |
19 |
events.add(event); |
163 |
|
} |
164 |
|
|
165 |
|
|
166 |
|
@return |
167 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
168 |
48 |
public String getWiki()... |
169 |
|
{ |
170 |
48 |
return getDocumentReference().getWikiReference().getName(); |
171 |
|
} |
172 |
|
|
173 |
|
|
174 |
|
@return |
175 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (2) |
Complexity: 1 |
Complexity Density: 0.5 |
|
176 |
15 |
public String getSpace()... |
177 |
|
{ |
178 |
15 |
SpaceReference spaceReference = getDocumentReference().getLastSpaceReference(); |
179 |
15 |
return getLocalSerializer().serialize(spaceReference); |
180 |
|
} |
181 |
|
|
182 |
|
|
183 |
|
@return |
184 |
|
|
185 |
|
@since |
186 |
|
|
|
|
| 60% |
Uncovered Elements: 2 (5) |
Complexity: 3 |
Complexity Density: 1 |
|
187 |
6 |
public String getDisplaySpace()... |
188 |
|
{ |
189 |
6 |
if (getDefaultEntityReferenceProvider().getDefaultReference(EntityType.DOCUMENT).getName().equals( |
190 |
|
getDocumentReference().getName()) && getDocumentReference().getLastSpaceReference().getParent() != null) |
191 |
|
{ |
192 |
0 |
return getLocalSerializer().serialize(getDocumentReference().getLastSpaceReference().getParent()); |
193 |
|
} else { |
194 |
6 |
return getSpace(); |
195 |
|
} |
196 |
|
} |
197 |
|
|
198 |
|
|
199 |
|
@return |
200 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (2) |
Complexity: 1 |
Complexity Density: 0.5 |
|
201 |
38 |
public String getPrefixedSpace()... |
202 |
|
{ |
203 |
38 |
SpaceReference spaceReference = getDocumentReference().getLastSpaceReference(); |
204 |
38 |
return getSerializer().serialize(spaceReference); |
205 |
|
} |
206 |
|
|
207 |
|
|
208 |
|
@return |
209 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
210 |
103 |
public String getFullName()... |
211 |
|
{ |
212 |
103 |
return getLocalSerializer().serialize(getDocumentReference()); |
213 |
|
} |
214 |
|
|
215 |
|
|
216 |
|
@return |
217 |
|
|
218 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
219 |
46 |
public String getPrefixedFullName()... |
220 |
|
{ |
221 |
46 |
return getSerializer().serialize(getDocumentReference()); |
222 |
|
} |
223 |
|
|
224 |
|
|
225 |
|
@return |
226 |
|
@deprecated |
227 |
|
@link |
228 |
|
|
|
|
| 0% |
Uncovered Elements: 5 (5) |
Complexity: 2 |
Complexity Density: 0.4 |
|
229 |
0 |
@Deprecated... |
230 |
|
public String getUrl() |
231 |
|
{ |
232 |
0 |
String url = ""; |
233 |
|
|
234 |
0 |
try { |
235 |
0 |
XWikiContext context = getXWikiContext(); |
236 |
0 |
url = context.getWiki().getDocument(getDocumentReference(), context).getExternalURL("view", context); |
237 |
|
} catch (Exception e) { |
238 |
|
|
239 |
|
} |
240 |
|
|
241 |
0 |
return url; |
242 |
|
} |
243 |
|
|
244 |
|
|
245 |
|
@return |
246 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
247 |
13 |
public Date getDate()... |
248 |
|
{ |
249 |
13 |
return this.date; |
250 |
|
} |
251 |
|
|
252 |
|
|
253 |
|
@return |
254 |
|
|
255 |
|
|
|
|
| 85.7% |
Uncovered Elements: 1 (7) |
Complexity: 2 |
Complexity Density: 0.4 |
|
256 |
4 |
public List<Date> getDates()... |
257 |
|
{ |
258 |
4 |
if (dates == null) { |
259 |
4 |
dates = new ArrayList<Date>(); |
260 |
|
|
261 |
4 |
for (WatchListEvent event : events) { |
262 |
8 |
dates.add(event.getDate()); |
263 |
|
} |
264 |
|
} |
265 |
|
|
266 |
4 |
return dates; |
267 |
|
} |
268 |
|
|
269 |
|
|
270 |
|
@return |
271 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
272 |
125 |
public String getType()... |
273 |
|
{ |
274 |
125 |
return type; |
275 |
|
} |
276 |
|
|
277 |
|
|
278 |
|
@return |
279 |
|
|
|
|
| 60% |
Uncovered Elements: 2 (5) |
Complexity: 2 |
Complexity Density: 0.67 |
|
280 |
64 |
public String getAuthor()... |
281 |
|
{ |
282 |
64 |
if (authorReference == null) { |
283 |
0 |
return XWikiRightService.GUEST_USER_FULLNAME; |
284 |
|
} |
285 |
|
|
286 |
64 |
return getSerializer().serialize(authorReference); |
287 |
|
} |
288 |
|
|
289 |
|
|
290 |
|
@return |
291 |
|
|
292 |
|
|
|
|
| 90.9% |
Uncovered Elements: 1 (11) |
Complexity: 3 |
Complexity Density: 0.43 |
|
293 |
37 |
public List<String> getAuthors()... |
294 |
|
{ |
295 |
37 |
if (authors == null) { |
296 |
37 |
authors = new ArrayList<String>(); |
297 |
|
|
298 |
37 |
for (WatchListEvent event : events) { |
299 |
56 |
String author = event.getAuthor(); |
300 |
56 |
if (!authors.contains(author)) { |
301 |
37 |
authors.add(author); |
302 |
|
} |
303 |
|
} |
304 |
|
} |
305 |
|
|
306 |
37 |
return authors; |
307 |
|
} |
308 |
|
|
309 |
|
|
310 |
|
@return |
311 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
312 |
18 |
public DocumentReference getAuthorReference()... |
313 |
|
{ |
314 |
18 |
return authorReference; |
315 |
|
} |
316 |
|
|
317 |
|
|
318 |
|
@return |
319 |
|
|
320 |
|
@since |
321 |
|
|
|
|
| 81.8% |
Uncovered Elements: 2 (11) |
Complexity: 3 |
Complexity Density: 0.43 |
|
322 |
2 |
public List<DocumentReference> getAuthorReferences()... |
323 |
|
{ |
324 |
2 |
if (authorReferences == null) { |
325 |
2 |
authorReferences = new ArrayList<DocumentReference>(); |
326 |
|
|
327 |
2 |
for (WatchListEvent event : events) { |
328 |
2 |
DocumentReference eventAuthorReference = event.getAuthorReference(); |
329 |
2 |
if (!authorReferences.contains(eventAuthorReference)) { |
330 |
2 |
authorReferences.add(eventAuthorReference); |
331 |
|
} |
332 |
|
} |
333 |
|
} |
334 |
|
|
335 |
2 |
return authorReferences; |
336 |
|
} |
337 |
|
|
338 |
|
|
339 |
|
@return |
340 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
341 |
41 |
public String getVersion()... |
342 |
|
{ |
343 |
41 |
return version; |
344 |
|
} |
345 |
|
|
346 |
|
|
347 |
|
@return |
348 |
|
|
349 |
|
|
|
|
| 80% |
Uncovered Elements: 2 (10) |
Complexity: 4 |
Complexity Density: 0.67 |
|
350 |
7 |
public List<String> getVersions()... |
351 |
|
{ |
352 |
7 |
if (versions == null) { |
353 |
7 |
versions = new ArrayList<String>(); |
354 |
|
|
355 |
7 |
for (WatchListEvent event : events) { |
356 |
11 |
if (!StringUtils.isBlank(event.getVersion()) && !versions.contains(event.getVersion())) { |
357 |
11 |
versions.add(event.getVersion()); |
358 |
|
} |
359 |
|
} |
360 |
|
} |
361 |
|
|
362 |
7 |
return versions; |
363 |
|
} |
364 |
|
|
365 |
|
|
366 |
|
@return |
367 |
|
|
|
|
| 88% |
Uncovered Elements: 3 (25) |
Complexity: 6 |
Complexity Density: 0.35 |
|
368 |
5 |
public String getPreviousVersion()... |
369 |
|
{ |
370 |
5 |
if (previousVersion == null) { |
371 |
3 |
String initialVersion = ""; |
372 |
3 |
previousVersion = ""; |
373 |
|
|
374 |
3 |
try { |
375 |
3 |
List<String> allVersions = getVersions(); |
376 |
3 |
initialVersion = allVersions.get(allVersions.size() - 1); |
377 |
|
|
378 |
3 |
if (initialVersion.equals(INITIAL_DOCUMENT_VERSION)) { |
379 |
2 |
previousVersion = PREINITIAL_DOCUMENT_VERSION; |
380 |
1 |
} else if (!StringUtils.isBlank(initialVersion)) { |
381 |
|
|
382 |
1 |
XWikiContext context = getXWikiContext(); |
383 |
|
|
384 |
1 |
XWikiDocument doc = context.getWiki().getDocument(getDocumentReference(), context); |
385 |
1 |
XWikiDocument initialDoc = context.getWiki().getDocument(doc, initialVersion, context); |
386 |
1 |
String docPreviousVersion = initialDoc.getPreviousVersion(); |
387 |
1 |
if (docPreviousVersion != null) { |
388 |
1 |
this.previousVersion = docPreviousVersion; |
389 |
|
} |
390 |
|
} |
391 |
|
} catch (XWikiException e) { |
392 |
|
|
393 |
0 |
e.printStackTrace(); |
394 |
|
} |
395 |
|
} |
396 |
|
|
397 |
5 |
return previousVersion; |
398 |
|
} |
399 |
|
|
400 |
|
|
401 |
|
@return |
402 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
403 |
4 |
public boolean isComposite()... |
404 |
|
{ |
405 |
4 |
return events.size() > 1; |
406 |
|
} |
407 |
|
|
408 |
|
|
409 |
|
@return |
410 |
|
|
411 |
|
|
|
|
| 71.4% |
Uncovered Elements: 2 (7) |
Complexity: 3 |
Complexity Density: 0.6 |
|
412 |
2 |
public String getHTMLDiff()... |
413 |
|
{ |
414 |
|
|
415 |
|
|
416 |
2 |
if (htmlDiff == null) { |
417 |
2 |
try { |
418 |
2 |
htmlDiff = Utils.getComponent(WatchListEventHTMLDiffExtractor.class).getHTMLDiff(this); |
419 |
|
} catch (Exception e) { |
420 |
|
|
421 |
0 |
e.printStackTrace(); |
422 |
|
} |
423 |
|
} |
424 |
|
|
425 |
2 |
return htmlDiff; |
426 |
|
} |
427 |
|
|
428 |
|
|
429 |
|
|
430 |
|
|
431 |
|
@param |
432 |
|
@return |
433 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
434 |
1 |
@Override... |
435 |
|
public int compareTo(WatchListEvent event) |
436 |
|
{ |
437 |
1 |
return getDocumentReference().compareTo(event.getDocumentReference()); |
438 |
|
} |
439 |
|
|
440 |
|
|
441 |
|
@return |
442 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
443 |
371 |
public DocumentReference getDocumentReference()... |
444 |
|
{ |
445 |
371 |
return this.documentReference; |
446 |
|
} |
447 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
448 |
1 |
@Override... |
449 |
|
public int hashCode() |
450 |
|
{ |
451 |
1 |
return hashCode; |
452 |
|
} |
453 |
|
|
454 |
|
|
455 |
|
|
456 |
|
|
457 |
|
@param |
458 |
|
@return |
459 |
|
|
|
|
| 60% |
Uncovered Elements: 4 (10) |
Complexity: 3 |
Complexity Density: 0.5 |
|
460 |
65 |
@Override... |
461 |
|
public boolean equals(Object obj) |
462 |
|
{ |
463 |
65 |
if (this == obj) { |
464 |
0 |
return true; |
465 |
|
} |
466 |
|
|
467 |
65 |
if (!(obj instanceof WatchListEvent)) { |
468 |
0 |
return false; |
469 |
|
} |
470 |
|
|
471 |
|
|
472 |
|
|
473 |
|
|
474 |
|
|
475 |
|
|
476 |
65 |
WatchListEvent event = ((WatchListEvent) obj); |
477 |
65 |
return this.documentReference.equals(event.getDocumentReference()) |
478 |
|
&& WatchListEventType.UPDATE.equals(getType()) |
479 |
|
&& (WatchListEventType.UPDATE.equals(event.getType()) || WatchListEventType.DELETE.equals(event.getType())); |
480 |
|
} |
481 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (5) |
Complexity: 2 |
Complexity Density: 0.67 |
|
482 |
148 |
private EntityReferenceSerializer<String> getSerializer()... |
483 |
|
{ |
484 |
148 |
if (this.serializer == null) { |
485 |
56 |
this.serializer = Utils.getComponent(EntityReferenceSerializer.TYPE_STRING); |
486 |
|
} |
487 |
|
|
488 |
148 |
return this.serializer; |
489 |
|
} |
490 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (5) |
Complexity: 2 |
Complexity Density: 0.67 |
|
491 |
118 |
private EntityReferenceSerializer<String> getLocalSerializer()... |
492 |
|
{ |
493 |
118 |
if (this.localSerializer == null) { |
494 |
71 |
this.localSerializer = Utils.getComponent(EntityReferenceSerializer.TYPE_STRING, "local"); |
495 |
|
} |
496 |
|
|
497 |
118 |
return this.localSerializer; |
498 |
|
} |
499 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (5) |
Complexity: 2 |
Complexity Density: 0.67 |
|
500 |
6 |
private EntityReferenceProvider getDefaultEntityReferenceProvider()... |
501 |
|
{ |
502 |
6 |
if (this.defaultEntityReferenceProvider == null) { |
503 |
2 |
this.defaultEntityReferenceProvider = Utils.getComponent(EntityReferenceProvider.class); |
504 |
|
} |
505 |
|
|
506 |
6 |
return this.defaultEntityReferenceProvider; |
507 |
|
} |
508 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (2) |
Complexity: 1 |
Complexity Density: 0.5 |
|
509 |
1 |
private XWikiContext getXWikiContext()... |
510 |
|
{ |
511 |
1 |
Provider<XWikiContext> provider = Utils.getComponent(XWikiContext.TYPE_PROVIDER); |
512 |
1 |
return provider.get(); |
513 |
|
} |
514 |
|
} |