Changes for page MentionsMacro

Summary

• Objects (3 modified, 1 added, 0 removed)
  • XWiki.JavaScriptExtension[0]
  • XWiki.StyleSheetExtension[0]
  • XWiki.WikiMacroClass[0]
  • XWiki.WikiMacroParameterClass[3]

Details

XWiki.JavaScriptExtension[0]

Code

...	...	@@ -4,16 +4,7 @@
4	4	"?v=$escapetool.url($xwiki.version)"
5	5	}
6	6	});
7		-require(['deferred!ckeditor', 'xwiki-suggestUsers', 'jquery'], function (ckeditorPromise, suggestUsers, $) {
8		- /*
9		- * Keep records of the added anchors during the current edit session.
10		- * Note that the anchors saved here are not only the ones added on the current session,
11		- * but also those already present in the document.
12		- * For more information, see #getAnchor.
13		- * The information are stored on the form:
14		- * { reference: Array<String> }
15		- */
16		- const anchorIds = {};
	7	+require(['deferred!ckeditor', 'xwiki-suggestUsers', 'jquery', 'xwiki-meta'], function (ckeditorPromise, suggestUsers, $, xm) {
17	17
18	18	/**
19	19	* Get the current wiki scope for displaying global, local or global and local users
...	...	@@ -20,38 +20,28 @@
20	20	*/
21	21	const userScope = "$!services.wiki.user.userScope";
22	22
	14	+ // see https://stackoverflow.com/a/6248722/657524
	15	+ function random6chars() {
	16	+ // I generate the UID from two parts here
	17	+ // to ensure the random number provide enough bits.
	18	+ var firstPart = (Math.random() * 46656) | 0;
	19	+ var secondPart = (Math.random() * 46656) | 0;
	20	+ firstPart = ("000" + firstPart.toString(36)).slice(-3);
	21	+ secondPart = ("000" + secondPart.toString(36)).slice(-3);
	22	+ return firstPart + secondPart;
	23	+ }
	24	+
23	23	/**
24	24	* Compute a new unique anchor for the given reference.
25		- * The uniqueness of the anchor is given by two mechanisms:
26		- * - retrieve on first call all mentions available on current document and store them
27		- * - then use that information to compute a next anchor not overlapping an existing one on the current document.
28		- * The mechanism is obviously not perfect and might be improved later but should be enough for most usage.
	27	+ * The unique anchor is based on the mentionned user id, concatenaed with a random string of 6 alphanumeric
	28	+ * characters.
	29	+ * The chances of collision are quite low, about 46k mentions for a given mentioned user on a given page (assuming
	30	+ * that no mentions are ever deleted).
29	29	*/
30	30	const getAnchor = function (reference) {
31		- var existingIds;
32		-
33		- if (anchorIds.hasOwnProperty(reference)) {
34		- existingIds = anchorIds[reference];
35		- } else {
36		- existingIds = [];
37		- $('.xwiki-mention').each(function() {
38		- var mention = $(this);
39		- if (mention.attr('data-reference') === reference) {
40		- existingIds.push(mention.attr('id'));
41		- }
42		- });
43		- anchorIds[reference] = existingIds;
44		- }
45		-
46		- var counter = existingIds.length + 1;
47		- var refId = reference.replace(/[.:]/g, '-');
48		- var proposedAnchor = refId + "-" + counter;
49		- while (existingIds.indexOf(proposedAnchor) != -1) {
50		- counter++;
51		- proposedAnchor = refId + "-" + counter;
52		- }
53		- anchorIds[reference].push(proposedAnchor);
54		- return proposedAnchor;
	33	+ const refId = reference.replace(/[.:]/g, '-');
	34	+ const randomId = random6chars();
	35	+ return refId + '-' + randomId;
55	55	};
56	56
57	57	const search = function (text, callback) {
...	...	@@ -135,4 +135,3 @@
135	135	};
136	136	});
137	137	});
138		-

XWiki.StyleSheetExtension[0]

Code

...	...	@@ -11,3 +11,7 @@
11	11	.xwiki-mention.removed {
12	12	text-decoration: line-through;
13	13	}
	14	+
	15	+blockquote.mention-quote {
	16	+ font-size: inherit;
	17	+}

XWiki.WikiMacroClass[0]

Macro code

...	...	@@ -1,26 +1,16 @@
1	1	{{velocity}}
2	2	#set ($reference = $wikimacro.parameters.reference)
3	3	#set ($style = $wikimacro.parameters.style)
	4	+#set ($type = "$!wikimacro.parameters.type")
	5	+#set ($content = $services.mentions.format($reference.reference, $style, $type))
4	4	#set ($anchor = $wikimacro.parameters.anchor)
5		-#set ($userProperties = $services.user.getProperties($reference))
6		-#set ($firstName = $userProperties.getFirstName())
7		-#set ($lastName = $userProperties.getLastName())
8		-#set ($isCurrentUser = $xcontext.userReference == $reference.reference)
	7	+#set ($isCurrentUser = $xcontext.userReference == $reference.reference && ($type == '' || $type == 'user'))
9	9	#set ($cssClasses = ['xwiki-mention', 'user'])
10	10	#if ($isCurrentUser)
11	11	#set ($discard = $cssClasses.add('self'))
12	12	#end
13		-#if ("$!firstName" == "")
14		- #set($content = "@$reference.reference.name")
15		-#elseif ($style == 'FIRST_NAME')
16		- #set($content = "@$firstName")
17		-#elseif ($style == 'LOGIN')
18		- #set($content = "@$reference.reference.name")
19		-#else
20		- #set($content = "@$firstName $!lastName")
21		-#end
22	22	#set ($link = $xwiki.getURL($reference.reference, 'view'))
23	23	{{html}}
24		-<a id="$anchor" class="$stringtool.join($cssClasses, ' ')" data-reference="$services.model.serialize($reference.reference, 'compactwiki')" href="$link">$content</a>
	14	+<a id="$anchor" class="$stringtool.join($cssClasses, ' ')" data-reference="$services.model.serialize($reference.reference, 'default')" href="$link">$content</a>
25	25	{{/html}}
26	26	{{/velocity}}

XWiki.WikiMacroParameterClass[3]

Parameter description

...	...	@@ -1,0 +1,1 @@
	1	+The type of mentioned actor.

Parameter name

...	...	@@ -1,0 +1,1 @@
	1	+type

Parameter type

...	...	@@ -1,0 +1,1 @@
	1	+java.lang.String