configurable amount of autocomplete results in comments
Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
This commit is contained in:
parent
bd951e926f
commit
ca72c0150b
|
@ -179,6 +179,7 @@
|
||||||
var s = this;
|
var s = this;
|
||||||
$target.atwho({
|
$target.atwho({
|
||||||
at: '@',
|
at: '@',
|
||||||
|
limit: OC.appConfig.comments.maxAutoCompleteResults,
|
||||||
callbacks: {
|
callbacks: {
|
||||||
remoteFilter: s._onAutoComplete,
|
remoteFilter: s._onAutoComplete,
|
||||||
highlighter: function (li) {
|
highlighter: function (li) {
|
||||||
|
@ -237,7 +238,8 @@
|
||||||
search: query,
|
search: query,
|
||||||
itemType: 'files',
|
itemType: 'files',
|
||||||
itemId: s.model.get('id'),
|
itemId: s.model.get('id'),
|
||||||
sorter: 'comments|share-recipients'
|
sorter: 'comments|share-recipients',
|
||||||
|
limit: OC.appConfig.comments.maxAutoCompleteResults
|
||||||
},
|
},
|
||||||
function (data) {
|
function (data) {
|
||||||
callback(data);
|
callback(data);
|
||||||
|
|
|
@ -22,7 +22,9 @@
|
||||||
namespace OCA\Comments\AppInfo;
|
namespace OCA\Comments\AppInfo;
|
||||||
|
|
||||||
use OCA\Comments\Controller\Notifications;
|
use OCA\Comments\Controller\Notifications;
|
||||||
|
use OCA\Comments\JSSettingsHelper;
|
||||||
use OCP\AppFramework\App;
|
use OCP\AppFramework\App;
|
||||||
|
use OCP\Util;
|
||||||
|
|
||||||
class Application extends App {
|
class Application extends App {
|
||||||
|
|
||||||
|
@ -31,5 +33,8 @@ class Application extends App {
|
||||||
$container = $this->getContainer();
|
$container = $this->getContainer();
|
||||||
|
|
||||||
$container->registerAlias('NotificationsController', Notifications::class);
|
$container->registerAlias('NotificationsController', Notifications::class);
|
||||||
|
|
||||||
|
$jsSettingsHelper = new JSSettingsHelper($container->getServer());
|
||||||
|
Util::connectHook('\OCP\Config', 'js', $jsSettingsHelper, 'extend');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -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);
|
||||||
|
}
|
||||||
|
}
|
|
@ -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']);
|
||||||
|
}
|
||||||
|
}
|
|
@ -1232,25 +1232,6 @@ $CONFIG = array(
|
||||||
*/
|
*/
|
||||||
'sharing.minSearchStringLength' => 0,
|
'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
|
* All other configuration options
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -61,12 +61,12 @@ class AutoCompleteController extends Controller {
|
||||||
* @param string $itemId
|
* @param string $itemId
|
||||||
* @param string|null $sorter can be piped, top prio first, e.g.: "commenters|share-recipients"
|
* @param string|null $sorter can be piped, top prio first, e.g.: "commenters|share-recipients"
|
||||||
* @param array $shareTypes
|
* @param array $shareTypes
|
||||||
|
* @param int $limit
|
||||||
* @return DataResponse
|
* @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
|
// if enumeration/user listings are disabled, we'll receive an empty
|
||||||
// result from search() – thus nothing else to do here.
|
// 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);
|
list($results,) = $this->collaboratorSearch->search($search, $shareTypes, false, $limit, 0);
|
||||||
|
|
||||||
// there won't be exact matches without a search string
|
// there won't be exact matches without a search string
|
||||||
|
|
Loading…
Reference in New Issue