AutoCompletion backend

* introduce a Controller for requests
* introduce result sorting mechanism
* extend Comments to retrieve commentors (actors) in a tree
* add commenters sorter
* add share recipients sorter

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

3 files changed, 246 insertions, 0 deletions

diff --git a/apps/comments/appinfo/info.xml b/apps/comments/appinfo/info.xml
index b67def1fb9d..ada4915d145 100644
--- a/apps/comments/appinfo/info.xml
+++ b/apps/comments/appinfo/info.xml
@@ -28,4 +28,10 @@
 			<provider>OCA\Comments\Activity\Provider</provider>
 		</providers>
 	</activity>
+
+	<collaboration>
+		<plugins>
+			<plugin type="autocomplete-sort">OCA\Comments\Collaboration\Sorter</plugin>
+		</plugins>
+	</collaboration>
 </info>
diff --git a/apps/comments/lib/Collaboration/CommentersSorter.php b/apps/comments/lib/Collaboration/CommentersSorter.php
new file mode 100644
index 00000000000..e89a66f148d
--- /dev/null
+++ b/apps/comments/lib/Collaboration/CommentersSorter.php
@@ -0,0 +1,93 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Comments\Collaboration;
+
+
+use OCP\Collaboration\AutoComplete\ISorter;
+use OCP\Comments\ICommentsManager;
+
+class CommentersSorter implements ISorter {
+
+	/** @var ICommentsManager */
+	private $commentsManager;
+
+	public function __construct(ICommentsManager $commentsManager) {
+		$this->commentsManager = $commentsManager;
+	}
+
+	public function getId() {
+		return 'commenters';
+	}
+
+	/**
+	 * Sorts people who commented on the given item atop (descelating) of the
+	 * others
+	 *
+	 * @param array $sortArray
+	 * @param array $context
+	 */
+	public function sort(array &$sortArray, array $context) {
+		$commenters = $this->retrieveCommentsInformation($context['itemType'], $context['itemId']);
+		if(count($commenters) === 0) {
+			return;
+		}
+
+		foreach ($sortArray as $type => &$byType) {
+			if(!isset($commenters[$type])) {
+				continue;
+			}
+
+			usort($byType, function ($a, $b) use ($commenters, $type) {
+				$r = $this->compare($a, $b, $commenters[$type]);
+				return $r;
+			});
+
+			$s = '';
+		}
+	}
+
+	/**
+	 * @param $type
+	 * @param $id
+	 * @return array
+	 */
+	protected function retrieveCommentsInformation($type, $id) {
+		$comments = $this->commentsManager->getForObject($type, $id, 1);
+		if(count($comments) === 0) {
+			return [];
+		}
+
+		return $this->commentsManager->getActorsInTree($comments[0]->getTopmostParentId());
+	}
+
+	protected function compare(array $a, array $b, array $commenters) {
+		$a = $a['value']['shareWith'];
+		$b = $b['value']['shareWith'];
+
+		$valueA = isset($commenters[$a]) ? $commenters[$a] : 0;
+		$valueB = isset($commenters[$b]) ? $commenters[$b] : 0;
+
+		return $valueB - $valueA;
+	}
+}
diff --git a/apps/comments/tests/Unit/Collaboration/CommentersSorterTest.php b/apps/comments/tests/Unit/Collaboration/CommentersSorterTest.php
new file mode 100644
index 00000000000..495dee1f416
--- /dev/null
+++ b/apps/comments/tests/Unit/Collaboration/CommentersSorterTest.php
@@ -0,0 +1,147 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Comments\Tests\Unit\Collaboration;
+
+
+use OCA\Comments\Collaboration\CommentersSorter;
+use OCP\Comments\IComment;
+use OCP\Comments\ICommentsManager;
+use Test\TestCase;
+
+class CommentersSorterTest extends TestCase {
+	/** @var  ICommentsManager|\PHPUnit_Framework_MockObject_MockObject */
+	protected $commentsManager;
+	/** @var  CommentersSorter */
+	protected $sorter;
+
+	public function setUp() {
+		parent::setUp();
+
+		$this->commentsManager = $this->createMock(ICommentsManager::class);
+
+		$this->sorter = new CommentersSorter($this->commentsManager);
+	}
+
+	/**
+	 * @dataProvider sortDataProvider
+	 * @param $data
+	 */
+	public function testSort($data) {
+		$this->commentsManager->expects($this->once())
+			->method('getForObject')
+			->willReturn([$this->createMock(IComment::class)]);
+
+		$this->commentsManager->expects($this->once())
+			->method('getActorsInTree')
+			->willReturn($data['actors']);
+
+		$workArray = $data['input'];
+		$this->sorter->sort($workArray, ['itemType' => 'files', 'itemId' => '24']);
+
+		$this->assertSame($data['expected'], $workArray);
+	}
+
+	public function sortDataProvider() {
+		return [[
+			[
+				#1 – sort properly and otherwise keep existing order
+				'actors' => ['users' => ['celia' => 3, 'darius' => 7, 'faruk' => 5, 'gail' => 5], 'bots' => ['r2-d2' => 8]],
+				'input' => [
+					'users' =>
+						[
+							['value' => ['shareWith' => 'alice']],
+							['value' => ['shareWith' => 'bob']],
+							['value' => ['shareWith' => 'celia']],
+							['value' => ['shareWith' => 'darius']],
+							['value' => ['shareWith' => 'elena']],
+							['value' => ['shareWith' => 'faruk']],
+							['value' => ['shareWith' => 'gail']],
+						],
+					'bots' => [
+						['value' => ['shareWith' => 'c-3po']],
+						['value' => ['shareWith' => 'r2-d2']],
+					]
+				],
+				'expected' => [
+					'users' =>
+						[
+							['value' => ['shareWith' => 'darius']],
+							['value' => ['shareWith' => 'faruk']],
+							['value' => ['shareWith' => 'gail']],
+							['value' => ['shareWith' => 'celia']],
+							['value' => ['shareWith' => 'alice']],
+							['value' => ['shareWith' => 'bob']],
+							['value' => ['shareWith' => 'elena']],
+						],
+					'bots' => [
+						['value' => ['shareWith' => 'r2-d2']],
+						['value' => ['shareWith' => 'c-3po']],
+					]
+				],
+			],
+			[
+				#2 – no commentors, input equals output
+				'actors' => [],
+				'input' => [
+					'users' =>
+						[
+							['value' => ['shareWith' => 'alice']],
+							['value' => ['shareWith' => 'bob']],
+							['value' => ['shareWith' => 'celia']],
+							['value' => ['shareWith' => 'darius']],
+							['value' => ['shareWith' => 'elena']],
+							['value' => ['shareWith' => 'faruk']],
+							['value' => ['shareWith' => 'gail']],
+						],
+					'bots' => [
+						['value' => ['shareWith' => 'c-3po']],
+						['value' => ['shareWith' => 'r2-d2']],
+					]
+				],
+				'expected' => [
+					'users' =>
+						[
+							['value' => ['shareWith' => 'alice']],
+							['value' => ['shareWith' => 'bob']],
+							['value' => ['shareWith' => 'celia']],
+							['value' => ['shareWith' => 'darius']],
+							['value' => ['shareWith' => 'elena']],
+							['value' => ['shareWith' => 'faruk']],
+							['value' => ['shareWith' => 'gail']],
+						],
+					'bots' => [
+						['value' => ['shareWith' => 'c-3po']],
+						['value' => ['shareWith' => 'r2-d2']],
+					]
+				],
+			],
+			[
+				#3 – no nothing
+				'actors' => [],
+				'input' => [],
+				'expected' => [],
+			],
+		]];
+	}
+}