From ca72c0150b3ea490c06c8c4824aebf0d0da33088 Mon Sep 17 00:00:00 2001
From: Arthur Schiwon <blizzz@arthur-schiwon.de>
Date: Fri, 27 Oct 2017 13:50:38 +0200
Subject: [PATCH] configurable amount of autocomplete results in comments
Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
---
apps/comments/js/commentstabview.js | Bin 21016 -> 21132 bytes
apps/comments/lib/AppInfo/Application.php | 5 ++
apps/comments/lib/JSSettingsHelper.php | 45 +++++++++++
.../tests/Unit/JSSettingsHelperTest.php | 73 ++++++++++++++++++
config/config.sample.php | 19 -----
core/Controller/AutoCompleteController.php | 4 +-
6 files changed, 125 insertions(+), 21 deletions(-)
create mode 100644 apps/comments/lib/JSSettingsHelper.php
create mode 100644 apps/comments/tests/Unit/JSSettingsHelperTest.php
diff --git a/apps/comments/js/commentstabview.js b/apps/comments/js/commentstabview.js
index 9082706e71546006f95f09aaf1512a86d6d0837c..e061ed3533008104fc53992536894f7512d9b1b6 100644
GIT binary patch
delta 131
zcmbQSgt2ES<Ax>T#yOd}nI%>V{?2-d1qIIed1;yHddc~@xv6<2#d^7k6^^AP`Of*d
i1v#lDsX?j5r8y<Vo9Bt!uv_bJae@Ik2HcXfGX?-Va4)m~
delta 19
bcmeBK$~a>Q<Ax>To9~L7v2XU1w=)I+QOgHV
diff --git a/apps/comments/lib/AppInfo/Application.php b/apps/comments/lib/AppInfo/Application.php
index f168779cd0d..a863ca506b7 100644
--- a/apps/comments/lib/AppInfo/Application.php
+++ b/apps/comments/lib/AppInfo/Application.php
@@ -22,7 +22,9 @@
namespace OCA\Comments\AppInfo;
use OCA\Comments\Controller\Notifications;
+use OCA\Comments\JSSettingsHelper;
use OCP\AppFramework\App;
+use OCP\Util;
class Application extends App {
@@ -31,5 +33,8 @@ class Application extends App {
$container = $this->getContainer();
$container->registerAlias('NotificationsController', Notifications::class);
+
+ $jsSettingsHelper = new JSSettingsHelper($container->getServer());
+ Util::connectHook('\OCP\Config', 'js', $jsSettingsHelper, 'extend');
}
}
diff --git a/apps/comments/lib/JSSettingsHelper.php b/apps/comments/lib/JSSettingsHelper.php
new file mode 100644
index 00000000000..dab68a48925
--- /dev/null
+++ b/apps/comments/lib/JSSettingsHelper.php
@@ -0,0 +1,45 @@
+<?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;
+
+
+use OCP\IServerContainer;
+
+class JSSettingsHelper {
+ /** @var IServerContainer */
+ private $c;
+
+ public function __construct(IServerContainer $c) {
+ $this->c = $c;
+ }
+
+ public function extend(array $settings) {
+ $appConfig = json_decode($settings['array']['oc_appconfig'], true);
+
+ $value = (int)$this->c->getConfig()->getAppValue('comments', 'maxAutoCompleteResults', 10);
+ $appConfig['comments']['maxAutoCompleteResults'] = $value;
+
+ $settings['array']['oc_appconfig'] = json_encode($appConfig);
+ }
+}
diff --git a/apps/comments/tests/Unit/JSSettingsHelperTest.php b/apps/comments/tests/Unit/JSSettingsHelperTest.php
new file mode 100644
index 00000000000..ad2f34c7aab
--- /dev/null
+++ b/apps/comments/tests/Unit/JSSettingsHelperTest.php
@@ -0,0 +1,73 @@
+<?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;
+
+use OCA\Comments\JSSettingsHelper;
+use OCP\IConfig;
+use OCP\IServerContainer;
+use Test\TestCase;
+
+class JSSettingsHelperTest extends TestCase {
+ /** @var IServerContainer|\PHPUnit_Framework_MockObject_MockObject */
+ protected $c;
+ /** @var JSSettingsHelper */
+ protected $helper;
+
+ public function setUp() {
+ parent::setUp();
+
+ $this->c = $this->createMock(IServerContainer::class);
+
+ $this->helper = new JSSettingsHelper($this->c);
+ }
+
+ public function testExtend() {
+ $config = $this->createMock(IConfig::class);
+ $config->expects($this->once())
+ ->method('getAppValue')
+ ->with('comments', 'maxAutoCompleteResults')
+ ->willReturn(13);
+
+ $this->c->expects($this->once())
+ ->method('getConfig')
+ ->willReturn($config);
+
+ $config = [
+ 'oc_appconfig' => json_encode([
+ 'anotherapp' => [
+ 'foo' => 'bar',
+ 'foobar' => true
+ ]
+ ])
+ ];
+
+ $this->helper->extend(['array' => &$config]);
+
+ $appConfig = json_decode($config['oc_appconfig'], true);
+ $this->assertTrue(isset($appConfig['comments']));
+ $this->assertTrue(isset($appConfig['anotherapp']));
+ $this->assertSame(2, count($appConfig['anotherapp']));
+ $this->assertSame(13, $appConfig['comments']['maxAutoCompleteResults']);
+ }
+}
diff --git a/config/config.sample.php b/config/config.sample.php
index 99d67e738c6..f8723c7d9b0 100644
--- a/config/config.sample.php
+++ b/config/config.sample.php
@@ -1232,25 +1232,6 @@ $CONFIG = array(
*/
'sharing.minSearchStringLength' => 0,
-/**
- * Collaboration
- *
- * Global settings for collaboration
- */
-
-/**
- * Defines the maximum number of auto complete results. The default is 50. This
- * is used by the auto complete backend, which for example is consumed by
- * auto completion feature in comments.
- *
- * It may look similar to sharing.maxAutocompleteResults, but there are some key
- * differences in utilization. Thus, an unlimited default is very bad. Also,
- * does not control the number of displayed results, but results fetched from
- * each user backend. A small number is crucial for performance and a positive
- * user experience.
- */
-'collaboration.maxAutocompleteResults' => 50,
-
/**
* All other configuration options
*/
diff --git a/core/Controller/AutoCompleteController.php b/core/Controller/AutoCompleteController.php
index 30b08e42503..1ed326fb3ef 100644
--- a/core/Controller/AutoCompleteController.php
+++ b/core/Controller/AutoCompleteController.php
@@ -61,12 +61,12 @@ class AutoCompleteController extends Controller {
* @param string $itemId
* @param string|null $sorter can be piped, top prio first, e.g.: "commenters|share-recipients"
* @param array $shareTypes
+ * @param int $limit
* @return DataResponse
*/
- public function get($search, $itemType, $itemId, $sorter = null, $shareTypes = [Share::SHARE_TYPE_USER]) {
+ public function get($search, $itemType, $itemId, $sorter = null, $shareTypes = [Share::SHARE_TYPE_USER], $limit = 10) {
// if enumeration/user listings are disabled, we'll receive an empty
// result from search() – thus nothing else to do here.
- $limit = $this->config->getSystemValue('collaboration.maxAutocompleteResults', 50);
list($results,) = $this->collaboratorSearch->search($search, $shareTypes, false, $limit, 0);
// there won't be exact matches without a search string
--
GitLab