nextcloud / server

core/Controller/UnifiedSearchController.php

Indentation +135 added lines, -135 removed lines

@@ -35,139 +35,139 @@
  * @psalm-import-type CoreUnifiedSearchResult from ResponseDefinitions
  */
 class UnifiedSearchController extends OCSController {
-	public function __construct(
-		IRequest $request,
-		private IUserSession $userSession,
-		private SearchComposer $composer,
-		private IRouter $router,
-		private IURLGenerator $urlGenerator,
-		private IL10N $l10n,
-		private IAppConfig $appConfig,
-	) {
-		parent::__construct('core', $request);
-	}
-
-	/**
-	 * Get the providers for unified search
-	 *
-	 * @param string $from the url the user is currently at
-	 * @return DataResponse<Http::STATUS_OK, list<CoreUnifiedSearchProvider>, array{}>
-	 *
-	 * 200: Providers returned
-	 */
-	#[NoAdminRequired]
-	#[NoCSRFRequired]
-	#[ApiRoute(verb: 'GET', url: '/providers', root: '/search')]
-	public function getProviders(string $from = ''): DataResponse {
-		[$route, $parameters] = $this->getRouteInformation($from);
-
-		$result = $this->composer->getProviders($route, $parameters);
-		$response = new DataResponse($result);
-		$response->setETag(md5(json_encode($result)));
-		return $response;
-	}
-
-	/**
-	 * Launch a search for a specific search provider.
-	 *
-	 * Additional filters are available for each provider.
-	 * Send a request to /providers endpoint to list providers with their available filters.
-	 *
-	 * @param string $providerId ID of the provider
-	 * @param string $term Term to search
-	 * @param int|null $sortOrder Order of entries
-	 * @param int|null $limit Maximum amount of entries (capped by configurable unified-search.max-results-per-request, default: 25)
-	 * @param int|string|null $cursor Offset for searching
-	 * @param string $from The current user URL
-	 *
-	 * @return DataResponse<Http::STATUS_OK, CoreUnifiedSearchResult, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, string, array{}>
-	 *
-	 * 200: Search entries returned
-	 * 400: Searching is not possible
-	 */
-	#[NoAdminRequired]
-	#[NoCSRFRequired]
-	#[ApiRoute(verb: 'GET', url: '/providers/{providerId}/search', root: '/search')]
-	public function search(
-		string $providerId,
-		// Unused parameter for OpenAPI spec generator
-		string $term = '',
-		?int $sortOrder = null,
-		?int $limit = null,
-		$cursor = null,
-		string $from = '',
-	): DataResponse {
-		[$route, $routeParameters] = $this->getRouteInformation($from);
-
-		$limit ??= SearchQuery::LIMIT_DEFAULT;
-		$maxLimit = $this->appConfig->getValueInt(Application::APP_ID, ConfigLexicon::UNIFIED_SEARCH_MAX_RESULTS_PER_REQUEST);
-		$limit = max(1, min($limit, $maxLimit));
-
-		try {
-			$filters = $this->composer->buildFilterList($providerId, $this->request->getParams());
-		} catch (UnsupportedFilter|InvalidArgumentException $e) {
-			return new DataResponse($e->getMessage(), Http::STATUS_BAD_REQUEST);
-		}
-
-		if ($filters->count() === 0) {
-			return new DataResponse($this->l10n->t('No valid filters provided'), Http::STATUS_BAD_REQUEST);
-		}
-
-		return new DataResponse(
-			$this->composer->search(
-				$this->userSession->getUser(),
-				$providerId,
-				new SearchQuery(
-					$filters,
-					$sortOrder ?? ISearchQuery::SORT_DATE_DESC,
-					$limit,
-					$cursor,
-					$route,
-					$routeParameters
-				)
-			)->jsonSerialize()
-		);
-	}
-
-	protected function getRouteInformation(string $url): array {
-		$routeStr = '';
-		$parameters = [];
-
-		if ($url !== '') {
-			$urlParts = parse_url($url);
-			$urlPath = $urlParts['path'];
-
-			// Optionally strip webroot from URL. Required for route matching on setups
-			// with Nextcloud in a webserver subfolder (webroot).
-			$webroot = $this->urlGenerator->getWebroot();
-			if ($webroot !== '' && substr($urlPath, 0, strlen($webroot)) === $webroot) {
-				$urlPath = substr($urlPath, strlen($webroot));
-			}
-
-			try {
-				$parameters = $this->router->findMatchingRoute($urlPath);
-
-				// contacts.PageController.index => contacts.Page.index
-				$route = $parameters['caller'];
-				if (substr($route[1], -10) === 'Controller') {
-					$route[1] = substr($route[1], 0, -10);
-				}
-				$routeStr = implode('.', $route);
-
-				// cleanup
-				unset($parameters['_route'], $parameters['action'], $parameters['caller']);
-			} catch (ResourceNotFoundException $exception) {
-			}
-
-			if (isset($urlParts['query'])) {
-				parse_str($urlParts['query'], $queryParameters);
-				$parameters = array_merge($parameters, $queryParameters);
-			}
-		}
-
-		return [
-			$routeStr,
-			$parameters,
-		];
-	}
+    public function __construct(
+        IRequest $request,
+        private IUserSession $userSession,
+        private SearchComposer $composer,
+        private IRouter $router,
+        private IURLGenerator $urlGenerator,
+        private IL10N $l10n,
+        private IAppConfig $appConfig,
+    ) {
+        parent::__construct('core', $request);
+    }
+
+    /**
+     * Get the providers for unified search
+     *
+     * @param string $from the url the user is currently at
+     * @return DataResponse<Http::STATUS_OK, list<CoreUnifiedSearchProvider>, array{}>
+     *
+     * 200: Providers returned
+     */
+    #[NoAdminRequired]
+    #[NoCSRFRequired]
+    #[ApiRoute(verb: 'GET', url: '/providers', root: '/search')]
+    public function getProviders(string $from = ''): DataResponse {
+        [$route, $parameters] = $this->getRouteInformation($from);
+
+        $result = $this->composer->getProviders($route, $parameters);
+        $response = new DataResponse($result);
+        $response->setETag(md5(json_encode($result)));
+        return $response;
+    }
+
+    /**
+     * Launch a search for a specific search provider.
+     *
+     * Additional filters are available for each provider.
+     * Send a request to /providers endpoint to list providers with their available filters.
+     *
+     * @param string $providerId ID of the provider
+     * @param string $term Term to search
+     * @param int|null $sortOrder Order of entries
+     * @param int|null $limit Maximum amount of entries (capped by configurable unified-search.max-results-per-request, default: 25)
+     * @param int|string|null $cursor Offset for searching
+     * @param string $from The current user URL
+     *
+     * @return DataResponse<Http::STATUS_OK, CoreUnifiedSearchResult, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, string, array{}>
+     *
+     * 200: Search entries returned
+     * 400: Searching is not possible
+     */
+    #[NoAdminRequired]
+    #[NoCSRFRequired]
+    #[ApiRoute(verb: 'GET', url: '/providers/{providerId}/search', root: '/search')]
+    public function search(
+        string $providerId,
+        // Unused parameter for OpenAPI spec generator
+        string $term = '',
+        ?int $sortOrder = null,
+        ?int $limit = null,
+        $cursor = null,
+        string $from = '',
+    ): DataResponse {
+        [$route, $routeParameters] = $this->getRouteInformation($from);
+
+        $limit ??= SearchQuery::LIMIT_DEFAULT;
+        $maxLimit = $this->appConfig->getValueInt(Application::APP_ID, ConfigLexicon::UNIFIED_SEARCH_MAX_RESULTS_PER_REQUEST);
+        $limit = max(1, min($limit, $maxLimit));
+
+        try {
+            $filters = $this->composer->buildFilterList($providerId, $this->request->getParams());
+        } catch (UnsupportedFilter|InvalidArgumentException $e) {
+            return new DataResponse($e->getMessage(), Http::STATUS_BAD_REQUEST);
+        }
+
+        if ($filters->count() === 0) {
+            return new DataResponse($this->l10n->t('No valid filters provided'), Http::STATUS_BAD_REQUEST);
+        }
+
+        return new DataResponse(
+            $this->composer->search(
+                $this->userSession->getUser(),
+                $providerId,
+                new SearchQuery(
+                    $filters,
+                    $sortOrder ?? ISearchQuery::SORT_DATE_DESC,
+                    $limit,
+                    $cursor,
+                    $route,
+                    $routeParameters
+                )
+            )->jsonSerialize()
+        );
+    }
+
+    protected function getRouteInformation(string $url): array {
+        $routeStr = '';
+        $parameters = [];
+
+        if ($url !== '') {
+            $urlParts = parse_url($url);
+            $urlPath = $urlParts['path'];
+
+            // Optionally strip webroot from URL. Required for route matching on setups
+            // with Nextcloud in a webserver subfolder (webroot).
+            $webroot = $this->urlGenerator->getWebroot();
+            if ($webroot !== '' && substr($urlPath, 0, strlen($webroot)) === $webroot) {
+                $urlPath = substr($urlPath, strlen($webroot));
+            }
+
+            try {
+                $parameters = $this->router->findMatchingRoute($urlPath);
+
+                // contacts.PageController.index => contacts.Page.index
+                $route = $parameters['caller'];
+                if (substr($route[1], -10) === 'Controller') {
+                    $route[1] = substr($route[1], 0, -10);
+                }
+                $routeStr = implode('.', $route);
+
+                // cleanup
+                unset($parameters['_route'], $parameters['action'], $parameters['caller']);
+            } catch (ResourceNotFoundException $exception) {
+            }
+
+            if (isset($urlParts['query'])) {
+                parse_str($urlParts['query'], $queryParameters);
+                $parameters = array_merge($parameters, $queryParameters);
+            }
+        }
+
+        return [
+            $routeStr,
+            $parameters,
+        ];
+    }
 }

core/AppInfo/ConfigLexicon.php

Indentation +79 added lines, -79 removed lines

@@ -20,89 +20,89 @@
  * Please Add & Manage your Config Keys in that file and keep the Lexicon up to date!
  */
 class ConfigLexicon implements ILexicon {
-	public const SHAREAPI_ALLOW_FEDERATION_ON_PUBLIC_SHARES = 'shareapi_allow_federation_on_public_shares';
-	public const SHARE_CUSTOM_TOKEN = 'shareapi_allow_custom_tokens';
-	public const SHARE_LINK_PASSWORD_DEFAULT = 'shareapi_enable_link_password_by_default';
-	public const SHARE_LINK_PASSWORD_ENFORCED = 'shareapi_enforce_links_password';
-	public const SHARE_LINK_EXPIRE_DATE_DEFAULT = 'shareapi_default_expire_date';
-	public const SHARE_LINK_EXPIRE_DATE_ENFORCED = 'shareapi_enforce_expire_date';
-	public const USER_LANGUAGE = 'lang';
-	public const OCM_DISCOVERY_ENABLED = 'ocm_discovery_enabled';
-	public const OCM_INVITE_ACCEPT_DIALOG = 'ocm_invite_accept_dialog';
+    public const SHAREAPI_ALLOW_FEDERATION_ON_PUBLIC_SHARES = 'shareapi_allow_federation_on_public_shares';
+    public const SHARE_CUSTOM_TOKEN = 'shareapi_allow_custom_tokens';
+    public const SHARE_LINK_PASSWORD_DEFAULT = 'shareapi_enable_link_password_by_default';
+    public const SHARE_LINK_PASSWORD_ENFORCED = 'shareapi_enforce_links_password';
+    public const SHARE_LINK_EXPIRE_DATE_DEFAULT = 'shareapi_default_expire_date';
+    public const SHARE_LINK_EXPIRE_DATE_ENFORCED = 'shareapi_enforce_expire_date';
+    public const USER_LANGUAGE = 'lang';
+    public const OCM_DISCOVERY_ENABLED = 'ocm_discovery_enabled';
+    public const OCM_INVITE_ACCEPT_DIALOG = 'ocm_invite_accept_dialog';
 
-	public const USER_LOCALE = 'locale';
-	public const USER_TIMEZONE = 'timezone';
+    public const USER_LOCALE = 'locale';
+    public const USER_TIMEZONE = 'timezone';
 
-	public const UNIFIED_SEARCH_MIN_SEARCH_LENGTH = 'unified_search_min_search_length';
-	public const UNIFIED_SEARCH_MAX_RESULTS_PER_REQUEST = 'unified_search_max_results_per_request';
+    public const UNIFIED_SEARCH_MIN_SEARCH_LENGTH = 'unified_search_min_search_length';
+    public const UNIFIED_SEARCH_MAX_RESULTS_PER_REQUEST = 'unified_search_max_results_per_request';
 
-	public const LASTCRON_TIMESTAMP = 'lastcron';
+    public const LASTCRON_TIMESTAMP = 'lastcron';
 
-	public function getStrictness(): Strictness {
-		return Strictness::IGNORE;
-	}
+    public function getStrictness(): Strictness {
+        return Strictness::IGNORE;
+    }
 
-	public function getAppConfigs(): array {
-		return [
-			new Entry(
-				key: self::SHAREAPI_ALLOW_FEDERATION_ON_PUBLIC_SHARES,
-				type: ValueType::BOOL,
-				defaultRaw: true,
-				definition: 'adds share permission to public shares to allow adding them to your Nextcloud (federation)',
-				lazy: true,
-			),
-			new Entry(
-				key: self::SHARE_CUSTOM_TOKEN,
-				type: ValueType::BOOL,
-				defaultRaw: fn (Preset $p): bool => match ($p) {
-					Preset::FAMILY, Preset::PRIVATE => true,
-					default => false,
-				},
-				definition: 'Allow users to customize share URL',
-				lazy: true,
-				note: 'Shares with guessable tokens may be accessed easily. Shares with custom tokens will continue to be accessible after this setting has been disabled.',
-			),
-			new Entry(self::SHARE_LINK_PASSWORD_DEFAULT, ValueType::BOOL, false, 'Ask for a password when sharing document by default'),
-			new Entry(
-				key: self::SHARE_LINK_PASSWORD_ENFORCED,
-				type: ValueType::BOOL,
-				defaultRaw: fn (Preset $p): bool => match ($p) {
-					Preset::SCHOOL, Preset::UNIVERSITY, Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
-					default => false,
-				},
-				definition: 'Enforce password protection for shared documents'
-			),
-			new Entry(
-				key: self::SHARE_LINK_EXPIRE_DATE_DEFAULT,
-				type: ValueType::BOOL,
-				defaultRaw: fn (Preset $p): bool => match ($p) {
-					Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
-					default => false,
-				},
-				definition: 'Default expiration date for shares via link or mail'
-			),
-			new Entry(
-				key: self::SHARE_LINK_EXPIRE_DATE_ENFORCED,
-				type: ValueType::BOOL,
-				defaultRaw: fn (Preset $p): bool => match ($p) {
-					Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
-					default => false,
-				},
-				definition: 'Enforce expiration date for shares via link or mail'
-			),
-			new Entry(self::LASTCRON_TIMESTAMP, ValueType::INT, 0, 'timestamp of last cron execution'),
-			new Entry(self::OCM_DISCOVERY_ENABLED, ValueType::BOOL, true, 'enable/disable OCM', lazy: true),
-			new Entry(self::OCM_INVITE_ACCEPT_DIALOG, ValueType::STRING, '', 'route to local invite accept dialog', lazy: true, note: 'set as empty string to disable feature'),
-			new Entry(self::UNIFIED_SEARCH_MIN_SEARCH_LENGTH, ValueType::INT, 1, 'Minimum search length to trigger the request', lazy: false, rename: 'unified-search.min-search-length'),
-			new Entry(self::UNIFIED_SEARCH_MAX_RESULTS_PER_REQUEST, ValueType::INT, 25, 'Maximum results returned per search request', lazy: false, rename: 'unified-search.max-results-per-request'),
-		];
-	}
+    public function getAppConfigs(): array {
+        return [
+            new Entry(
+                key: self::SHAREAPI_ALLOW_FEDERATION_ON_PUBLIC_SHARES,
+                type: ValueType::BOOL,
+                defaultRaw: true,
+                definition: 'adds share permission to public shares to allow adding them to your Nextcloud (federation)',
+                lazy: true,
+            ),
+            new Entry(
+                key: self::SHARE_CUSTOM_TOKEN,
+                type: ValueType::BOOL,
+                defaultRaw: fn (Preset $p): bool => match ($p) {
+                    Preset::FAMILY, Preset::PRIVATE => true,
+                    default => false,
+                },
+                definition: 'Allow users to customize share URL',
+                lazy: true,
+                note: 'Shares with guessable tokens may be accessed easily. Shares with custom tokens will continue to be accessible after this setting has been disabled.',
+            ),
+            new Entry(self::SHARE_LINK_PASSWORD_DEFAULT, ValueType::BOOL, false, 'Ask for a password when sharing document by default'),
+            new Entry(
+                key: self::SHARE_LINK_PASSWORD_ENFORCED,
+                type: ValueType::BOOL,
+                defaultRaw: fn (Preset $p): bool => match ($p) {
+                    Preset::SCHOOL, Preset::UNIVERSITY, Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
+                    default => false,
+                },
+                definition: 'Enforce password protection for shared documents'
+            ),
+            new Entry(
+                key: self::SHARE_LINK_EXPIRE_DATE_DEFAULT,
+                type: ValueType::BOOL,
+                defaultRaw: fn (Preset $p): bool => match ($p) {
+                    Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
+                    default => false,
+                },
+                definition: 'Default expiration date for shares via link or mail'
+            ),
+            new Entry(
+                key: self::SHARE_LINK_EXPIRE_DATE_ENFORCED,
+                type: ValueType::BOOL,
+                defaultRaw: fn (Preset $p): bool => match ($p) {
+                    Preset::SHARED, Preset::SMALL, Preset::MEDIUM, Preset::LARGE => true,
+                    default => false,
+                },
+                definition: 'Enforce expiration date for shares via link or mail'
+            ),
+            new Entry(self::LASTCRON_TIMESTAMP, ValueType::INT, 0, 'timestamp of last cron execution'),
+            new Entry(self::OCM_DISCOVERY_ENABLED, ValueType::BOOL, true, 'enable/disable OCM', lazy: true),
+            new Entry(self::OCM_INVITE_ACCEPT_DIALOG, ValueType::STRING, '', 'route to local invite accept dialog', lazy: true, note: 'set as empty string to disable feature'),
+            new Entry(self::UNIFIED_SEARCH_MIN_SEARCH_LENGTH, ValueType::INT, 1, 'Minimum search length to trigger the request', lazy: false, rename: 'unified-search.min-search-length'),
+            new Entry(self::UNIFIED_SEARCH_MAX_RESULTS_PER_REQUEST, ValueType::INT, 25, 'Maximum results returned per search request', lazy: false, rename: 'unified-search.max-results-per-request'),
+        ];
+    }
 
-	public function getUserConfigs(): array {
-		return [
-			new Entry(self::USER_LANGUAGE, ValueType::STRING, definition: 'language'),
-			new Entry(self::USER_LOCALE, ValueType::STRING, definition: 'locale'),
-			new Entry(self::USER_TIMEZONE, ValueType::STRING, definition: 'timezone'),
-		];
-	}
+    public function getUserConfigs(): array {
+        return [
+            new Entry(self::USER_LANGUAGE, ValueType::STRING, definition: 'language'),
+            new Entry(self::USER_LOCALE, ValueType::STRING, definition: 'locale'),
+            new Entry(self::USER_TIMEZONE, ValueType::STRING, definition: 'timezone'),
+        ];
+    }
 }