From d8684224e74924bd5361970889014c9ee20ab79a Mon Sep 17 00:00:00 2001
From: Alexander Ebert <ebert@woltlab.com>
Date: Tue, 7 Mar 2017 17:56:38 +0100
Subject: [PATCH] Added basic approval process for comments

See #2219
---
 com.woltlab.wcf/templates/commentList.tpl     |  16 ++-
 com.woltlab.wcf/userGroupOption.xml           |   4 +-
 .../lib/data/comment/CommentAction.class.php  | 114 ++++++++++--------
 .../manager/AbstractCommentManager.class.php  |  17 +++
 .../manager/ArticleCommentManager.class.php   |   5 +
 .../comment/manager/ICommentManager.class.php |   8 ++
 .../manager/PageCommentManager.class.php      |   5 +
 .../UserProfileCommentManager.class.php       |   5 +
 .../files/style/layout/containerList.scss     |   6 +-
 wcfsetup/install/files/style/ui/comment.scss  |   8 ++
 wcfsetup/install/lang/de.xml                  |   1 +
 wcfsetup/install/lang/en.xml                  |   1 +
 12 files changed, 137 insertions(+), 53 deletions(-)

diff --git a/com.woltlab.wcf/templates/commentList.tpl b/com.woltlab.wcf/templates/commentList.tpl
index 33d18cf9c0..dce45958f2 100644
--- a/com.woltlab.wcf/templates/commentList.tpl
+++ b/com.woltlab.wcf/templates/commentList.tpl
@@ -1,6 +1,11 @@
 {if !$commentManager|isset}{assign var='commentManager' value=$commentList->getCommentManager()}{/if}
+{assign var=__comentCanModerate value=$commentManager->canModerate($commentList->objectTypeID, $commentList->objectID)}
 {foreach from=$commentList item=comment}
-	<li class="comment jsComment" data-object-id="{@$comment->commentID}" data-comment-id="{@$comment->commentID}" data-object-type="com.woltlab.wcf.comment" data-like-liked="{if $likeData[comment][$comment->commentID]|isset}{@$likeData[comment][$comment->commentID]->liked}{/if}" data-like-likes="{if $likeData[comment][$comment->commentID]|isset}{@$likeData[comment][$comment->commentID]->likes}{else}0{/if}" data-like-dislikes="{if $likeData[comment][$comment->commentID]|isset}{@$likeData[comment][$comment->commentID]->dislikes}{else}0{/if}" data-like-users='{if $likeData[comment][$comment->commentID]|isset}{ {implode from=$likeData[comment][$comment->commentID]->getUsers() item=likeUser}"{@$likeUser->userID}": { "username": "{$likeUser->username|encodeJSON}" }{/implode} }{else}{ }{/if}' data-can-edit="{if $comment->isEditable()}true{else}false{/if}" data-can-delete="{if $comment->isDeletable()}true{else}false{/if}" data-responses="{@$comment->responses}" data-last-response-time="{@$comment->getLastResponseTime()}" data-user-id="{@$comment->userID}">
+	<li class="comment jsComment"
+	    data-object-id="{@$comment->commentID}" data-comment-id="{@$comment->commentID}" data-object-type="com.woltlab.wcf.comment"
+	    data-like-liked="{if $likeData[comment][$comment->commentID]|isset}{@$likeData[comment][$comment->commentID]->liked}{/if}" data-like-likes="{if $likeData[comment][$comment->commentID]|isset}{@$likeData[comment][$comment->commentID]->likes}{else}0{/if}" data-like-dislikes="{if $likeData[comment][$comment->commentID]|isset}{@$likeData[comment][$comment->commentID]->dislikes}{else}0{/if}" data-like-users='{if $likeData[comment][$comment->commentID]|isset}{ {implode from=$likeData[comment][$comment->commentID]->getUsers() item=likeUser}"{@$likeUser->userID}": { "username": "{$likeUser->username|encodeJSON}" }{/implode} }{else}{ }{/if}'
+	    data-can-edit="{if $comment->isEditable()}true{else}false{/if}" data-can-delete="{if $comment->isDeletable()}true{else}false{/if}"
+	    data-responses="{@$comment->responses}" data-last-response-time="{@$comment->getLastResponseTime()}" data-user-id="{@$comment->userID}" data-is-disabled="{@$comment->isDisabled}">
 		<div class="box48">
 			{if $comment->userID}
 				<a href="{link controller='User' object=$comment->getUserProfile()}{/link}" title="{$comment->getUserProfile()->username}">
@@ -21,10 +26,14 @@
 									<span itemprop="name">{$comment->username}</span>
 								</a>
 							{else}
-							<span itemprop="name">{$comment->username}</span>
+								<span itemprop="name">{$comment->username}</span>
 							{/if}
 							
 							<small class="separatorLeft">{@$comment->time|time}</small>
+							
+							{if $comment->isDisabled}
+								<span class="badge label green jsIconDisabled">{lang}wcf.message.status.disabled{/lang}</span>
+							{/if}
 						</h3>
 					</div>
 					
@@ -32,6 +41,9 @@
 					
 					<nav class="jsMobileNavigation buttonGroupNavigation">
 						<ul class="buttonList iconList">
+							{if $comment->isDisabled && $__comentCanModerate}
+								<li class="jsOnly"><a href="#" class="jsEnableComment"><span class="icon icon16 fa-check"></span> <span class="invisible">{lang}wcf.comment.approve{/lang}</span></a></li>
+							{/if}
 							{if $commentManager->supportsReport() && $__wcf->session->getPermission('user.profile.canReportContent')}
 								<li class="jsReportCommentComment jsOnly" data-object-id="{@$comment->commentID}"><a href="#" title="{lang}wcf.moderation.report.reportContent{/lang}" class="jsTooltip"><span class="icon icon16 fa-exclamation-triangle"></span> <span class="invisible">{lang}wcf.moderation.report.reportContent{/lang}</span></a></li>
 							{/if}
diff --git a/com.woltlab.wcf/userGroupOption.xml b/com.woltlab.wcf/userGroupOption.xml
index 5cb3aa245a..fa01ce47ce 100644
--- a/com.woltlab.wcf/userGroupOption.xml
+++ b/com.woltlab.wcf/userGroupOption.xml
@@ -733,7 +733,7 @@ png</defaultvalue>
 				<optiontype>boolean</optiontype>
 				<defaultvalue>1</defaultvalue>
 			</option>
-			<option name="user.page.canAddCommentWithoutModeration">
+			<option name="user.article.canAddCommentWithoutModeration">
 				<categoryname>user.article</categoryname>
 				<optiontype>boolean</optiontype>
 				<defaultvalue>1</defaultvalue>
@@ -848,7 +848,7 @@ png</defaultvalue>
 				<optiontype>boolean</optiontype>
 				<defaultvalue>1</defaultvalue>
 			</option>
-			<option name="user.page.canAddCommentWithoutModeration">
+			<option name="user.profileComment.canAddCommentWithoutModeration">
 				<categoryname>user.profileComment</categoryname>
 				<optiontype>boolean</optiontype>
 				<defaultvalue>1</defaultvalue>
diff --git a/wcfsetup/install/files/lib/data/comment/CommentAction.class.php b/wcfsetup/install/files/lib/data/comment/CommentAction.class.php
index f56f34c7b9..1f16b23e1c 100644
--- a/wcfsetup/install/files/lib/data/comment/CommentAction.class.php
+++ b/wcfsetup/install/files/lib/data/comment/CommentAction.class.php
@@ -307,52 +307,15 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
 			'message' => $htmlInputProcessor->getHtml(),
 			'responses' => 0,
 			'responseIDs' => serialize([]),
-			'enableHtml' => 1
+			'enableHtml' => 1,
+			'isDisabled' => $this->commentProcessor->canAddWithoutApproval($this->parameters['data']['objectID']) ? 0 : 1
 		]);
 		
-		// update counter
-		$this->commentProcessor->updateCounter($this->parameters['data']['objectID'], 1);
-		
-		// fire activity event
-		$objectType = ObjectTypeCache::getInstance()->getObjectType($this->parameters['data']['objectTypeID']);
-		if ($this->createdComment->userID && UserActivityEventHandler::getInstance()->getObjectTypeID($objectType->objectType.'.recentActivityEvent')) {
-			UserActivityEventHandler::getInstance()->fireEvent($objectType->objectType.'.recentActivityEvent', $this->createdComment->commentID);
-		}
-		
-		// fire notification event
-		if (UserNotificationHandler::getInstance()->getObjectTypeID($objectType->objectType.'.notification')) {
-			$notificationObject = new CommentUserNotificationObject($this->createdComment);
-			$notificationObjectType = UserNotificationHandler::getInstance()->getObjectTypeProcessor($objectType->objectType.'.notification');
-			
-			if ($notificationObjectType instanceof IMultiRecipientCommentUserNotificationObjectType) {
-				$recipientIDs = $notificationObjectType->getRecipientIDs($this->createdComment);
-				
-				// make sure that the active user gets no notification
-				$recipientIDs = array_diff($recipientIDs, [WCF::getUser()->userID]);
-				
-				if (!empty($recipientIDs)) {
-					UserNotificationHandler::getInstance()->fireEvent(
-						'comment',
-						$objectType->objectType . '.notification',
-						$notificationObject,
-						$recipientIDs
-					);
-				}
-			}
-			else {
-				/** @var ICommentUserNotificationObjectType $notificationObjectType */
-				
-				$userID = $notificationObjectType->getOwnerID($this->createdComment->commentID);
-				if ($userID != WCF::getUser()->userID) {
-					UserNotificationHandler::getInstance()->fireEvent(
-						'comment',
-						$objectType->objectType . '.notification',
-						$notificationObject,
-						[$userID],
-						['objectUserID' => $userID]
-					);
-				}
-			}
+		if (!$this->createdComment->isDisabled) {
+			$action = new CommentAction([$this->createdComment], 'triggerPublication', [
+				'commentProcessor' => $this->commentProcessor
+			]);
+			$action->executeAction();
 		}
 		
 		if (!$this->createdComment->userID) {
@@ -373,6 +336,59 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
 		];
 	}
 	
+	public function triggerPublication() {
+		if (!empty($this->parameters['commentProcessor'])) {
+			$objectType = null;
+			if (!empty($this->objects)) {
+				/** @var Comment $comment */
+				$comment = reset($this->objects);
+				$objectType = $this->validateObjectType($comment->objectTypeID);
+			}
+			
+			$this->commentProcessor = $this->parameters['commentProcessor'];
+		}
+		else {
+			$objectType = $this->validateObjectType($this->parameters['objectTypeID']);
+			$this->commentProcessor = $objectType->getProcessor();
+		}
+		
+		/** @var CommentEditor $comment */
+		foreach ($this->objects as $comment) {
+			// update counter
+			$this->commentProcessor->updateCounter($comment->objectID, 1);
+			
+			// fire activity event
+			if ($comment->userID && UserActivityEventHandler::getInstance()->getObjectTypeID($objectType->objectType . '.recentActivityEvent')) {
+				UserActivityEventHandler::getInstance()->fireEvent($objectType->objectType . '.recentActivityEvent', $comment->commentID);
+			}
+			
+			// fire notification event
+			if (UserNotificationHandler::getInstance()->getObjectTypeID($objectType->objectType . '.notification')) {
+				$notificationObject = new CommentUserNotificationObject($comment->getDecoratedObject());
+				$notificationObjectType = UserNotificationHandler::getInstance()->getObjectTypeProcessor($objectType->objectType . '.notification');
+				
+				if ($notificationObjectType instanceof IMultiRecipientCommentUserNotificationObjectType) {
+					$recipientIDs = $notificationObjectType->getRecipientIDs($comment);
+					
+					// make sure that the active user gets no notification
+					$recipientIDs = array_diff($recipientIDs, [WCF::getUser()->userID]);
+					
+					if (!empty($recipientIDs)) {
+						UserNotificationHandler::getInstance()->fireEvent('comment', $objectType->objectType . '.notification', $notificationObject, $recipientIDs);
+					}
+				}
+				else {
+					/** @var ICommentUserNotificationObjectType $notificationObjectType */
+					
+					$userID = $notificationObjectType->getOwnerID($comment->commentID);
+					if ($userID != WCF::getUser()->userID) {
+						UserNotificationHandler::getInstance()->fireEvent('comment', $objectType->objectType . '.notification', $notificationObject, [$userID], ['objectUserID' => $userID]);
+					}
+				}
+			}
+		}
+	}
+	
 	/**
 	 * Validates parameters to add a response.
 	 */
@@ -864,13 +880,17 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
 	/**
 	 * Validates object type id parameter.
 	 * 
+	 * @param       integer         $objectTypeID
 	 * @return	ObjectType
 	 * @throws	UserInputException
 	 */
-	protected function validateObjectType() {
-		$this->readInteger('objectTypeID', false, 'data');
+	protected function validateObjectType($objectTypeID = null) {
+		if ($objectTypeID === null) {
+			$this->readInteger('objectTypeID', false, 'data');
+			$objectTypeID = $this->parameters['data']['objectTypeID'];
+		}
 		
-		$objectType = ObjectTypeCache::getInstance()->getObjectType($this->parameters['data']['objectTypeID']);
+		$objectType = ObjectTypeCache::getInstance()->getObjectType($objectTypeID);
 		if ($objectType === null) {
 			throw new UserInputException('objectTypeID');
 		}
diff --git a/wcfsetup/install/files/lib/system/comment/manager/AbstractCommentManager.class.php b/wcfsetup/install/files/lib/system/comment/manager/AbstractCommentManager.class.php
index 04efab6830..eb4c0702ec 100644
--- a/wcfsetup/install/files/lib/system/comment/manager/AbstractCommentManager.class.php
+++ b/wcfsetup/install/files/lib/system/comment/manager/AbstractCommentManager.class.php
@@ -26,6 +26,12 @@ abstract class AbstractCommentManager extends SingletonFactory implements IComme
 	 */
 	protected $permissionAdd = '';
 	
+	/**
+	 * permission name for comment/response creation without approval
+	 * @var string
+	 */
+	protected $permissionAddWithoutModeration = '';
+	
 	/**
 	 * permission name for comment/response moderation
 	 * @var	string
@@ -67,6 +73,17 @@ abstract class AbstractCommentManager extends SingletonFactory implements IComme
 		return (WCF::getSession()->getPermission($this->permissionAdd) ? true : false);
 	}
 	
+	/**
+	 * @inheritDoc
+	 */
+	public function canAddWithoutApproval($objectID) {
+		if (empty($this->permissionAddWithoutModeration)) {
+			return false;
+		}
+		
+		return (WCF::getSession()->getPermission($this->permissionAddWithoutModeration) ? true : false);
+	}
+	
 	/**
 	 * @inheritDoc
 	 */
diff --git a/wcfsetup/install/files/lib/system/comment/manager/ArticleCommentManager.class.php b/wcfsetup/install/files/lib/system/comment/manager/ArticleCommentManager.class.php
index 7060dda6d5..9efa0cf724 100644
--- a/wcfsetup/install/files/lib/system/comment/manager/ArticleCommentManager.class.php
+++ b/wcfsetup/install/files/lib/system/comment/manager/ArticleCommentManager.class.php
@@ -24,6 +24,11 @@ class ArticleCommentManager extends AbstractCommentManager implements IViewableL
 	 */
 	protected $permissionAdd = 'user.article.canAddComment';
 	
+	/**
+	 * @inheritDoc
+	 */
+	protected $permissionAddWithoutModeration = 'user.article.canAddCommentWithoutModeration';
+	
 	/**
 	 * @inheritDoc
 	 */
diff --git a/wcfsetup/install/files/lib/system/comment/manager/ICommentManager.class.php b/wcfsetup/install/files/lib/system/comment/manager/ICommentManager.class.php
index 9036d20146..582403ea27 100644
--- a/wcfsetup/install/files/lib/system/comment/manager/ICommentManager.class.php
+++ b/wcfsetup/install/files/lib/system/comment/manager/ICommentManager.class.php
@@ -20,6 +20,14 @@ interface ICommentManager {
 	 */
 	public function canAdd($objectID);
 	
+	/**
+	 * Returns true if a comment requires approval.
+	 * 
+	 * @param       integer         $objectID
+	 * @return      boolean
+	 */
+	public function canAddWithoutApproval($objectID);
+	
 	/**
 	 * Returns true if the current user may edit given comment.
 	 * 
diff --git a/wcfsetup/install/files/lib/system/comment/manager/PageCommentManager.class.php b/wcfsetup/install/files/lib/system/comment/manager/PageCommentManager.class.php
index 803660c59f..5a321ea984 100644
--- a/wcfsetup/install/files/lib/system/comment/manager/PageCommentManager.class.php
+++ b/wcfsetup/install/files/lib/system/comment/manager/PageCommentManager.class.php
@@ -24,6 +24,11 @@ class PageCommentManager extends AbstractCommentManager implements IViewableLike
 	 */
 	protected $permissionAdd = 'user.page.canAddComment';
 	
+	/**
+	 * @inheritDoc
+	 */
+	protected $permissionAddWithoutModeration = 'user.page.canAddCommentWithoutModeration';
+	
 	/**
 	 * @inheritDoc
 	 */
diff --git a/wcfsetup/install/files/lib/system/comment/manager/UserProfileCommentManager.class.php b/wcfsetup/install/files/lib/system/comment/manager/UserProfileCommentManager.class.php
index c8e365df18..15ff3472a0 100644
--- a/wcfsetup/install/files/lib/system/comment/manager/UserProfileCommentManager.class.php
+++ b/wcfsetup/install/files/lib/system/comment/manager/UserProfileCommentManager.class.php
@@ -24,6 +24,11 @@ class UserProfileCommentManager extends AbstractCommentManager implements IViewa
 	 */
 	protected $permissionAdd = 'user.profileComment.canAddComment';
 	
+	/**
+	 * @inheritDoc
+	 */
+	protected $permissionAddWithoutModeration = 'user.profileComment.canAddCommentWithoutModeration';
+	
 	/**
 	 * @inheritDoc
 	 */
diff --git a/wcfsetup/install/files/style/layout/containerList.scss b/wcfsetup/install/files/style/layout/containerList.scss
index 758a630752..152e5cab4c 100644
--- a/wcfsetup/install/files/style/layout/containerList.scss
+++ b/wcfsetup/install/files/style/layout/containerList.scss
@@ -137,7 +137,8 @@
 						display: inline-block;
 						padding: 3px 5px;
 						
-						> .icon {
+						> .icon,
+						> .invisible {
 							color: rgba(0, 0, 0, .5);
 						}
 					}
@@ -145,7 +146,8 @@
 					&.active,
 					&:hover {
 						> a {
-							> .icon {
+							> .icon,
+							> .invisible {
 								color: $wcfContentText;
 							}
 						}
diff --git a/wcfsetup/install/files/style/ui/comment.scss b/wcfsetup/install/files/style/ui/comment.scss
index c39e365f17..e2bdd7a5ce 100644
--- a/wcfsetup/install/files/style/ui/comment.scss
+++ b/wcfsetup/install/files/style/ui/comment.scss
@@ -57,6 +57,10 @@
 	textarea + button {
 		margin-top: 2px;
 	}
+	
+	.comment[data-is-disabled="1"] .jsCommentShowAddResponse {
+		display: none;
+	}
 }
 
 .commentListAddComment {
@@ -170,3 +174,7 @@
 	height: 0;
 	position: absolute;
 }
+
+.jsEnableComment > .invisible {
+	display: inline;
+}
diff --git a/wcfsetup/install/lang/de.xml b/wcfsetup/install/lang/de.xml
index 37073036f2..b24492b4ad 100644
--- a/wcfsetup/install/lang/de.xml
+++ b/wcfsetup/install/lang/de.xml
@@ -2155,6 +2155,7 @@ Fehler sind beispielsweise:
 	
 	<category name="wcf.comment">
 		<item name="wcf.comment.add"><![CDATA[Kommentar schreiben …]]></item>
+		<item name="wcf.comment.approve"><![CDATA[Freischalten]]></item>
 		<item name="wcf.comment.delete.confirmMessage"><![CDATA[{if LANGUAGE_USE_INFORMAL_VARIANT}Willst du{else}Wollen Sie{/if} diesen Kommentar wirklich löschen?]]></item>
 		<item name="wcf.comment.description"><![CDATA[{if LANGUAGE_USE_INFORMAL_VARIANT}Drücke{else}Drücken Sie{/if} die Eingabetaste, um abzusenden oder Escape, um abzubrechen.]]></item>
 		<item name="wcf.comment.error.floodControl"><![CDATA[{if LANGUAGE_USE_INFORMAL_VARIANT}Du hast{else}Sie haben{/if} bereits einen Kommentar innerhalb der letzten {if $__wcf->getSession()->getPermission('user.comment.floodControlTime') > 1}{#$__wcf->getSession()->getPermission('user.comment.floodControlTime')} Sekunden{else}Sekunde{/if} geschrieben. {if LANGUAGE_USE_INFORMAL_VARIANT}Du kannst{else}Sie können{/if} erst in {#$lastCommentTime+$__wcf->getSession()->getPermission('user.comment.floodControlTime')-TIME_NOW} Sekunde{if ($lastCommentTime+$__wcf->getSession()->getPermission('user.comment.floodControlTime')-TIME_NOW) != 1}n{/if} einen neuen Kommentar erstellen.]]></item>
diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml
index 07bb7db52c..708e3d02f2 100644
--- a/wcfsetup/install/lang/en.xml
+++ b/wcfsetup/install/lang/en.xml
@@ -2113,6 +2113,7 @@ Errors are:
 	
 	<category name="wcf.comment">
 		<item name="wcf.comment.add"><![CDATA[Write a comment …]]></item>
+		<item name="wcf.comment.approve"><![CDATA[Approve]]></item>
 		<item name="wcf.comment.delete.confirmMessage"><![CDATA[Do you really want to delete this comment?]]></item>
 		<item name="wcf.comment.description"><![CDATA[Press Enter to send or Escape to cancel.]]></item>
 		<item name="wcf.comment.error.floodControl"><![CDATA[You have already written a comment within the last {if $__wcf->getSession()->getPermission('user.comment.floodControlTime') > 1}{#$__wcf->getSession()->getPermission('user.comment.floodControlTime')} seconds{else}second{/if}. You must wait at least {#$lastCommentTime+$__wcf->getSession()->getPermission('user.comment.floodControlTime')-TIME_NOW} second{if ($lastCommentTime+$__wcf->getSession()->getPermission('user.comment.floodControlTime')-TIME_NOW) != 1}s{/if} before attempting to write a new comment.]]></item>
-- 
2.20.1