1 |
|
|
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
12 |
|
|
13 |
|
|
14 |
|
|
15 |
|
|
16 |
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
|
package org.xwiki.wiki.internal.descriptor.builder; |
21 |
|
|
22 |
|
import java.util.ArrayList; |
23 |
|
import java.util.List; |
24 |
|
|
25 |
|
import javax.inject.Inject; |
26 |
|
import javax.inject.Named; |
27 |
|
import javax.inject.Provider; |
28 |
|
import javax.inject.Singleton; |
29 |
|
|
30 |
|
import org.apache.commons.lang3.StringUtils; |
31 |
|
import org.slf4j.Logger; |
32 |
|
import org.xwiki.component.annotation.Component; |
33 |
|
import org.xwiki.model.EntityType; |
34 |
|
import org.xwiki.model.reference.DocumentReference; |
35 |
|
import org.xwiki.model.reference.DocumentReferenceResolver; |
36 |
|
import org.xwiki.model.reference.EntityReference; |
37 |
|
import org.xwiki.model.reference.EntityReferenceSerializer; |
38 |
|
import org.xwiki.model.reference.WikiReference; |
39 |
|
import org.xwiki.wiki.descriptor.WikiDescriptor; |
40 |
|
import org.xwiki.wiki.internal.descriptor.DefaultWikiDescriptor; |
41 |
|
import org.xwiki.wiki.internal.descriptor.document.WikiDescriptorDocumentHelper; |
42 |
|
import org.xwiki.wiki.internal.descriptor.document.XWikiServerClassDocumentInitializer; |
43 |
|
import org.xwiki.wiki.internal.descriptor.properties.WikiPropertyGroupManager; |
44 |
|
import org.xwiki.wiki.manager.WikiManagerException; |
45 |
|
import org.xwiki.wiki.properties.WikiPropertyGroupException; |
46 |
|
|
47 |
|
import com.xpn.xwiki.XWiki; |
48 |
|
import com.xpn.xwiki.XWikiContext; |
49 |
|
import com.xpn.xwiki.XWikiException; |
50 |
|
import com.xpn.xwiki.doc.XWikiDocument; |
51 |
|
import com.xpn.xwiki.objects.BaseObject; |
52 |
|
|
53 |
|
|
54 |
|
@link |
55 |
|
|
56 |
|
@version |
57 |
|
@since |
58 |
|
|
59 |
|
@Component |
60 |
|
@Singleton |
|
|
| 90.4% |
Uncovered Elements: 10 (104) |
Complexity: 23 |
Complexity Density: 0.31 |
|
61 |
|
public class DefaultWikiDescriptorBuilder implements WikiDescriptorBuilder |
62 |
|
{ |
63 |
|
|
64 |
|
|
65 |
|
|
66 |
|
static final String VALID_PAGE_PREFIX = "XWikiServer"; |
67 |
|
|
68 |
|
|
69 |
|
|
70 |
|
|
71 |
|
@Inject |
72 |
|
private Provider<XWikiContext> xcontextProvider; |
73 |
|
|
74 |
|
|
75 |
|
|
76 |
|
|
77 |
|
@Inject |
78 |
|
private EntityReferenceSerializer<String> referenceSerializer; |
79 |
|
|
80 |
|
@Inject |
81 |
|
private DocumentReferenceResolver<String> referenceResolver; |
82 |
|
|
83 |
|
@Inject |
84 |
|
@Named("user") |
85 |
|
private DocumentReferenceResolver<String> userReferenceResolver; |
86 |
|
|
87 |
|
@Inject |
88 |
|
private Provider<WikiPropertyGroupManager> wikiPropertyGroupManagerProvider; |
89 |
|
|
90 |
|
@Inject |
91 |
|
private WikiDescriptorDocumentHelper wikiDescriptorDocumentHelper; |
92 |
|
|
93 |
|
@Inject |
94 |
|
private Logger logger; |
95 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (7) |
Complexity: 2 |
Complexity Density: 0.4 |
|
96 |
115 |
private String getFullReference(String userId, String wikiId)... |
97 |
|
{ |
98 |
115 |
String result = null; |
99 |
|
|
100 |
115 |
if (!StringUtils.isBlank(userId)) { |
101 |
106 |
DocumentReference userReference = userReferenceResolver.resolve(userId, new WikiReference(wikiId)); |
102 |
106 |
result = referenceSerializer.serialize(userReference); |
103 |
|
} |
104 |
|
|
105 |
115 |
return result; |
106 |
|
} |
107 |
|
|
|
|
| 95.2% |
Uncovered Elements: 1 (21) |
Complexity: 4 |
Complexity Density: 0.24 |
|
108 |
108 |
@Override... |
109 |
|
public DefaultWikiDescriptor buildDescriptorObject(List<BaseObject> serverClassObjects, XWikiDocument document) |
110 |
|
{ |
111 |
108 |
List<BaseObject> normalizedServerClassObjects = normalizeServerClassObjects(serverClassObjects); |
112 |
108 |
BaseObject mainServerClassObject = normalizedServerClassObjects.remove(0); |
113 |
108 |
DefaultWikiDescriptor descriptor = extractWikiDescriptor(mainServerClassObject, document); |
114 |
|
|
115 |
108 |
if (descriptor != null) { |
116 |
|
|
117 |
107 |
for (BaseObject serverClassObject : normalizedServerClassObjects) { |
118 |
2 |
if (serverClassObject != null) { |
119 |
2 |
String descriptorAlias = extractWikiAlias(serverClassObject); |
120 |
2 |
descriptor.addAlias(descriptorAlias); |
121 |
|
} |
122 |
|
} |
123 |
|
|
124 |
|
|
125 |
107 |
descriptor.setMainPageReference(referenceResolver.resolve(mainServerClassObject |
126 |
|
.getStringValue(XWikiServerClassDocumentInitializer.FIELD_HOMEPAGE))); |
127 |
107 |
descriptor.setPrettyName(mainServerClassObject |
128 |
|
.getStringValue(XWikiServerClassDocumentInitializer.FIELD_WIKIPRETTYNAME)); |
129 |
107 |
descriptor.setOwnerId(getFullReference( |
130 |
|
mainServerClassObject.getStringValue(XWikiServerClassDocumentInitializer.FIELD_OWNER), |
131 |
|
descriptor.getId())); |
132 |
107 |
descriptor.setDescription(mainServerClassObject |
133 |
|
.getStringValue(XWikiServerClassDocumentInitializer.FIELD_DESCRIPTION)); |
134 |
|
|
135 |
|
|
136 |
107 |
try { |
137 |
107 |
WikiPropertyGroupManager wikiPropertyGroupManager = wikiPropertyGroupManagerProvider.get(); |
138 |
107 |
wikiPropertyGroupManager.loadForDescriptor(descriptor); |
139 |
|
} catch (WikiPropertyGroupException e) { |
140 |
1 |
logger.error("Failed to load wiki property groups for wiki [{}].", descriptor.getId(), e); |
141 |
|
} |
142 |
|
} |
143 |
|
|
144 |
108 |
return descriptor; |
145 |
|
} |
146 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (7) |
Complexity: 2 |
Complexity Density: 0.4 |
|
147 |
108 |
private List<BaseObject> normalizeServerClassObjects(List<BaseObject> serverClassObjects)... |
148 |
|
{ |
149 |
|
|
150 |
|
|
151 |
108 |
List<BaseObject> result = new ArrayList<>(); |
152 |
108 |
for (BaseObject serverClassObject : serverClassObjects) { |
153 |
112 |
if (serverClassObject != null) { |
154 |
110 |
result.add(serverClassObject); |
155 |
|
} |
156 |
|
} |
157 |
108 |
return result; |
158 |
|
} |
159 |
|
|
|
|
| 90.9% |
Uncovered Elements: 1 (11) |
Complexity: 3 |
Complexity Density: 0.43 |
|
160 |
108 |
private DefaultWikiDescriptor extractWikiDescriptor(BaseObject serverClassObject, XWikiDocument document)... |
161 |
|
{ |
162 |
108 |
DefaultWikiDescriptor descriptor = null; |
163 |
|
|
164 |
|
|
165 |
108 |
String serverProperty = extractWikiAlias(serverClassObject); |
166 |
108 |
if (!StringUtils.isBlank(serverProperty)) { |
167 |
|
|
168 |
107 |
String wikiId = extractWikiId(document); |
169 |
107 |
if (wikiId != null) { |
170 |
107 |
descriptor = new DefaultWikiDescriptor(wikiId, serverProperty); |
171 |
|
} |
172 |
|
} |
173 |
|
|
174 |
108 |
return descriptor; |
175 |
|
} |
176 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (1) |
Complexity: 1 |
Complexity Density: 1 |
|
177 |
110 |
private String extractWikiAlias(BaseObject serverClassObject)... |
178 |
|
{ |
179 |
110 |
return serverClassObject.getStringValue(XWikiServerClassDocumentInitializer.FIELD_SERVER); |
180 |
|
} |
181 |
|
|
|
|
| 85.7% |
Uncovered Elements: 1 (7) |
Complexity: 2 |
Complexity Density: 0.4 |
|
182 |
107 |
private String extractWikiId(XWikiDocument document)... |
183 |
|
{ |
184 |
107 |
String wikiId = null; |
185 |
107 |
String pageName = document.getDocumentReference().getName(); |
186 |
107 |
if (pageName.startsWith(VALID_PAGE_PREFIX)) { |
187 |
107 |
wikiId = StringUtils.removeStart(pageName, VALID_PAGE_PREFIX).toLowerCase(); |
188 |
|
} |
189 |
107 |
return wikiId; |
190 |
|
} |
191 |
|
|
|
|
| 73.1% |
Uncovered Elements: 7 (26) |
Complexity: 5 |
Complexity Density: 0.21 |
|
192 |
8 |
@Override... |
193 |
|
public XWikiDocument save(WikiDescriptor descriptor) throws WikiDescriptorBuilderException |
194 |
|
{ |
195 |
8 |
XWikiContext context = xcontextProvider.get(); |
196 |
8 |
XWiki xwiki = context.getWiki(); |
197 |
8 |
XWikiDocument descriptorDoc = null; |
198 |
|
|
199 |
8 |
try { |
200 |
|
|
201 |
8 |
descriptorDoc = wikiDescriptorDocumentHelper.getDocumentFromWikiId(descriptor.getId()); |
202 |
|
|
203 |
|
|
204 |
8 |
BaseObject obj = descriptorDoc.getXObject(DefaultWikiDescriptor.SERVER_CLASS, true, context); |
205 |
8 |
obj.set(XWikiServerClassDocumentInitializer.FIELD_SERVER, descriptor.getDefaultAlias(), context); |
206 |
8 |
obj.set(XWikiServerClassDocumentInitializer.FIELD_HOMEPAGE, |
207 |
|
referenceSerializer.serialize(descriptor.getMainPageReference()), context); |
208 |
8 |
obj.set(XWikiServerClassDocumentInitializer.FIELD_OWNER, |
209 |
|
getFullReference(descriptor.getOwnerId(), descriptor.getId()), context); |
210 |
8 |
obj.set(XWikiServerClassDocumentInitializer.FIELD_WIKIPRETTYNAME, descriptor.getPrettyName(), context); |
211 |
8 |
obj.set(XWikiServerClassDocumentInitializer.FIELD_DESCRIPTION, descriptor.getDescription(), context); |
212 |
|
|
213 |
|
|
214 |
8 |
List<String> aliases = descriptor.getAliases(); |
215 |
8 |
for (int i = 1; i < aliases.size(); ++i) { |
216 |
0 |
String alias = aliases.get(i); |
217 |
0 |
BaseObject objAlias = descriptorDoc.getXObject(DefaultWikiDescriptor.SERVER_CLASS, |
218 |
|
XWikiServerClassDocumentInitializer.FIELD_SERVER, alias, true); |
219 |
0 |
objAlias.set(XWikiServerClassDocumentInitializer.FIELD_SERVER, alias, context); |
220 |
|
} |
221 |
|
|
222 |
|
|
223 |
8 |
setDescriptorDocMetadata(descriptorDoc); |
224 |
|
|
225 |
|
|
226 |
8 |
xwiki.saveDocument(descriptorDoc, context); |
227 |
|
|
228 |
|
|
229 |
8 |
WikiPropertyGroupManager wikiPropertyGroupManager = wikiPropertyGroupManagerProvider.get(); |
230 |
8 |
wikiPropertyGroupManager.saveForDescriptor(descriptor); |
231 |
|
|
232 |
|
} catch (WikiManagerException e) { |
233 |
0 |
throw new WikiDescriptorBuilderException("Unable to load the descriptor document", e); |
234 |
|
} catch (XWikiException e) { |
235 |
0 |
throw new WikiDescriptorBuilderException("Unable to save the descriptor document", e); |
236 |
|
} catch (WikiPropertyGroupException e) { |
237 |
0 |
throw new WikiDescriptorBuilderException("Unable to save the property groups", e); |
238 |
|
} |
239 |
|
|
240 |
8 |
return descriptorDoc; |
241 |
|
} |
242 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (16) |
Complexity: 4 |
Complexity Density: 0.4 |
|
243 |
8 |
private void setDescriptorDocMetadata(XWikiDocument descriptorDoc)... |
244 |
|
{ |
245 |
8 |
XWikiContext context = xcontextProvider.get(); |
246 |
|
|
247 |
|
|
248 |
8 |
descriptorDoc.setHidden(true); |
249 |
|
|
250 |
|
|
251 |
8 |
if (descriptorDoc.getCreatorReference() == null) { |
252 |
4 |
descriptorDoc.setCreatorReference(context.getUserReference()); |
253 |
|
} |
254 |
|
|
255 |
8 |
if (descriptorDoc.getAuthorReference() == null) { |
256 |
4 |
descriptorDoc.setAuthorReference(context.getUserReference()); |
257 |
|
} |
258 |
|
|
259 |
|
|
260 |
8 |
if (descriptorDoc.getParentReference() == null) { |
261 |
4 |
EntityReference parentReference = new EntityReference("WebHome", EntityType.DOCUMENT); |
262 |
4 |
parentReference.appendParent(new EntityReference("WikiManager", EntityType.SPACE)); |
263 |
4 |
descriptorDoc.setParentReference(parentReference); |
264 |
|
} |
265 |
|
} |
266 |
|
} |