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, 118 insertions, 0 deletions

diff --git a/lib/public/Collaboration/AutoComplete/IManager.php b/lib/public/Collaboration/AutoComplete/IManager.php
new file mode 100644
index 00000000000..e9f33727cd2
--- /dev/null
+++ b/lib/public/Collaboration/AutoComplete/IManager.php
@@ -0,0 +1,46 @@
+<?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 OCP\Collaboration\AutoComplete;
+
+/**
+ * Interface IManager
+ *
+ * @package OCP\Collaboration\AutoComplete
+ * @since 13.0.0
+ */
+interface IManager {
+	/**
+	 * @param string $className – class name of the ISorter implementation
+	 * @since 13.0.0
+	 */
+	public function registerSorter($className);
+
+	/**
+	 * @param array $sorters	list of sorter IDs, seperated by "|"
+	 * @param array $sortArray	array representation of OCP\Collaboration\Collaborators\ISearchResult
+	 * @param array $context	context info of the search, keys: itemType, itemId
+	 * @since 13.0.0
+	 */
+	public function runSorters(array $sorters, array &$sortArray, array $context);
+}
diff --git a/lib/public/Collaboration/AutoComplete/ISorter.php b/lib/public/Collaboration/AutoComplete/ISorter.php
new file mode 100644
index 00000000000..538ca41003d
--- /dev/null
+++ b/lib/public/Collaboration/AutoComplete/ISorter.php
@@ -0,0 +1,50 @@
+<?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 OCP\Collaboration\AutoComplete;
+
+/**
+ * Interface ISorter
+ *
+ * Sorts the list of .e.g users for auto completion
+ *
+ * @package OCP\Collaboration\AutoComplete
+ * @since 13.0.0
+ */
+interface ISorter {
+
+	/**
+	 * @return string The ID of the sorter, e.g. commenters
+	 * @since 13.0.0
+	 */
+	public function getId();
+
+	/**
+	 * executes the sort action
+	 *
+	 * @param array $sortArray the array to be sorted, provided as reference
+	 * @param array $context carries key 'itemType' and 'itemId' of the source object (e.g. a file)
+	 * @since 13.0.0
+	 */
+	public function sort(array &$sortArray, array $context);
+}
diff --git a/lib/public/Comments/ICommentsManager.php b/lib/public/Comments/ICommentsManager.php
index 61633af95cd..e3ea7888ffd 100644
--- a/lib/public/Comments/ICommentsManager.php
+++ b/lib/public/Comments/ICommentsManager.php
@@ -138,6 +138,28 @@ interface ICommentsManager {
 	public function getNumberOfUnreadCommentsForFolder($folderId, IUser $user);
 
 	/**
+	 * Get the actor types and ID that commented in the tree specified by the ID
+	 *
+	 * @param string $id
+	 * @return array
+	 * @since 13.0.0
+	 *
+	 * The return array looks like this:
+	 *
+	 * [
+	 *   'users' => [
+	 *     'alice',
+	 *     'bob',
+	 *   ],
+	 *   'robots' => [
+	 *     'r2-d2',
+	 *     'c-3po',
+	 *   ]
+	 * ]
+	 */
+	public function getActorsInTree($id);
+
+	/**
 	 * creates a new comment and returns it. At this point of time, it is not
 	 * saved in the used data storage. Use save() after setting other fields
 	 * of the comment (e.g. message or verb).