1 |
|
|
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
12 |
|
|
13 |
|
|
14 |
|
|
15 |
|
|
16 |
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
|
package com.xpn.xwiki.internal.sheet; |
21 |
|
|
22 |
|
import java.util.ArrayList; |
23 |
|
import java.util.Collections; |
24 |
|
import java.util.List; |
25 |
|
|
26 |
|
import javax.inject.Inject; |
27 |
|
import javax.inject.Named; |
28 |
|
|
29 |
|
import org.slf4j.Logger; |
30 |
|
import org.xwiki.bridge.DocumentModelBridge; |
31 |
|
import org.xwiki.component.phase.Initializable; |
32 |
|
import org.xwiki.component.phase.InitializationException; |
33 |
|
import org.xwiki.context.Execution; |
34 |
|
import org.xwiki.model.EntityType; |
35 |
|
import org.xwiki.model.reference.DocumentReference; |
36 |
|
import org.xwiki.model.reference.DocumentReferenceResolver; |
37 |
|
import org.xwiki.model.reference.EntityReference; |
38 |
|
import org.xwiki.model.reference.EntityReferenceResolver; |
39 |
|
import org.xwiki.model.reference.EntityReferenceSerializer; |
40 |
|
import org.xwiki.query.Query; |
41 |
|
import org.xwiki.query.QueryException; |
42 |
|
import org.xwiki.query.QueryManager; |
43 |
|
import org.xwiki.sheet.SheetBinder; |
44 |
|
|
45 |
|
import com.xpn.xwiki.XWikiContext; |
46 |
|
import com.xpn.xwiki.XWikiException; |
47 |
|
import com.xpn.xwiki.doc.XWikiDocument; |
48 |
|
import com.xpn.xwiki.objects.BaseObject; |
49 |
|
|
50 |
|
|
51 |
|
@link |
52 |
|
|
53 |
|
|
54 |
|
|
55 |
|
@version |
56 |
|
@since |
57 |
|
|
|
|
| 78.3% |
Uncovered Elements: 18 (83) |
Complexity: 18 |
Complexity Density: 0.31 |
|
58 |
|
public abstract class AbstractSheetBinder implements SheetBinder, Initializable |
59 |
|
{ |
60 |
|
|
61 |
|
|
62 |
|
|
63 |
|
private static final String SHEET_PROPERTY = "sheet"; |
64 |
|
|
65 |
|
|
66 |
|
@Inject |
67 |
|
private Logger logger; |
68 |
|
|
69 |
|
|
70 |
|
|
71 |
|
|
72 |
|
@Inject |
73 |
|
private DocumentReferenceResolver<String> documentReferenceResolver; |
74 |
|
|
75 |
|
|
76 |
|
|
77 |
|
|
78 |
|
@Inject |
79 |
|
@Named("relative") |
80 |
|
private EntityReferenceResolver<String> relativeReferenceResolver; |
81 |
|
|
82 |
|
|
83 |
|
|
84 |
|
|
85 |
|
@Inject |
86 |
|
private EntityReferenceSerializer<String> defaultEntityReferenceSerializer; |
87 |
|
|
88 |
|
|
89 |
|
|
90 |
|
|
91 |
|
@Inject |
92 |
|
@Named("compact") |
93 |
|
private EntityReferenceSerializer<String> compactEntityReferenceSerializer; |
94 |
|
|
95 |
|
|
96 |
|
|
97 |
|
|
98 |
|
@Inject |
99 |
|
private Execution execution; |
100 |
|
|
101 |
|
|
102 |
|
|
103 |
|
|
104 |
|
@Inject |
105 |
|
private QueryManager queryManager; |
106 |
|
|
107 |
|
|
108 |
|
|
109 |
|
|
110 |
|
private Query sheetBindingsQuery; |
111 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (15) |
Complexity: 3 |
Complexity Density: 0.27 |
|
112 |
34378 |
@Override... |
113 |
|
public List<DocumentReference> getSheets(DocumentModelBridge document) |
114 |
|
{ |
115 |
34377 |
DocumentReference sheetBindingClassReference = |
116 |
|
this.documentReferenceResolver.resolve(getSheetBindingClass(), document.getDocumentReference()); |
117 |
34380 |
List<BaseObject> sheetBindingObjects = ((XWikiDocument) document).getXObjects(sheetBindingClassReference); |
118 |
34375 |
if (sheetBindingObjects == null) { |
119 |
30561 |
return Collections.emptyList(); |
120 |
|
} |
121 |
3815 |
List<DocumentReference> sheets = new ArrayList<DocumentReference>(); |
122 |
3815 |
for (BaseObject sheetBindingObject : sheetBindingObjects) { |
123 |
|
|
124 |
3816 |
if (sheetBindingObject != null) { |
125 |
3781 |
String sheetStringRef = sheetBindingObject.getStringValue(SHEET_PROPERTY); |
126 |
3781 |
DocumentReference sheetReference = |
127 |
|
this.documentReferenceResolver.resolve(sheetStringRef, document.getDocumentReference()); |
128 |
3781 |
sheets.add(sheetReference); |
129 |
|
} |
130 |
|
} |
131 |
3815 |
return sheets; |
132 |
|
} |
133 |
|
|
|
|
| 85.7% |
Uncovered Elements: 2 (14) |
Complexity: 3 |
Complexity Density: 0.25 |
|
134 |
1 |
@Override... |
135 |
|
public List<DocumentReference> getDocuments(DocumentReference expectedSheetRef) |
136 |
|
{ |
137 |
1 |
this.sheetBindingsQuery.setWiki(expectedSheetRef.getWikiReference().getName()); |
138 |
1 |
try { |
139 |
1 |
List<Object[]> sheetBindings = this.sheetBindingsQuery.execute(); |
140 |
1 |
List<DocumentReference> documentReferences = new ArrayList<DocumentReference>(); |
141 |
1 |
for (Object[] sheetBinding : sheetBindings) { |
142 |
2 |
DocumentReference docRef = |
143 |
|
this.documentReferenceResolver.resolve((String) sheetBinding[0], expectedSheetRef); |
144 |
2 |
DocumentReference sheetRef = this.documentReferenceResolver.resolve((String) sheetBinding[1], docRef); |
145 |
2 |
if (sheetRef.equals(expectedSheetRef)) { |
146 |
1 |
documentReferences.add(docRef); |
147 |
|
} |
148 |
|
} |
149 |
1 |
return documentReferences; |
150 |
|
} catch (QueryException e) { |
151 |
0 |
this.logger.warn("Failed to query sheet bindings.", e); |
152 |
0 |
return Collections.emptyList(); |
153 |
|
} |
154 |
|
} |
155 |
|
|
|
|
| 54.2% |
Uncovered Elements: 11 (24) |
Complexity: 5 |
Complexity Density: 0.28 |
|
156 |
1039 |
@Override... |
157 |
|
public boolean bind(DocumentModelBridge document, DocumentReference sheetReference) |
158 |
|
{ |
159 |
1039 |
EntityReference sheetBindingClassReference = |
160 |
|
this.relativeReferenceResolver.resolve(getSheetBindingClass(), EntityType.DOCUMENT); |
161 |
1039 |
List<BaseObject> sheetBindingObjects = ((XWikiDocument) document).getXObjects(sheetBindingClassReference); |
162 |
1039 |
if (sheetBindingObjects != null) { |
163 |
1 |
for (BaseObject sheetBindingObject : sheetBindingObjects) { |
164 |
|
|
165 |
1 |
if (sheetBindingObject != null) { |
166 |
0 |
String boundSheetStringRef = sheetBindingObject.getStringValue(SHEET_PROPERTY); |
167 |
0 |
DocumentReference boundSheetReference = |
168 |
|
this.documentReferenceResolver.resolve(boundSheetStringRef, document.getDocumentReference()); |
169 |
0 |
if (boundSheetReference.equals(sheetReference)) { |
170 |
0 |
return false; |
171 |
|
} |
172 |
|
} |
173 |
|
} |
174 |
|
} |
175 |
1039 |
String relativeSheetStringReference = |
176 |
|
this.compactEntityReferenceSerializer.serialize(sheetReference, document.getDocumentReference()); |
177 |
1039 |
try { |
178 |
1039 |
BaseObject sheetBindingObject = |
179 |
|
((XWikiDocument) document).newXObject(sheetBindingClassReference, getXWikiContext()); |
180 |
1039 |
sheetBindingObject.setStringValue(SHEET_PROPERTY, relativeSheetStringReference); |
181 |
|
} catch (XWikiException e) { |
182 |
0 |
String docStringReference = |
183 |
|
this.defaultEntityReferenceSerializer.serialize(document.getDocumentReference()); |
184 |
0 |
String sheetStringReference = this.defaultEntityReferenceSerializer.serialize(sheetReference); |
185 |
0 |
this.logger.warn("Failed to bind sheet [{}] to document [{}].", sheetStringReference, docStringReference); |
186 |
0 |
return false; |
187 |
|
} |
188 |
1039 |
return true; |
189 |
|
} |
190 |
|
|
|
|
| 76.5% |
Uncovered Elements: 4 (17) |
Complexity: 4 |
Complexity Density: 0.36 |
|
191 |
94 |
@Override... |
192 |
|
public boolean unbind(DocumentModelBridge document, DocumentReference sheetReference) |
193 |
|
{ |
194 |
94 |
DocumentReference sheetBindingClassReference = |
195 |
|
this.documentReferenceResolver.resolve(getSheetBindingClass(), document.getDocumentReference()); |
196 |
94 |
List<BaseObject> sheetBindingObjects = ((XWikiDocument) document).getXObjects(sheetBindingClassReference); |
197 |
94 |
if (sheetBindingObjects == null) { |
198 |
0 |
return false; |
199 |
|
} |
200 |
94 |
for (BaseObject sheetBindingObject : sheetBindingObjects) { |
201 |
|
|
202 |
95 |
if (sheetBindingObject != null) { |
203 |
94 |
String boundSheetStringRef = sheetBindingObject.getStringValue(SHEET_PROPERTY); |
204 |
94 |
DocumentReference boundSheetReference = |
205 |
|
this.documentReferenceResolver.resolve(boundSheetStringRef, document.getDocumentReference()); |
206 |
94 |
if (boundSheetReference.equals(sheetReference)) { |
207 |
94 |
return ((XWikiDocument) document).removeXObject(sheetBindingObject); |
208 |
|
} |
209 |
|
} |
210 |
|
} |
211 |
0 |
return false; |
212 |
|
} |
213 |
|
|
214 |
|
|
215 |
|
@return |
216 |
|
@deprecated |
217 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
218 |
1039 |
@Deprecated... |
219 |
|
private XWikiContext getXWikiContext() |
220 |
|
{ |
221 |
1039 |
return (XWikiContext) this.execution.getContext().getProperty("xwikicontext"); |
222 |
|
} |
223 |
|
|
224 |
|
|
225 |
|
@return |
226 |
|
|
227 |
|
protected abstract String getSheetBindingClass(); |
228 |
|
|
|
|
| 83.3% |
Uncovered Elements: 1 (6) |
Complexity: 2 |
Complexity Density: 0.33 |
|
229 |
141 |
@Override... |
230 |
|
public void initialize() throws InitializationException |
231 |
|
{ |
232 |
141 |
try { |
233 |
141 |
String statement = |
234 |
|
"select doc.fullName, prop.value from XWikiDocument doc, BaseObject obj, StringProperty prop where " |
235 |
|
+ "obj.className=:sheetBindingClass and obj.name=doc.fullName and obj.id=prop.id.id and " |
236 |
|
+ "prop.id.name=:sheetProperty order by doc.fullName"; |
237 |
141 |
this.sheetBindingsQuery = this.queryManager.createQuery(statement, Query.HQL); |
238 |
141 |
this.sheetBindingsQuery.bindValue("sheetBindingClass", getSheetBindingClass()); |
239 |
141 |
this.sheetBindingsQuery.bindValue("sheetProperty", SHEET_PROPERTY); |
240 |
|
} catch (QueryException e) { |
241 |
0 |
throw new InitializationException("Failed to create query for retrieving the list of sheet bindings.", e); |
242 |
|
} |
243 |
|
} |
244 |
|
} |