Skip to Content
Version 2.1 by Thomas Coelho on 2022/10/18 14:09
Show last authors
1 {{template name="locationPicker_macros.vm" /}}
2
3 {{velocity}}
4 ## This document can be copied in order to be customized so we cannot rely on its name to determine if the currently
5 ## displayed document is a class or the class sheet itself. We look for the sheet descriptor instead.
6 #set ($isSheet = $doc.getObject('XWiki.SheetDescriptorClass'))
7 #if ($isSheet)
8 ## Viewing the sheet document itself.
9 {{translation key="platform.xclass.defaultClassSheet.description"/}}
10 #elseif ("$!request.bindSheet" != '' && $hasEdit)
11 #if ($services.csrf.isTokenValid($request.getParameter('form_token')))
12 ## Bind the sheet to the class.
13 #set ($classSheetReference = $services.model.resolveDocument($request.bindSheet))
14 #if ($services.sheet.bindClassSheet($doc, $classSheetReference))
15 $doc.save($services.localization.render('platform.xclass.defaultClassSheet.sheets.bind'))
16 #end
17 $response.sendRedirect($request.xredirect)
18 #else
19 $response.sendRedirect($services.csrf.getResubmissionURL())
20 #end
21 ## Stop processing, since we already sent a redirect.
22 #stop
23 #elseif("$!request.docName" != '')
24 ## Request for creating a new instance.
25 ## We don't actually create a new instance here, we just redirect to the edit mode.
26 #set ($targetSpaceRef = $services.model.resolveSpace($request.spaceName))
27 #set ($targetDocRef = $services.model.createDocumentReference($request.docName, $targetSpaceRef))
28 #if (!$xwiki.exists($targetDocRef) && $services.security.authorization.hasAccess('edit', $targetDocRef))
29 ## Compute the default edit mode to ensure backward compatibility with documents that are still using the deprecated
30 ## inline action.
31 #set ($editAction = $xwiki.getDocument($request.template).getDefaultEditMode())
32 $response.sendRedirect($xwiki.getURL($targetDocRef, $editAction, $escapetool.url({
33 'template': $request.template,
34 'parent': $request.parent,
35 'title': $request.docName
36 })))
37 ## Stop processing, since we already sent a redirect.
38 #stop
39 #end
40 #end
41 {{/velocity}}
42
43 {{velocity}}
44 ## If this sheet is explicitly bound to the displayed class then print the class document content before the
45 ## sheet output. Class authors can put the description of the class in the class document content.
46 #set($classSheetReference = $services.model.createDocumentReference($doc.wiki, 'XWiki', 'ClassSheet'))
47 #if($services.sheet.getDocumentSheets($doc).contains($classSheetReference))
48 {{include reference="" /}}
49 #end
50 {{/velocity}}
51
52 {{velocity}}
53 #if (!$isSheet)
54 #set ($className = $doc.pageReference.name)
55 #set ($className = $stringtool.removeEnd($className, 'Class'))
56 ## Determine the class sheets.
57 #set ($classSheetReferences = $services.sheet.getClassSheets($doc))
58 #if ($classSheetReferences.isEmpty())
59 ## There is no class sheet explicitly bound to this class. Fall-back on naming convention.
60 ## Before XWiki 2.0, the default class sheet was suffixed with "ClassSheet". Since 2.0, the suffix is just "Sheet".
61 #set ($defaultClassSheetReference = $services.model.createDocumentReference("${className}ClassSheet",
62 $doc.documentReference.parent))
63 #if (!$xwiki.exists($defaultClassSheetReference))
64 #set ($defaultClassSheetReference = $services.model.createDocumentReference("${className}Sheet",
65 $doc.documentReference.parent))
66 #end
67 #end
68 ## Determine the template using naming convention.
69 ## Before XWiki 2.0, the default class template was suffixed with "ClassTemplate".
70 ## Since 2.0, the suffix is just "Template".
71 #set ($classTemplateReference = $services.model.createDocumentReference("${className}ClassTemplate",
72 $doc.documentReference.parent))
73 #if (!$xwiki.exists($classTemplateReference))
74 #set ($classTemplateReference = $services.model.createDocumentReference("${className}Template",
75 $doc.documentReference.parent))
76 #end
77 ## Determine the template provider using naming convention.
78 #set ($classTemplateProviderReference = $services.model.createDocumentReference("${className}TemplateProvider",
79 $doc.documentReference.parent))
80 #set ($classTemplateProviderDoc = $xwiki.getDocument($classTemplateProviderReference))
81 #set ($hasClassTemplateProvider = !$classTemplateProviderDoc.isNew())
82 #set($classTemplateDoc = $xwiki.getDocument($classTemplateReference))
83 #set($hasClassSheets = !$classSheetReferences.isEmpty() || $xwiki.exists($defaultClassSheetReference))
84 #set($hasClassTemplate = !$classTemplateDoc.isNew())
85 #if(!$defaultSpace)
86 #set($defaultSpace = $doc.space)
87 #end
88 #if(!$defaultParent)
89 #set($defaultParent = ${doc.fullName})
90 #end
91
92 #set ($classEditorURL = $doc.getURL('edit', 'editor=class'))
93 #if($doc.getxWikiClass().properties.size() == 0)
94 {{warning}}$services.localization.render('platform.xclass.defaultClassSheet.properties.empty', [
95 "{{html}}<a href='$classEditorURL'>",
96 '</a>{{/html}}'
97 ]){{/warning}}
98 #else
99 (% id="HClassProperties" %)
100 = {{translation key="platform.xclass.defaultClassSheet.properties.heading"/}} =
101 #foreach($property in $doc.getxWikiClass().properties)
102 * $services.rendering.escape("$property.prettyName ($property.name: $xwiki.metaclass.get($property.classType).prettyName)", $xwiki.currentContentSyntaxId)
103 #end
104 * //$services.localization.render('platform.xclass.defaultClassSheet.properties.edit', [
105 "{{html}}<a href='$classEditorURL'>",
106 '</a>{{/html}}'
107 ])//
108
109 #end
110 #if ($hasClassSheets && $hasClassTemplate)
111 (% id="HCreatePage" %)
112 = {{translation key="platform.xclass.defaultClassSheet.createPage.heading"/}} =
113 #if("$!targetDocRef" != '' && $xwiki.exists($targetDocRef))
114
115 {{warning}}$services.localization.render('platform.xclass.defaultClassSheet.createPage.pageAlreadyExists', [
116 '[[',
117 ">>$services.model.serialize($targetDocRef)]]"
118 ]){{/warning}}
119 #elseif("$!targetDocRef" != '')
120
121 {{warning}}{{translation key="platform.xclass.defaultClassSheet.createPage.denied"/}}{{/warning}}
122 #end
123
124 {{html}}
125 <form action="$doc.getURL()" id="newdoc" method="post" class="xform half">
126 <fieldset>
127 <div class="hidden">
128 <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />
129 <input type="hidden" name="parent" value="${defaultParent}"/>
130 <input type="hidden" name="template" value="${classTemplateDoc}"/>
131 <input type="hidden" name="sheet" value="1"/>
132 </div>
133 #locationPicker({
134 'id': 'target',
135 'title': {
136 'label': 'core.create.title',
137 'hint': 'core.create.title.hint',
138 'name': 'docTitle',
139 'placeholder': 'core.create.name.placeholder'
140 },
141 'preview': {
142 'label': 'core.create.locationPreview.label',
143 'hint': 'core.create.locationPreview.hint'
144 },
145 'parent': {
146 'label': 'core.create.spaceReference.label',
147 'hint': 'core.create.spaceReference.hint',
148 'name': 'spaceName',
149 'reference': $services.model.resolveSpace($defaultSpace),
150 'placeholder': 'core.create.spaceReference.placeholder'
151 },
152 'name': {
153 'label': 'core.create.name.label',
154 'hint': 'core.create.name.hint',
155 'name': 'docName',
156 'placeholder': 'core.create.name.placeholder'
157 }
158 })
159 <p>
160 <span class="buttonwrapper">
161 <input type="submit" class="button" value="$escapetool.xml($services.localization.render(
162 'platform.xclass.defaultClassSheet.createPage.label'))"/>
163 </span>
164 </p>
165 </fieldset>
166 </form>
167 {{/html}}
168
169 #end## has class sheet and class template
170 (% id="HExistingPages" %)
171 = {{translation key="platform.xclass.defaultClassSheet.pages.heading"/}} =
172
173 {{translation key="platform.xclass.defaultClassSheet.pages.description"/}}
174
175 #set ($options = {
176 'className': $doc.fullName,
177 'translationPrefix' : 'platform.index.',
178 'queryFilters': ['unique']
179 })
180 {{liveData
181 id="classEntries"
182 properties="doc.title,doc.location,doc.date,doc.author,doc.objectCount,_actions"
183 source="liveTable"
184 className="${doc.fullName}"
185 sourceParameters="${escapetool.url($options)}"
186 }}
187 {
188 "meta": {
189 "propertyDescriptors": [
190 {
191 "id": "doc.title",
192 "editable": false
193 },
194 {
195 "id": "doc.objectCount",
196 "editable": false,
197 "filterable": false,
198 "sortable": false
199 }
200 ]
201 }
202 }
203 {{/liveData}}
204
205 (% id="HClassSheets" %)
206 = {{translation key="platform.xclass.defaultClassSheet.sheets.heading"/}} =
207 #if (!$hasClassSheets || !$hasClassTemplate)
208
209 {{translation key="platform.xclass.defaultClassSheet.sheets.missing"/}}
210 #end
211
212 {{info}}$services.localization.render('platform.xclass.defaultClassSheet.sheets.description', ['//', '//']){{/info}}
213
214 #if(!$hasClassSheets)
215 {{html}}
216 <form action="$xwiki.getURL($defaultClassSheetReference, 'save', 'editor=wiki')" method="post">
217 <div>
218 <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />
219 <input type="hidden" name="parent" value="${doc.fullName}"/>
220 <input type="hidden" name="xredirect" value="${doc.URL}"/>
221 #set ($sheetContent = $xwiki.getDocument('XWiki.ObjectSheet').getContent().replace('XWiki.MyClass',
222 $doc.fullName))
223 ## We have to encode the new line characters in order to preserve them, otherwise they are replace with a
224 ## space when the HTML is cleaned.
225 ## FIXME: Use a dedicated escape tool method when XCOMMONS-405 is implemented.
226 #set ($sheetContent = $escapetool.xml($sheetContent).replaceAll("\n", '&#10;'))
227 <input type="hidden" name="content" value="$sheetContent"/>
228 <input type="hidden" name="title" value="${escapetool.h}if(${escapetool.d}doc.documentReference.name == '$escapetool.xml($defaultClassSheetReference.name)')$escapetool.xml($className) Sheet${escapetool.h}{else}${escapetool.d}services.display.title(${escapetool.d}doc, {'displayerHint': 'default', 'outputSyntaxId': 'plain/1.0'})${escapetool.h}end"/>
229 <span class="buttonwrapper"><input type="submit" class="button" value="$escapetool.xml(
230 $services.localization.render('platform.xclass.defaultClassSheet.sheets.create'))"/></span>
231 </div>
232 </form>
233 {{/html}}
234 #else
235 #set($defaultClassSheetDoc = $xwiki.getDocument($defaultClassSheetReference))
236 #if($classSheetReferences.isEmpty() && !$defaultClassSheetDoc.getObject('XWiki.SheetClass'))
237 ## The sheet is not bound to the class.
238 #set($xredirect = $xwiki.relativeRequestURL)
239 #set($defaultClassSheetStringReference = $services.model.serialize($defaultClassSheetReference, "default"))
240 #set($bindURL = $doc.getURL('view', "bindSheet=${escapetool.url($defaultClassSheetStringReference)}&xredirect=${escapetool.url($xredirect)}&form_token=$!{services.csrf.getToken()}"))
241 {{warning}}
242 {{translation key="platform.xclass.defaultClassSheet.sheets.notBound"/}} ##
243 #if ($hasEdit)
244 {{html}}
245 <a href="$bindURL">$services.localization.render('platform.xclass.defaultClassSheet.sheets.bind') »</a>.
246 {{/html}}
247 #end
248 {{/warning}}
249
250 #end
251 #if ($classSheetReferences.size() < 2)
252 #set($classSheetDoc = $defaultClassSheetDoc)
253 #if(!$classSheetReferences.isEmpty())
254 #set($classSheetDoc = $xwiki.getDocument($classSheetReferences.get(0)))
255 #end
256 #set ($sheetPath = "#hierarchy($classSheetDoc.documentReference, {'plain': true, 'local': true, 'limit': 4})")
257 [[$services.localization.render('platform.xclass.defaultClassSheet.sheets.view', [$sheetPath.trim()]) »>>${classSheetDoc.fullName}]]
258 #else
259 {{translation key="platform.xclass.defaultClassSheet.sheets.list"/}}
260
261 #foreach($classSheetReference in $classSheetReferences)
262 * [[$services.model.serialize($classSheetReference, "default")]]
263 #end
264 #end
265 #end
266
267 (% id="HClassTemplate" %)
268 = {{translation key="platform.xclass.defaultClassSheet.template.heading"/}} =
269
270 {{info}}$services.localization.render('platform.xclass.defaultClassSheet.template.description',
271 ['//', '//']){{/info}}
272
273 #if (!$hasClassTemplate)
274 {{html}}
275 <form action="$classTemplateDoc.getURL('save', 'editor=wiki')" method="post">
276 <div>
277 <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />
278 <input type="hidden" name="parent" value="${doc.fullName}"/>
279 <input type="hidden" name="xredirect" value="${doc.URL}"/>
280 <input type="hidden" name="title" value="$className Template"/>
281 <span class="buttonwrapper"><input type="submit" class="button" value="$escapetool.xml(
282 $services.localization.render('platform.xclass.defaultClassSheet.template.create'))"/></span>
283 </div>
284 </form>
285 {{/html}}
286 #else
287 #if(!$classTemplateDoc.getObject(${doc.fullName}))
288 #set($xredirect = $xwiki.relativeRequestURL)
289 #set($createUrl = $classTemplateDoc.getURL('objectadd', "classname=${escapetool.url($doc.fullName)}&amp;xredirect=${escapetool.url($xredirect)}&amp;form_token=$!{services.csrf.getToken()}"))
290 {{warning}}
291 $services.localization.render('platform.xclass.defaultClassSheet.template.missingObject', ["//$className//"]) ##
292 {{html}}<a href="$createUrl">$escapetool.xml($services.localization.render(
293 'platform.xclass.defaultClassSheet.template.addObject', [$className])) »</a>.{{/html}}
294 {{/warning}}
295
296 #end
297 #set ($templatePath = "#hierarchy($classTemplateDoc.documentReference, {'plain': true, 'local': true, 'limit': 4})")
298 [[$services.localization.render('platform.xclass.defaultClassSheet.template.view',
299 [$templatePath.trim()]) »>>${classTemplateDoc.fullName}]]
300 #end
301 ## Create a template provider only if a template for the current class exists.
302 #if ($classTemplateDoc.getObject(${doc.fullName}))
303 (% id="HClassTemplateProvider" %)
304 = {{translation key="platform.xclass.defaultClassSheet.templateProvider.heading"/}} =
305
306 {{info}}$services.localization.render('platform.xclass.defaultClassSheet.templateProvider.description',
307 ['//']){{/info}}
308
309 #if (!$hasClassTemplateProvider)
310 #set ($templateProviderClassName = 'XWiki.TemplateProviderClass')
311 ## Do the page creation and object addition in one step, providing some default values.
312 ## In order to get the root space of the class and use it as restrictionSpace, we need to be sure that we have
313 ## the expected result for multiple level hierarchies, like MyApplication.Code.MyApplicationClass. In this case,
314 ## the template provider in enabled in MyApplication space.
315 #set ($restrictionSpace = $doc.documentReference.spaceReferences.get(0).name)
316 #set ($createUrlQueryString = $escapetool.url({
317 'classname': $templateProviderClassName,
318 'xredirect': $xwiki.relativeRequestURL,
319 'form_token': $services.csrf.token,
320 "${templateProviderClassName}_name": $className,
321 "${templateProviderClassName}_description":
322 $services.localization.render('platform.xclass.templateProvider.defaultDescription', [$className]),
323 "${templateProviderClassName}_template": $classTemplateDoc,
324 "${templateProviderClassName}_visibilityRestrictions": $restrictionSpace}))
325 #set ($createUrl = $classTemplateProviderDoc.getURL('objectadd', $createUrlQueryString))
326 {{html}}
327 <form action="$classTemplateProviderDoc.getURL('save', 'editor=wiki')" method="post">
328 <div>
329 <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />
330 <input type="hidden" name="parent" value="${doc.fullName}"/>
331 <input type="hidden" name="xredirect" value="$createUrl"/>
332 <input type="hidden" name="title" value="$className Template Provider"/>
333 <span class="buttonwrapper"><input type="submit" class="button" value="$escapetool.xml(
334 $services.localization.render('platform.xclass.defaultClassSheet.templateProvider.create'))"/></span>
335 </div>
336 </form>
337 {{/html}}
338 #else
339 #set ($templateProviderPath = "#hierarchy($classTemplateProviderDoc.documentReference, {'plain': true, 'local': true, 'limit': 4})")
340 [[$services.localization.render('platform.xclass.defaultClassSheet.templateProvider.view',
341 [$templateProviderPath.trim()]) »>>${classTemplateProviderDoc.fullName}]]
342 #end
343 #end
344
345 #end## !$isSheet
346 {{/velocity}}