From 8fdca4dc05a4bfde83d45bf2f6f1064d447f729e Mon Sep 17 00:00:00 2001
From: Alexander Ebert <ebert@woltlab.com>
Date: Fri, 12 Aug 2016 15:45:50 +0200
Subject: [PATCH] Using alternate approach to deal with mentions

Using a custom element has too many drawbacks and issues, all though
being far more elegant, it is just not worth it.
---
 com.woltlab.wcf/bbcode.xml                    | 10 +++
 com.woltlab.wcf/objectType.xml                |  5 ++
 ...deWoltlabMention.tpl => userBBCodeTag.tpl} |  2 +-
 com.woltlab.wcf/templates/wysiwyg.tpl         | 22 ------
 .../install/files/acp/templates/wysiwyg.tpl   | 10 ---
 .../redactor2/plugins/WoltLabMention.js       |  2 -
 .../WoltLabSuite/Core/Ui/Redactor/Mention.js  | 10 +--
 .../lib/system/bbcode/UserBBCode.class.php    | 37 +++++++++
 .../filter/MessageHtmlInputFilter.class.php   |  6 --
 .../node/HtmlInputNodeTextParser.class.php    |  8 +-
 .../HtmlInputNodeWoltlabMention.class.php     | 48 -----------
 .../HtmlOutputNodeWoltlabMention.class.php    | 79 -------------------
 ...UserMessageEmbeddedObjectHandler.class.php | 35 ++++++++
 .../BBCodeSelectUserGroupOptionType.class.php |  2 +-
 .../files/lib/util/MessageUtil.class.php      |  8 +-
 15 files changed, 101 insertions(+), 183 deletions(-)
 rename com.woltlab.wcf/templates/{htmlNodeWoltlabMention.tpl => userBBCodeTag.tpl} (98%)
 create mode 100644 wcfsetup/install/files/lib/system/bbcode/UserBBCode.class.php
 delete mode 100644 wcfsetup/install/files/lib/system/html/input/node/HtmlInputNodeWoltlabMention.class.php
 delete mode 100644 wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeWoltlabMention.class.php
 create mode 100644 wcfsetup/install/files/lib/system/message/embedded/object/UserMessageEmbeddedObjectHandler.class.php

diff --git a/com.woltlab.wcf/bbcode.xml b/com.woltlab.wcf/bbcode.xml
index 994191ce16..405afd3774 100644
--- a/com.woltlab.wcf/bbcode.xml
+++ b/com.woltlab.wcf/bbcode.xml
@@ -227,5 +227,15 @@
 				</attribute>
 			</attributes>
 		</bbcode>
+		
+		<bbcode name="user">
+			<classname>wcf\system\bbcode\UserBBCode</classname>
+			<attributes>
+				<attribute name="0">
+					<validationpattern>^\d+$</validationpattern>
+					<required>1</required>
+				</attribute>
+			</attributes>
+		</bbcode>
 	</import>
 </data>
diff --git a/com.woltlab.wcf/objectType.xml b/com.woltlab.wcf/objectType.xml
index 7e8e7d8253..238c692a73 100644
--- a/com.woltlab.wcf/objectType.xml
+++ b/com.woltlab.wcf/objectType.xml
@@ -770,6 +770,11 @@
 			<definitionname>com.woltlab.wcf.message.embeddedObject</definitionname>
 			<classname>wcf\system\message\embedded\object\MediaMessageEmbeddedObjectHandler</classname>
 		</type>
+		<type>
+			<name>com.woltlab.wcf.user</name>
+			<definitionname>com.woltlab.wcf.message.embeddedObject</definitionname>
+			<classname>wcf\system\message\embedded\object\UserMessageEmbeddedObjectHandler</classname>
+		</type>
 		<!-- embedded object handlers -->
 		
 		<type>
diff --git a/com.woltlab.wcf/templates/htmlNodeWoltlabMention.tpl b/com.woltlab.wcf/templates/userBBCodeTag.tpl
similarity index 98%
rename from com.woltlab.wcf/templates/htmlNodeWoltlabMention.tpl
rename to com.woltlab.wcf/templates/userBBCodeTag.tpl
index ac2b3d7e47..540243b6c1 100644
--- a/com.woltlab.wcf/templates/htmlNodeWoltlabMention.tpl
+++ b/com.woltlab.wcf/templates/userBBCodeTag.tpl
@@ -4,4 +4,4 @@
 {else}
 	{* non-breaking space below to prevent wrapping of user avatar and username *}
 	<a href="{link controller='User' object=$userProfile->getDecoratedObject()}{/link}">{@$userProfile->getAvatar()->getImageTag(16)}&nbsp;{$userProfile->username}</a>
-{/if}
\ No newline at end of file
+{/if}
diff --git a/com.woltlab.wcf/templates/wysiwyg.tpl b/com.woltlab.wcf/templates/wysiwyg.tpl
index ac556360d4..00ed92391c 100644
--- a/com.woltlab.wcf/templates/wysiwyg.tpl
+++ b/com.woltlab.wcf/templates/wysiwyg.tpl
@@ -1,25 +1,3 @@
-<style>
-	woltlab-mention {
-		background-color: rgb(241, 246, 251);
-		border: 1px solid rgb(176, 200, 224);
-		border-radius: 2px;
-		display: inline-block;
-		margin: 0 3px;
-		padding: 0 2px;
-	}
-	
-	woltlab-mention::before {
-		color: rgb(125, 130, 135);
-		content: "@";
-		padding-right: 2px;
-	}
-	
-	woltlab-mention::after {
-		color: rgb(44, 62, 80);
-		content: attr(data-username);
-	}
-</style>
-
 <script data-relocate="true">
 	head.load([
 		{if ENABLE_DEBUG_MODE}
diff --git a/wcfsetup/install/files/acp/templates/wysiwyg.tpl b/wcfsetup/install/files/acp/templates/wysiwyg.tpl
index 973115b20d..00ed92391c 100644
--- a/wcfsetup/install/files/acp/templates/wysiwyg.tpl
+++ b/wcfsetup/install/files/acp/templates/wysiwyg.tpl
@@ -1,13 +1,3 @@
-<style>
-	woltlab-mention {
-		background-color: rgb(240, 248, 255);
-		border: 1px solid rgb(52, 152, 219);
-		display: inline-block;
-		margin: 0 3px;
-		padding: 0 2px;
-	}
-</style>
-
 <script data-relocate="true">
 	head.load([
 		{if ENABLE_DEBUG_MODE}
diff --git a/wcfsetup/install/files/js/3rdParty/redactor2/plugins/WoltLabMention.js b/wcfsetup/install/files/js/3rdParty/redactor2/plugins/WoltLabMention.js
index 6bb45fbcc2..73595dcbc4 100644
--- a/wcfsetup/install/files/js/3rdParty/redactor2/plugins/WoltLabMention.js
+++ b/wcfsetup/install/files/js/3rdParty/redactor2/plugins/WoltLabMention.js
@@ -3,8 +3,6 @@ $.Redactor.prototype.WoltLabMention = function() {
 	
 	return {
 		init: function() {
-			//var WoltLabMention = document.registerElement('woltlab-mention');
-			
 			require(['WoltLabSuite/Core/Ui/Redactor/Mention'], (function(UiRedactorMention) {
 				new UiRedactorMention(this);
 			}).bind(this));
diff --git a/wcfsetup/install/files/js/WoltLabSuite/Core/Ui/Redactor/Mention.js b/wcfsetup/install/files/js/WoltLabSuite/Core/Ui/Redactor/Mention.js
index a86ac9a559..11cc32de5b 100644
--- a/wcfsetup/install/files/js/WoltLabSuite/Core/Ui/Redactor/Mention.js
+++ b/wcfsetup/install/files/js/WoltLabSuite/Core/Ui/Redactor/Mention.js
@@ -143,16 +143,8 @@ define(['Ajax', 'Environment', 'EventHandler', 'Ui/Alignment'], function(Ajax, E
 			range.deleteContents();
 			range.collapse(true);
 			
-			var mention = elCreate('woltlab-mention');
-			elAttr(mention, 'contenteditable', 'false');
-			elData(mention, 'user-id', elData(item, 'user-id'));
-			elData(mention, 'username', elData(item, 'username'));
-			
-			// U+200C = zero width non-joiner
-			var text = document.createTextNode('\u200c');
-			
+			var text = document.createTextNode('@' + elData(item, 'username') + '\u00A0');
 			range.insertNode(text);
-			range.insertNode(mention);
 			
 			newRange = document.createRange();
 			newRange.selectNode(text);
diff --git a/wcfsetup/install/files/lib/system/bbcode/UserBBCode.class.php b/wcfsetup/install/files/lib/system/bbcode/UserBBCode.class.php
new file mode 100644
index 0000000000..d8bc47be60
--- /dev/null
+++ b/wcfsetup/install/files/lib/system/bbcode/UserBBCode.class.php
@@ -0,0 +1,37 @@
+<?php
+namespace wcf\system\bbcode;
+use wcf\data\user\UserProfile;
+use wcf\system\message\embedded\object\MessageEmbeddedObjectManager;
+use wcf\system\WCF;
+
+/**
+ * Parses the [user] bbcode tag.
+ *
+ * @author      Alexander Ebert
+ * @copyright   2001-2016 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package     WoltLabSuite\Core\System\Bbcode
+ * @since       3.0
+ */
+class UserBBCode extends AbstractBBCode {
+	/**
+	 * @inheritDoc
+	 */
+	public function getParsedTag(array $openingTag, $content, array $closingTag, BBCodeParser $parser) {
+		$userID = (!empty($openingTag['attributes'][0])) ? intval($openingTag['attributes'][0]) : 0;
+		if (!$userID) {
+			return "[user]{$content}[/user]";
+		}
+		
+		/** @var UserProfile $userProfile */
+		$userProfile = MessageEmbeddedObjectManager::getInstance()->getObject('com.woltlab.wcf.user', $userID);
+		if ($userProfile === null) {
+			return '@'.$content;
+		}
+		
+		return WCF::getTPL()->fetch('userBBCodeTag', 'wcf', [
+			'username' => $content,
+			'userProfile' => $userProfile
+		], true);
+	}
+}
diff --git a/wcfsetup/install/files/lib/system/html/input/filter/MessageHtmlInputFilter.class.php b/wcfsetup/install/files/lib/system/html/input/filter/MessageHtmlInputFilter.class.php
index 11a3efacd9..04938470aa 100644
--- a/wcfsetup/install/files/lib/system/html/input/filter/MessageHtmlInputFilter.class.php
+++ b/wcfsetup/install/files/lib/system/html/input/filter/MessageHtmlInputFilter.class.php
@@ -67,12 +67,6 @@ class MessageHtmlInputFilter implements IHtmlInputFilter {
 		$definition->addAttribute('img', 'data-media-id', 'Number');
 		$definition->addAttribute('img', 'data-media-size', new \HTMLPurifier_AttrDef_Enum(['small', 'medium', 'large', 'original']));
 		
-		// mention
-		$definition->addElement('woltlab-mention', 'Inline', 'Inline', '', [
-			'data-user-id' => 'Number',
-			'data-username' => 'Text'
-		]);
-		
 		// spoiler
 		$definition->addElement('woltlab-spoiler', 'Block', 'Flow', '', [
 			'data-label' => 'Text'
diff --git a/wcfsetup/install/files/lib/system/html/input/node/HtmlInputNodeTextParser.class.php b/wcfsetup/install/files/lib/system/html/input/node/HtmlInputNodeTextParser.class.php
index f7ee2238fc..d7d2b0372f 100644
--- a/wcfsetup/install/files/lib/system/html/input/node/HtmlInputNodeTextParser.class.php
+++ b/wcfsetup/install/files/lib/system/html/input/node/HtmlInputNodeTextParser.class.php
@@ -7,6 +7,7 @@ use wcf\system\bbcode\BBCodeHandler;
 use wcf\system\bbcode\HtmlBBCodeParser;
 use wcf\system\database\util\PreparedStatementConditionBuilder;
 use wcf\system\WCF;
+use wcf\util\JSON;
 use wcf\util\StringUtil;
 
 /**
@@ -294,9 +295,10 @@ class HtmlInputNodeTextParser {
 				}
 				
 				if ($pos !== false) {
-					$element = $text->ownerDocument->createElement('woltlab-mention');
-					$element->setAttribute('data-user-id', $userID);
-					$element->setAttribute('data-username', $username);
+					$element = $text->ownerDocument->createElement('woltlab-metacode');
+					$element->setAttribute('data-name', 'user');
+					$element->setAttribute('data-attributes', base64_encode(JSON::encode([$userID])));
+					$element->appendChild($text->ownerDocument->createTextNode($username));
 					
 					$marker = $this->addReplacement($text, $element);
 					
diff --git a/wcfsetup/install/files/lib/system/html/input/node/HtmlInputNodeWoltlabMention.class.php b/wcfsetup/install/files/lib/system/html/input/node/HtmlInputNodeWoltlabMention.class.php
deleted file mode 100644
index 91e37d82c2..0000000000
--- a/wcfsetup/install/files/lib/system/html/input/node/HtmlInputNodeWoltlabMention.class.php
+++ /dev/null
@@ -1,48 +0,0 @@
-<?php
-namespace wcf\system\html\input\node;
-use wcf\system\html\node\AbstractHtmlNodeProcessor;
-
-/**
- * Processes `<woltlab-mention>`.
- * 
- * @author      Alexander Ebert
- * @copyright   2001-2016 WoltLab GmbH
- * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @package     WoltLabSuite\Core\System\Html\Input\Node
- * @since       3.0
- */
-class HtmlInputNodeWoltlabMention extends AbstractHtmlInputNode {
-	/**
-	 * @inheritDoc
-	 */
-	protected $tagName = 'woltlab-mention';
-	
-	/**
-	 * @inheritDoc
-	 */
-	public function isAllowed(AbstractHtmlNodeProcessor $htmlNodeProcessor) {
-		// mentions are always allowed
-		return [];
-	}
-	
-	/**
-	 * @inheritDoc
-	 */
-	public function process(array $elements, AbstractHtmlNodeProcessor $htmlNodeProcessor) {
-		// TODO
-		
-		$userIds = [];
-		
-		/** @var \DOMElement $mention */
-		foreach ($elements as $mention) {
-			$userId = intval($mention->getAttribute('data-user-id'));
-			if ($userId) {
-				$userIds[] = $userId;
-			}
-		}
-		
-		if (!empty($userIds)) {
-			
-		}
-	}
-}
diff --git a/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeWoltlabMention.class.php b/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeWoltlabMention.class.php
deleted file mode 100644
index d580e7ae05..0000000000
--- a/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeWoltlabMention.class.php
+++ /dev/null
@@ -1,79 +0,0 @@
-<?php
-namespace wcf\system\html\output\node;
-use wcf\data\user\UserProfile;
-use wcf\system\cache\runtime\UserProfileRuntimeCache;
-use wcf\system\html\node\AbstractHtmlNodeProcessor;
-use wcf\system\WCF;
-use wcf\util\DOMUtil;
-use wcf\util\StringUtil;
-
-/**
- * Processes user mentions.
- * 
- * @author      Alexander Ebert
- * @copyright   2001-2016 WoltLab GmbH
- * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @package     WoltLabSuite\Core\System\Html\Output\Node
- * @since       3.0
- */
-class HtmlOutputNodeWoltlabMention extends AbstractHtmlOutputNode {
-	/**
-	 * @inheritDoc
-	 */
-	protected $tagName = 'woltlab-mention';
-	
-	/**
-	 * @var	UserProfile[]
-	 */
-	protected $userProfiles;
-	
-	/**
-	 * @inheritDoc
-	 */
-	public function process(array $elements, AbstractHtmlNodeProcessor $htmlNodeProcessor) {
-		if ($this->outputType === 'text/html' || $this->outputType === 'text/simplified-html') {
-			$this->userProfiles = [];
-			
-			$userIds = [];
-			/** @var \DOMElement $element */
-			foreach ($elements as $element) {
-				$userId = intval($element->getAttribute('data-user-id'));
-				$username = StringUtil::trim($element->getAttribute('data-username'));
-				
-				if ($userId === 0 || $username === '') {
-					DOMUtil::removeNode($element);
-					continue;
-				}
-				
-				$userIds[] = $userId;
-				$nodeIdentifier = StringUtil::getRandomID();
-				$htmlNodeProcessor->addNodeData($this, $nodeIdentifier, ['userId' => $userId, 'username' => $username]);
-				
-				$htmlNodeProcessor->renameTag($element, 'wcfNode-' . $nodeIdentifier);
-			}
-			
-			if (!empty($userIds)) {
-				$this->userProfiles = UserProfileRuntimeCache::getInstance()->getObjects($userIds);
-			}
-		}
-		else if ($this->outputType === 'text/plain') {
-			/** @var \DOMElement $element */
-			foreach ($elements as $element) {
-				$htmlNodeProcessor->replaceElementWithText($element, '@' . $element->getAttribute('data-username'), false);
-			}
-		}
-	}
-	
-	/**
-	 * @inheritDoc
-	 */
-	public function replaceTag(array $data) {
-		WCF::getTPL()->assign([
-			'username' => $data['username'],
-			'userId' => $data['userId'],
-			'userProfile' => $this->userProfiles[$data['userId']]
-		]);
-		
-		return WCF::getTPL()->fetch('htmlNodeWoltlabMention');
-	}
-}
diff --git a/wcfsetup/install/files/lib/system/message/embedded/object/UserMessageEmbeddedObjectHandler.class.php b/wcfsetup/install/files/lib/system/message/embedded/object/UserMessageEmbeddedObjectHandler.class.php
new file mode 100644
index 0000000000..4873dcd003
--- /dev/null
+++ b/wcfsetup/install/files/lib/system/message/embedded/object/UserMessageEmbeddedObjectHandler.class.php
@@ -0,0 +1,35 @@
+<?php
+namespace wcf\system\message\embedded\object;
+use wcf\system\cache\runtime\UserProfileRuntimeCache;
+use wcf\system\html\input\HtmlInputProcessor;
+
+/**
+ * Parses embedded users.
+ *
+ * @author	Alexander Ebert
+ * @copyright	2001-2016 WoltLab GmbH
+ * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package	WoltLabSuite\Core\System\Message\Embedded\Object
+ */
+class UserMessageEmbeddedObjectHandler extends AbstractMessageEmbeddedObjectHandler {
+	/**
+	 * @inheritDoc
+	 */
+	public function parse(HtmlInputProcessor $htmlInputProcessor, array $embeddedData) {
+		$objectIDs = [];
+		if (!empty($embeddedData['user'])) {
+			for ($i = 0, $length = count($embeddedData['user']); $i < $length; $i++) {
+				$objectIDs[] = intval($embeddedData['user'][$i][0]);
+			}
+		}
+		
+		return array_unique($objectIDs);
+	}
+	
+	/**
+	 * @inheritDoc
+	 */
+	public function loadObjects(array $objectIDs) {
+		return UserProfileRuntimeCache::getInstance()->getObjects($objectIDs);
+	}
+}
diff --git a/wcfsetup/install/files/lib/system/option/user/group/BBCodeSelectUserGroupOptionType.class.php b/wcfsetup/install/files/lib/system/option/user/group/BBCodeSelectUserGroupOptionType.class.php
index b533ea903d..900ccbecd8 100644
--- a/wcfsetup/install/files/lib/system/option/user/group/BBCodeSelectUserGroupOptionType.class.php
+++ b/wcfsetup/install/files/lib/system/option/user/group/BBCodeSelectUserGroupOptionType.class.php
@@ -26,7 +26,7 @@ class BBCodeSelectUserGroupOptionType extends AbstractOptionType implements IUse
 	 * list of bbcode tags that are always available
 	 * @var string[]
 	 */
-	protected static $alwaysAvailable = ['align', 'attach', 'b', 'code', 'i', 'list', 'quote', 's', 'sub', 'sup', 'table', 'td', 'tr', 'tt', 'u', 'wsm', 'wsmg', 'wsp'];
+	protected static $alwaysAvailable = ['align', 'attach', 'b', 'code', 'i', 'list', 'quote', 's', 'sub', 'sup', 'table', 'td', 'tr', 'tt', 'u', 'user', 'wsm', 'wsmg', 'wsp'];
 	
 	/**
 	 * @inheritDoc
diff --git a/wcfsetup/install/files/lib/util/MessageUtil.class.php b/wcfsetup/install/files/lib/util/MessageUtil.class.php
index dac872fcb5..e056bea12c 100644
--- a/wcfsetup/install/files/lib/util/MessageUtil.class.php
+++ b/wcfsetup/install/files/lib/util/MessageUtil.class.php
@@ -46,15 +46,19 @@ class MessageUtil {
 	public static function getMentionedUsers(HtmlInputProcessor $htmlInputProcessor) {
 		$usernames = [];
 		
-		$elements = $htmlInputProcessor->getHtmlInputNodeProcessor()->getDocument()->getElementsByTagName('woltlab-mention');
+		$elements = $htmlInputProcessor->getHtmlInputNodeProcessor()->getDocument()->getElementsByTagName('woltlab-metacode');
 		/** @var \DOMElement $element */
 		foreach ($elements as $element) {
+			if ($element->getAttribute('data-name') != 'user') {
+				continue;
+			}
+			
 			if (DOMUtil::hasParent($element, 'blockquote')) {
 				// ignore mentions within quotes
 				continue;
 			}
 			
-			$usernames[] = $element->getAttribute('data-username');
+			$usernames[] = $element->textContent;
 		}
 		
 		return $usernames;
-- 
2.20.1