Backport of format self-mentions, but don't offer them #7914

comments should compile mentions also if done by author

it is used by clients for formatting reasons, there is no reason not format
the author if her handle is included in the comment body.
It is unrelated to sending out notifications.

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

do not offer the handle of the current user for auto completion

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

add types to php doc

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

Author: blizzz

lib/private/Collaboration/Collaborators/Search.php

@@ -40,6 +40,15 @@ public function __construct(IContainer $c) {
 		$this->c = $c;
 	}
 
+	/**
+	 * @param string $search
+	 * @param array $shareTypes
+	 * @param bool $lookup
+	 * @param int|null $limit
+	 * @param int|null $offset
+	 * @return array
+	 * @throws \OCP\AppFramework\QueryException
+	 */
 	public function search($search, array $shareTypes, $lookup, $limit, $offset) {
 		$hasMoreResults = false;
 

lib/private/Collaboration/Collaborators/UserPlugin.php

@@ -83,6 +83,8 @@ public function search($search, $limit, $offset, ISearchResult $searchResult) {
 			}
 		}
 
+		$this->takeOutCurrentUser($users);
+
 		if (!$this->shareeEnumeration || sizeof($users) < $limit) {
 			$hasMoreResults = true;
 		}
@@ -146,4 +148,13 @@ public function search($search, $limit, $offset, ISearchResult $searchResult) {
 
 		return $hasMoreResults;
 	}
+
+	public function takeOutCurrentUser(array &$users) {
+		$currentUser = $this->userSession->getUser();
+		if(!is_null($currentUser)) {
+			if (isset($users[$currentUser->getUID()])) {
+				unset($users[$currentUser->getUID()]);
+			}
+		}
+	}
 }

lib/private/Comments/Comment.php

@@ -232,10 +232,6 @@ public function getMentions() {
 		$uids = array_unique($mentions[0]);
 		$result = [];
 		foreach ($uids as $uid) {
-			// exclude author, no self-mentioning
-			if($uid === '@' . $this->getActorId()) {
-				continue;
-			}
 			$result[] = ['type' => 'user', 'id' => substr($uid, 1)];
 		}
 		return $result;

tests/lib/Collaboration/Collaborators/UserPluginTest.php

@@ -442,4 +442,51 @@ function($appName, $key, $default)
 		$this->assertEquals($expected, $result['users']);
 		$this->assertSame($reachedEnd, $moreResults);
 	}
+
+	public function takeOutCurrentUserProvider() {
+		$inputUsers = [
+			'alice' => 'Alice',
+			'bob' => 'Bob',
+			'carol' => 'Carol'
+		];
+		return [
+			[
+				$inputUsers,
+				['alice', 'carol'],
+				'bob'
+			],
+			[
+				$inputUsers,
+				['alice', 'bob', 'carol'],
+				'dave'
+			],
+			[
+				$inputUsers,
+				['alice', 'bob', 'carol'],
+				null
+			]
+		];
+	}
+
+	/**
+	 * @dataProvider takeOutCurrentUserProvider
+	 * @param array $users
+	 * @param array $expectedUIDs
+	 * @param $currentUserId
+	 */
+	public function testTakeOutCurrentUser(array $users, array $expectedUIDs, $currentUserId) {
+		$this->instantiatePlugin();
+
+		$this->session->expects($this->once())
+			->method('getUser')
+			->willReturnCallback(function() use ($currentUserId) {
+				if($currentUserId !== null) {
+					return $this->getUserMock($currentUserId, $currentUserId);
+				}
+				return null;
+			});
+
+		$this->plugin->takeOutCurrentUser($users);
+		$this->assertSame($expectedUIDs, array_keys($users));
+	}
 }

tests/lib/Comments/CommentTest.php

@@ -8,6 +8,9 @@
 
 class CommentTest extends TestCase {
 
+	/**
+	 * @throws \OCP\Comments\IllegalIDChangeException
+	 */
 	public function testSettersValidInput() {
 		$comment = new Comment();
 
@@ -58,6 +61,9 @@ public function testSetIdIllegalInput() {
 		$comment->setId('c17');
 	}
 
+	/**
+	 * @throws \OCP\Comments\IllegalIDChangeException
+	 */
 	public function testResetId() {
 		$comment = new Comment();
 		$comment->setId('c23');
@@ -133,7 +139,7 @@ public function mentionsProvider() {
 				'@alice @bob look look, a duplication @alice test @bob!', ['alice', 'bob']
 			],
 			[
-				'@alice is the author, but notify @bob!', ['bob'], 'alice'
+				'@alice is the author, notify @bob, nevertheless mention her!', ['alice', 'bob'], 'alice'
 			],
 			[
 				'@foobar and @barfoo you should know, @foo@bar.com is valid' .
@@ -159,7 +165,6 @@ public function testMentions($message, $expectedUids, $author = null) {
 			$uid = array_shift($expectedUids);
 			$this->assertSame('user', $mention['type']);
 			$this->assertSame($uid, $mention['id']);
-			$this->assertNotSame($author, $mention['id']);
 		}
 		$this->assertEmpty($mentions);
 		$this->assertEmpty($expectedUids);