Merge pull request #3567 from nextcloud/autocomplete-settings

some sharing settings

apps/files_sharing/lib/Controller/ShareesAPIController.php

@@ -24,7 +24,7 @@
  */
 namespace OCA\Files_Sharing\Controller;
 
-use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCS\OCSBadRequestException;
 use OCP\AppFramework\OCSController;
 use OCP\Contacts\IManager;
@@ -409,10 +409,22 @@ class ShareesAPIController extends OCSController {
 	 * @param int $perPage
 	 * @param int|int[] $shareType
 	 * @param bool $lookup
-	 * @return Http\DataResponse
+	 * @return DataResponse
 	 * @throws OCSBadRequestException
 	 */
 	public function search($search = '', $itemType = null, $page = 1, $perPage = 200, $shareType = null, $lookup = true) {
+
+		// only search for string larger than a given threshold
+		$threshold = (int)$this->config->getSystemValue('sharing.minSearchStringLength', 0);
+		if (strlen($search) < $threshold) {
+			return new DataResponse($this->result);
+		}
+
+		// never return more than the max. number of results configured in the config.php
+		$maxResults = (int)$this->config->getSystemValue('sharing.maxAutocompleteResults', 0);
+		if ($maxResults > 0) {
+			$perPage = min($perPage, $maxResults);
+		}
 		if ($perPage <= 0) {
 			throw new OCSBadRequestException('Invalid perPage argument');
 		}
@@ -481,7 +493,7 @@ class ShareesAPIController extends OCSController {
 	 * @param int $page
 	 * @param int $perPage
 	 * @param bool $lookup
-	 * @return Http\DataResponse
+	 * @return DataResponse
 	 * @throws OCSBadRequestException
 	 */
 	protected function searchSharees($search, $itemType, array $shareTypes, $page, $perPage, $lookup) {
@@ -533,7 +545,7 @@ class ShareesAPIController extends OCSController {
 			$this->result['exact']['emails'] = $mailResults['exact'];
 		}
 
-		$response = new Http\DataResponse($this->result);
+		$response = new DataResponse($this->result);
 
 		if (sizeof($this->reachedEndFor) < 3) {
 			$response->addHeader('Link', $this->getPaginationLink($page, [

config/config.sample.php

@@ -1185,6 +1185,17 @@ $CONFIG = array(
  */
 'sharing.managerFactory' => '\OC\Share20\ProviderFactory',
 
+/**
+ * Define max number of results returned by the user search for auto-completion
+ * Default is unlimited (value set to 0).
+ */
+'sharing.maxAutocompleteResults' => 0,
+
+/**
+ * Define the minimum length of the search string before we start auto-completion
+ * Default is no limit (value set to 0)
+ */
+'sharing.minSearchStringLength' => 0,
 
 
 /**

core/css/share.scss

@@ -78,6 +78,11 @@
 	}
 }
 
+.ui-autocomplete .autocomplete-note {
+	padding: 5px 10px;
+	color: rgba(0, 0, 0, .3);
+}
+
 #shareWithList {
 	list-style-type: none;
 	padding: 8px;

core/js/sharedialogview.js

@@ -130,18 +130,46 @@
 		},
 
 		autocompleteHandler: function (search, response) {
-			var view = this;
+			var $shareWithField = $('.shareWithField'),
-			var $loading = this.$el.find('.shareWithLoading');
+				view = this,
+				$loading = this.$el.find('.shareWithLoading'),
+				$remoteShareInfo = this.$el.find('.shareWithRemoteInfo');
+
+			var count = oc_config['sharing.minSearchStringLength'];
+			if (search.term.trim().length < count) {
+				var title = n('core',
+					'At least {count} character is needed for autocompletion',
+					'At least {count} characters are needed for autocompletion',
+					count,
+					{ count: count }
+				);
+				$shareWithField.addClass('error')
+					.attr('data-original-title', title)
+					.tooltip('hide')
+					.tooltip({
+						placement: 'bottom',
+						trigger: 'manual'
+					})
+					.tooltip('fixTitle')
+					.tooltip('show');
+				response();
+				return;
+			}
+
 			$loading.removeClass('hidden');
 			$loading.addClass('inlineblock');
-			var $remoteShareInfo = this.$el.find('.shareWithRemoteInfo');
 			$remoteShareInfo.addClass('hidden');
+
+			$shareWithField.removeClass('error')
+				.tooltip('hide');
+
+			var perPage = 200;
 			$.get(
 				OC.linkToOCS('apps/files_sharing/api/v1') + 'sharees',
 				{
 					format: 'json',
 					search: search.term.trim(),
-					perPage: 200,
+					perPage: perPage,
 					itemType: view.model.get('itemType')
 				},
 				function (result) {
@@ -232,16 +260,27 @@
 						var suggestions = users.concat(groups).concat(remotes).concat(emails).concat(lookup);
 
 						if (suggestions.length > 0) {
-							$('.shareWithField').removeClass('error')
+							$shareWithField
-								.tooltip('hide')
 								.autocomplete("option", "autoFocus", true);
+
 							response(suggestions);
+
+							// show a notice that the list is truncated
+							// this is the case if one of the search results is at least as long as the max result config option
+							if(oc_config['sharing.maxAutocompleteResults'] > 0 &&
+								Math.min(perPage, oc_config['sharing.maxAutocompleteResults'])
+								<= Math.max(users.length, groups.length, remotes.length, emails.length, lookup.length)) {
+
+								var message = t('core', 'This list is maybe truncated - please refine your search term to see more results.');
+								$('.ui-autocomplete').append('<li class="autocomplete-note">' + message + '</li>');
+							}
+
 						} else {
-							var title = t('core', 'No users or groups found for {search}', {search: $('.shareWithField').val()});
+							var title = t('core', 'No users or groups found for {search}', {search: $shareWithField.val()});
 							if (!view.configModel.get('allowGroupSharing')) {
 								title = t('core', 'No users found for {search}', {search: $('.shareWithField').val()});
 							}
-							$('.shareWithField').addClass('error')
+							$shareWithField.addClass('error')
 								.attr('data-original-title', title)
 								.tooltip('hide')
 								.tooltip({

lib/private/Template/JSConfigHelper.php

@@ -206,7 +206,9 @@ class JSConfigHelper {
 				'versionstring'		=> \OC_Util::getVersionString(),
 				'enable_avatars'	=> true, // here for legacy reasons - to not crash existing code that relies on this value
 				'lost_password_link'=> $this->config->getSystemValue('lost_password_link', null),
-				'modRewriteWorking'	=> (\OC::$server->getConfig()->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true'),
+				'modRewriteWorking'	=> ($this->config->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true'),
+				'sharing.maxAutocompleteResults' => intval($this->config->getSystemValue('sharing.maxAutocompleteResults', 0)),
+				'sharing.minSearchStringLength' => intval($this->config->getSystemValue('sharing.minSearchStringLength', 0)),
 			]),
 			"oc_appconfig" => json_encode([
 				'core' => [