Modifications pour le document MacroService

Résumé

• Propriétés de la Page (2 modifications, 0 ajouts, 0 suppressions)

Détails

Propriétés de la Page

Auteur du document

...	...	@@ -1,1 +1,1 @@
1		-xwiki:XWiki.fcharton
	1	+XWiki.superadmin

Contenu

...	...	@@ -38,67 +38,36 @@
38	38	## }
39	39	## ================================================================
40	40	#macro (getMacroList $syntaxId)
41		-
42		- ## Loads the css resources to display the macros list
43		- ## TODO: Refactor once we add support for loading css files from javascript without velocity.
44		- #if ($xcontext.action == 'get')
45		- #template('display_macros.vm')
46		- #initRequiredSkinExtensions()
47		- #end
48		-
49		- #set ($discard = $xwiki.linkx.use($services.webjars.url('selectize.js', 'css/selectize.bootstrap3.css'),
50		- {'type': 'text/css', 'rel': 'stylesheet'}))
51		- #set ($discard = $xwiki.ssfx.use('uicomponents/suggest/xwiki.selectize.css', true))
52		-
53		- #if ($xcontext.action == 'get')
54		- #getRequiredSkinExtensions($requiredSkinExtensions)
55		- #set ($discard = $response.setHeader('X-XWIKI-HTML-HEAD', $requiredSkinExtensions))
56		- #end
57		-
58	58	#set ($syntax = $services.rendering.resolveSyntax($syntaxId))
59	59	#set ($macroDescriptors = $services.rendering.getMacroDescriptors($syntax))
	43	+ #if (!$macroDescriptors)
	44	+ ## Before XWiki 9.7RC1 we had to use APIs that require programming rights.
	45	+ #set ($macroDescriptors = [])
	46	+ #try()
	47	+ #set ($macroManager = $services.component.getInstance('org.xwiki.rendering.macro.MacroManager'))
	48	+ #foreach ($macroId in $macroManager.getMacroIds($syntax))
	49	+ #set ($macroDescriptor = $macroManager.getMacro($macroId).descriptor)
	50	+ #set ($discard = $macroDescriptors.add($macroDescriptor))
	51	+ #end
	52	+ #end
	53	+ #end
60	60	#set ($data = {})
61	61	#set ($allMacrosExcludedCategories = [])
62	62	#set ($discard = $allMacrosExcludedCategories.add("#maybeTranslate('rendering.macroCategory.Internal' 'Internal')"))
63	63	#set ($discard = $allMacrosExcludedCategories.add("#maybeTranslate('rendering.macroCategory.Deprecated' 'Deprecated')"))
64	64	#set ($discard = $data.put('options', { 'allMacrosExcludedCategories' : $allMacrosExcludedCategories }))
65		- ## If the current user do not want to display hidden documents, we initialize the set of hidden default
66		- ## categories.
67		- ## TODO: Make the list of hidden by default categories configurable from the administration (XWIKI-19993).
68		- #if(!$services.user.getProperties().displayHiddenDocuments())
69		- #set ($hiddenCategories = $services.rendering.getHiddenMacroCategories())
70		- #else
71		- #set ($hiddenCategories = [])
72		- #end
73	73	#set ($macroList = [])
74		- #set ($installedMacros = [])
75	75	#foreach ($macroDescriptor in $macroDescriptors)
76		- #set ($discard = $installedMacros.add($macroDescriptor.id.id))
77		-
78	78	#set ($macroTranslationKey = "rendering.macro.$macroDescriptor.id")
79		- #set ($categories = [])
80		- #set ($hidden = false)
81		- #foreach ($category in $services.rendering.getMacroCategories($macroDescriptor.id))
82		- #set ($macroCategoryTranslationKey = "rendering.macroCategory.$category")
83		- #set ($hidden = $hidden || $hiddenCategories.contains($category))
84		- #set ($discard = $categories.add({
85		- 'id': $category,
86		- 'label': "#maybeTranslate($macroCategoryTranslationKey $category)"
87		- }))
88		- #end
89		-
90		- #if (!$hidden)
91		- #set ($defaultCategoryTranslation = "rendering.macroCategory.${macroDescriptor.defaultCategory}")
92		- #set ($discard = $macroList.add({
93		- 'id': $macroDescriptor.id,
94		- 'name': "#maybeTranslate(""${macroTranslationKey}.name"" $macroDescriptor.name)",
95		- 'description': "#maybeTranslate(""${macroTranslationKey}.description"" $macroDescriptor.description)",
96		- 'defaultCategory': "#maybeTranslate($defaultCategoryTranslation $macroDescriptor.defaultCategory)",
97		- 'categories': $categories
98		- }))
99		- #end
	62	+ #set ($macroCategoryTranslationKey = "rendering.macroCategory.$macroDescriptor.defaultCategory")
	63	+ #set ($discard = $macroList.add({
	64	+ 'id': $macroDescriptor.id,
	65	+ 'name': "#maybeTranslate(""${macroTranslationKey}.name"" $macroDescriptor.name)",
	66	+ 'description': "#maybeTranslate(""${macroTranslationKey}.description"" $macroDescriptor.description)",
	67	+ 'defaultCategory': "#maybeTranslate($macroCategoryTranslationKey $macroDescriptor.defaultCategory)"
	68	+ }))
100	100	#end
101		- #set ($macroList = $collectiontool.sort($macroList, 'name'))
	70	+ #set ($macroList = $resolvedSortTool.sort($macroList, 'name'))
102	102	#set ($discard = $data.put('list', $macroList))
103	103	## Get macros provided by compatible available extensions
104	104	#set ($macroExtensionsList = [])
...	...	@@ -115,13 +115,11 @@
115	115	#set ($macroExtensionsMap = {})
116	116	#foreach ($extension in $extensions)
117	117	## TODO: move to a proper generic API to check if an extension can be installed by a given user
118		- #set ($extensionInstallAllowed = $services.security.authorization.hasAccess('programming', $xcontext.userReference, $NULL)
	87	+ #if ($services.security.authorization.hasAccess('programming')
119	119	|| (($extension.type == 'xar' || $extension.type == 'webjar')
120		- && $services.security.authorization.hasAccess('admin', $xcontext.userReference, "wiki:$xcontext.database") && $services.extension.isAllowed($extension, "wiki:$xcontext.database")))
121		- #foreach ($extensionComponent in $extension.getComponents())
122		- #if ($extensionComponent.roleType == 'org.xwiki.rendering.macro.Macro')
123		- ## Skip macros identifiers for which a macro is already installed
124		- #if (!$installedMacros.contains($extensionComponent.roleHint))
	89	+ && $services.security.authorization.hasAccess('admin', "wiki:$xcontext.database") && $services.extension.isAllowed($extension, "wiki:$xcontext.database")))
	90	+ #foreach ($extensionComponent in $extension.getComponents())
	91	+ #if ($extensionComponent.roleType == 'org.xwiki.rendering.macro.Macro')
125	125	#set ($discard = $macroExtensionsList.add({
126	126	'id' : {
127	127	'id' : $extensionComponent.roleHint
...	...	@@ -129,17 +129,12 @@
129	129	'name': $extensionComponent.roleHint,
130	130	'description': $extension.summary,
131	131	'defaultCategory': '_notinstalled',
132		- 'categories': [{
133		- 'id' :'_notinstalled',
134		- 'label': $services.localization.render('macroSelector.filter.category.notinstalled')
135		- }],
136	136	'extensionId' : $extension.id.id,
137	137	'extensionVersion' : $extension.id.version.value,
138	138	'extensionType' : $extension.type,
139	139	'extensionRecommended': $extension.recommended,
140	140	'extensionName': $extension.name,
141		- 'extensionSummary': $extension.summary,
142		- 'extensionInstallAllowed': $extensionInstallAllowed
	104	+ 'extensionSummary': $extension.summary
143	143	}))
144	144	#end
145	145	#end
...	...	@@ -150,16 +150,236 @@
150	150	#end
151	151
152	152	#macro (maybeGetMacroDescriptor $macroIdAsString)
153		- #ckeditor_initRequiredSkinExtensions()
154		- #set ($macroDescriptor = $services.wysiwyg.getMacroDescriptorUI($macroIdAsString))
	115	+ #set ($xmacro = $NULL)
	116	+ #set ($macroDescriptor = $NULL)
	117	+ #set ($macroId = $services.rendering.resolveMacroId($macroIdAsString))
	118	+ #if ($macroId)
	119	+ #set ($macroDescriptor = $services.rendering.getMacroDescriptor($macroId))
	120	+ #if (!$macroDescriptor && $macroId.syntax)
	121	+ ## Try the macro id without the syntax.
	122	+ #set ($macroId = $services.rendering.resolveMacroId($macroId.id))
	123	+ #set ($macroDescriptor = $services.rendering.getMacroDescriptor($macroId))
	124	+ #end
	125	+ #else
	126	+ ## Either the macro id could not be resolved (unlikely) or we are on an older XWiki instance (before 10.10RC1) where
	127	+ ## we had to use APIs that require programming rights.
	128	+ #getMacroWithPR($macroIdAsString)
	129	+ #if ($xmacro)
	130	+ #set ($macroDescriptor = $xmacro.descriptor)
	131	+ #end
	132	+ #end
155	155	#if ($macroDescriptor)
156		- #set ($data = {
157		- 'descriptor': $macroDescriptor,
158		- 'requiredSkinExtensions': "#ckeditor_getRequiredSkinExtensions()"
	134	+ #getMacroDescriptor($macroDescriptor)
	135	+ #if ($xmacro)
	136	+ ## supportsInlineMode was not exposed on the macro descriptor before XWiki 10.10RC1.
	137	+ #set ($data.supportsInlineMode = $xmacro.supportsInlineMode())
	138	+ #end
	139	+ #end
	140	+#end
	141	+
	142	+#macro (getMacroWithPR $macroIdAsString)
	143	+ #set ($xmacro = $NULL)
	144	+ #try()
	145	+ #set ($macroIdFactory = $services.component.getInstance('org.xwiki.rendering.macro.MacroIdFactory'))
	146	+ #set ($macroId = $macroIdFactory.createMacroId($macroIdAsString))
	147	+ #set ($macroManager = $services.component.getInstance('org.xwiki.rendering.macro.MacroManager'))
	148	+ #if ($macroManager.exists($macroId))
	149	+ #set ($xmacro = $macroManager.getMacro($macroId))
	150	+ #elseif ($macroId.syntax)
	151	+ ## Try the macro id without the syntax.
	152	+ #set ($macroId = $macroIdFactory.createMacroId($macroId.id))
	153	+ #if ($macroManager.exists($macroId))
	154	+ #set ($xmacro = $macroManager.getMacro($macroId))
	155	+ #end
	156	+ #end
	157	+ #end
	158	+#end
	159	+
	160	+#macro (getMacroDescriptor $macroDescriptor)
	161	+ ## Translate the macro name and description.
	162	+ #set ($macroTranslationKey = "rendering.macro.$macroDescriptor.id")
	163	+ #ckeditor_initRequiredSkinExtensions()
	164	+ #set ($data = {
	165	+ 'id': $macroDescriptor.id,
	166	+ 'name': "#maybeTranslate(""${macroTranslationKey}.name"" $macroDescriptor.name)",
	167	+ 'description': "#maybeTranslate(""${macroTranslationKey}.description"" $macroDescriptor.description)",
	168	+ 'defaultCategory': $macroDescriptor.defaultCategory,
	169	+ 'supportsInlineMode': $macroDescriptor.supportsInlineMode(),
	170	+ 'parameterDescriptorMap': {}
	171	+ })
	172	+ #if ($macroDescriptor.contentDescriptor)
	173	+ ## Translate the content label and description.
	174	+ ## Treat the macro content as if it is the last macro parameter.
	175	+ #set ($data.contentDescriptor = {
	176	+ 'name': "#maybeTranslate('rendering.macroContent' 'Content')",
	177	+ 'description': "#maybeTranslate(""${macroTranslationKey}.content.description""
	178	+ $macroDescriptor.contentDescriptor.description)",
	179	+ 'mandatory': $macroDescriptor.contentDescriptor.mandatory,
	180	+ 'deprecated': $macroDescriptor.contentDescriptor.deprecated,
	181	+ 'advanced': $macroDescriptor.contentDescriptor.advanced,
	182	+ 'defaultValue': $macroDescriptor.contentDescriptor.defaultValue,
	183	+ 'type': $macroDescriptor.contentDescriptor.type,
	184	+ 'editTemplate': '<textarea name="$content" rows="7"></textarea>',
	185	+ 'index': $macroDescriptor.parameterDescriptorMap.size()
159	159	})
	187	+ #fixDescriptorType($data.contentDescriptor)
160	160	#end
	189	+ #set ($groupDescriptorTree = {})
	190	+ #foreach ($entry in $macroDescriptor.parameterDescriptorMap.entrySet())
	191	+ #set ($parameterDescriptor = $entry.value)
	192	+ ## Translate the parameter name and description.
	193	+ #set ($parameterTranslationKey = "${macroTranslationKey}.parameter.$parameterDescriptor.id")
	194	+ ## Note: The displayHidden parameter is new in XWiki 12.4RC1 so make sure we set 'hidden' to false if it doesn't
	195	+ ## exist
	196	+ #if ("$!parameterDescriptor.displayHidden" != '')
	197	+ #set ($parameterHidden = $parameterDescriptor.displayHidden)
	198	+ #else
	199	+ #set ($parameterHidden = false)
	200	+ #end
	201	+ #set ($translatedParameterDescriptor = {
	202	+ 'id': $parameterDescriptor.id,
	203	+ 'name': "#maybeTranslate(""${parameterTranslationKey}.name"" $parameterDescriptor.name)",
	204	+ 'description': "#maybeTranslate(""${parameterTranslationKey}.description"" $parameterDescriptor.description)",
	205	+ 'mandatory': $parameterDescriptor.mandatory,
	206	+ 'deprecated': $parameterDescriptor.deprecated,
	207	+ 'advanced': $parameterDescriptor.advanced,
	208	+ 'defaultValue': $parameterDescriptor.defaultValue,
	209	+ 'type': $parameterDescriptor.displayType,
	210	+ 'hidden' : $parameterHidden,
	211	+ 'index': $foreach.index
	212	+ })
	213	+ #if ("$!translatedParameterDescriptor.type" == '')
	214	+ ## displayType is not available before XWiki 11.0 so we need to fall back on parameterType.
	215	+ #set ($translatedParameterDescriptor.type = $parameterDescriptor.parameterType)
	216	+ #end
	217	+ #set ($translatedParameterDescriptor.caseInsensitive = $translatedParameterDescriptor.type.isEnum())
	218	+ #set ($groupDescriptor = $parameterDescriptor.groupDescriptor)
	219	+ #if ($groupDescriptor)
	220	+ #handleMacroParameterGroup($groupDescriptor $groupDescriptorTree $translatedParameterDescriptor)
	221	+ #end
	222	+ #if ($translatedParameterDescriptor.type.getName() == 'java.lang.String'
	223	+ && ($parameterDescriptor.defaultValue == 'false' || $parameterDescriptor.defaultValue == 'true')
	224	+ && $macroDescriptor.parametersBeanClass.getSimpleName() == 'WikiMacroParameters')
	225	+ #set ($translatedParameterDescriptor.defaultValue = $parameterDescriptor.defaultValue == 'true')
	226	+ #set ($translatedParameterDescriptor.type = $translatedParameterDescriptor.defaultValue.getClass())
	227	+ #end
	228	+ #set ($htmlDisplayerParameters = {'name': $parameterDescriptor.id})
	229	+ #if ($translatedParameterDescriptor.group)
	230	+ #set ($discard = $htmlDisplayerParameters.put('data-property-group',
	231	+ $stringtool.join($translatedParameterDescriptor.group, '/')))
	232	+ #end
	233	+ #set ($translatedParameterDescriptor.editTemplate = $services.display.html.display(
	234	+ $translatedParameterDescriptor.type, $translatedParameterDescriptor.defaultValue, $htmlDisplayerParameters, 'edit'
	235	+ ))
	236	+ #if ("$!translatedParameterDescriptor.editTemplate" == '')
	237	+ #set ($translatedParameterDescriptor.editTemplate = "#getMacroParameterEditTemplate(
	238	+ $translatedParameterDescriptor)")
	239	+ #end
	240	+ #set ($translatedParameterDescriptor.editTemplate = $translatedParameterDescriptor.editTemplate.trim())
	241	+ #fixDescriptorType($translatedParameterDescriptor)
	242	+ ## Make sure the key is lowercase (for XWiki <9.0).
	243	+ ## See XWIKI-13990: Inconsistency between Java-based and Wiki-based rendering macros regarding the parameter
	244	+ ## descriptor map keys
	245	+ #set ($discard = $data.parameterDescriptorMap.put($entry.key.toLowerCase(), $translatedParameterDescriptor))
	246	+ #end
	247	+ #if ($groupDescriptorTree.groups)
	248	+ #set ($data.groupDescriptorTree = $groupDescriptorTree.groups)
	249	+ #end
	250	+ #set ($data.requiredSkinExtensions = "#ckeditor_getRequiredSkinExtensions()")
161	161	#end
162	162
	253	+#macro (fixDescriptorType $descriptor)
	254	+ ## The goal of this code is to obtain a normalized string representation of the type specified in the descriptor.
	255	+ ## See XCOMMONS-1583: Define a stable way to serialize types
	256	+ ##
	257	+ ## The type specified in the descriptor can be any implementation of java.lang.reflect.Type, not necessarily a
	258	+ ## java.lang.Class. We can't use toString() because the return of Class#toString() is different than Class#getName().
	259	+ ## We can't use Type#getTypeName() either because the access to this method is restricted from Velocity. The only
	260	+ ## option for now is to try #getName() first and fall back on #toString() for types that are not instances of
	261	+ ## java.lang.Class.
	262	+ #set ($typeName = $descriptor.type.getName())
	263	+ #if ("$!typeName" == '')
	264	+ ## Probably not a java.lang.Class. Fall back on #toString().
	265	+ #set ($typeName = "$!descriptor.type")
	266	+ #end
	267	+ ## Remove whitespace from the type name in order to have a single string representation.
	268	+ #set ($descriptor.type = $typeName.replaceAll('\s+', ''))
	269	+#end
	270	+
	271	+## Builds the group tree with the following structure:
	272	+##
	273	+## {
	274	+## 'parentGroupId': {
	275	+## 'id': 'parentGroupId',
	276	+## 'name': 'Parent Group',
	277	+## 'feature': 'someFeature',
	278	+## 'groups': {
	279	+## 'childGroupId': {...},
	280	+## ...
	281	+## }
	282	+## },
	283	+## ...
	284	+## }
	285	+#macro (handleMacroParameterGroup $groupDescriptor $groupDescriptorTree $translatedParameterDescriptor)
	286	+ #if ($groupDescriptor.group && $groupDescriptor.group.size() > 0)
	287	+ #set ($translatedParameterDescriptor.group = $groupDescriptor.group)
	288	+ #set ($parentGroup = $groupDescriptorTree)
	289	+ #foreach ($groupId in $groupDescriptor.group)
	290	+ #if (!$parentGroup.groups)
	291	+ #set ($parentGroup.groups = {})
	292	+ #end
	293	+ #set ($childGroup = $parentGroup.groups.get($groupId))
	294	+ #if (!$childGroup)
	295	+ #if ($groupId == $translatedParameterDescriptor.id)
	296	+ #set ($groupName = $translatedParameterDescriptor.name)
	297	+ #else
	298	+ #set ($groupTranslationKey = "${macroTranslationKey}.group.$groupId")
	299	+ #set ($groupName = "#maybeTranslate(""${groupTranslationKey}.name"" $groupId)")
	300	+ #end
	301	+ #set ($childGroup = {
	302	+ 'id': $groupId,
	303	+ 'name': $groupName
	304	+ })
	305	+ #set ($discard = $parentGroup.groups.put($groupId, $childGroup))
	306	+ #end
	307	+ #set ($parentGroup = $childGroup)
	308	+ #end
	309	+ #if ("$!groupDescriptor.feature" != '')
	310	+ #set ($parentGroup.feature = $groupDescriptor.feature)
	311	+ #end
	312	+ #elseif ($groupDescriptor.feature)
	313	+ ## This group is made of a single parameter. The feature then refers to this parameter.
	314	+ #set ($translatedParameterDescriptor.feature = $groupDescriptor.feature)
	315	+ #end
	316	+#end
	317	+
	318	+#macro (getMacroParameterEditTemplate $translatedParameterDescriptor)
	319	+ #if ($translatedParameterDescriptor.type.getName() == 'boolean'
	320	+ || $translatedParameterDescriptor.type.getName() == 'java.lang.Boolean')
	321	+ <input type="checkbox" name="$escapetool.xml($translatedParameterDescriptor.id)" value="true"/>##
	322	+ ## We need to submit something in case the checkbox is not checked.
	323	+ <input type="hidden" name="$escapetool.xml($translatedParameterDescriptor.id)" value="false"/>
	324	+ #elseif ($translatedParameterDescriptor.type.isEnum())
	325	+ #if ($translatedParameterDescriptor.defaultValue)
	326	+ #set ($enumValues = $translatedParameterDescriptor.defaultValue.values())
	327	+ #else
	328	+ ## A parameter of type enum that doesn't have a default value is very unlikely. We attempt to read the list of
	329	+ ## possible values from the enum type in this case, which is currently forbidden, but at least it will generate
	330	+ ## a warning in the logs that will help us investigate the problem.
	331	+ #set ($enumValues = $translatedParameterDescriptor.type.getEnumConstants())
	332	+ #end
	333	+ <select name="$escapetool.xml($translatedParameterDescriptor.id)">##
	334	+ #foreach ($enumValue in $enumValues)
	335	+ #set ($value = $enumValue.name())
	336	+ #set ($label = "#maybeTranslate(""${parameterTranslationKey}.value.$value"" $enumValue)")
	337	+ <option value="$escapetool.xml($value)">$escapetool.xml($label)</option>##
	338	+ #end
	339	+ </select>
	340	+ #else
	341	+ <input type="text" name="$escapetool.xml($translatedParameterDescriptor.id)"/>
	342	+ #end
	343	+#end
	344	+
163	163	#macro (maybeTranslate $key $defaultValue)
164	164	#if ($services.localization.get($key))
165	165	$services.localization.render($key)##
...	...	@@ -209,19 +209,9 @@
209	209	$response.sendError(404, $exceptiontool.getRootCauseMessage($job.status.error))
210	210	#end
211	211	#end
	394	+{{/velocity}}
212	212
213		-#macro (getMacroParameters $macroId $macroParameters)
214		- #set ($macroId = $services.rendering.resolveMacroId($macroId))
215		- #set ($macroParameters = $jsontool.fromString($macroParameters))
216		- #foreach($macroParameter in $macroParameters.entrySet())
217		- ## TODO: Do we need to take into account the macro parameter type? We could have a macro parameter that is editable
218		- ## inline but whose value is not a List<Block> but rather a String (plain text).
219		- #set ($macroParameter.value = $services.wysiwyg.fromAnnotatedXHTML($macroParameter.value, $macroId.syntax))
220		- #end
221		- #set ($data = $macroParameters)
222		-#end
223		-
224		-#set ($data = $NULL)
	396	+{{velocity wiki="false"}}
225	225	#if ("$!request.action" == 'install')
226	226	#if ($services.csrf.isTokenValid($request.form_token))
227	227	#installMacroExtension($request.extensionId, $request.extensionVersion)
...	...	@@ -228,18 +228,18 @@
228	228	#else
229	229	$response.sendError(403)
230	230	#end
231		-#elseif ($request.data == 'list')
232		- #getMacroList($request.syntaxId)
233		-#elseif ($request.data == 'descriptor')
234		- #maybeGetMacroDescriptor($request.macroId)
235		-#elseif ($request.data == 'macroParameters')
236		- #getMacroParameters($request.macroId, $request.macroParameters)
	403	+#elseif ("$!request.data" != '')
	404	+ #set ($data = $NULL)
	405	+ #if ($request.data == 'list')
	406	+ #getMacroList($request.syntaxId)
	407	+ #elseif ($request.data == 'descriptor')
	408	+ #maybeGetMacroDescriptor($request.macroId)
	409	+ #end
	410	+ #if ($data)
	411	+ #set ($discard = $response.setContentType('application/json'))
	412	+ $jsontool.serialize($data)
	413	+ #else
	414	+ $response.sendError(404)
	415	+ #end
237	237	#end
238		-#if ($response.isCommitted())
239		- ## Do nothing.
240		-#elseif ($data)
241		- #jsonResponse($data)
242		-#elseif ("$!request.action" != '' || "$!request.data" != '')
243		- $response.sendError(404)
244		-#end
245	245	{{/velocity}}