diff options
Diffstat (limited to 'core/Controller/OCSController.php')
| -rw-r--r-- | core/Controller/OCSController.php | 99 |
1 files changed, 42 insertions, 57 deletions
diff --git a/core/Controller/OCSController.php b/core/Controller/OCSController.php index b40776fcfb8..fb0280479c4 100644 --- a/core/Controller/OCSController.php +++ b/core/Controller/OCSController.php @@ -1,61 +1,41 @@ <?php + /** - * @copyright Copyright (c) 2016 Roeland Jago Douma <roeland@famdouma.nl> - * - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @author Daniel Kesselberg <mail@danielkesselberg.de> - * @author Joas Schilling <coding@schilljs.com> - * @author Julius Härtl <jus@bitgrid.net> - * @author Lukas Reschke <lukas@statuscode.ch> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * - * @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/>. - * + * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ namespace OC\Core\Controller; use OC\CapabilitiesManager; use OC\Security\IdentityProof\Manager; +use OCP\AppFramework\Http; +use OCP\AppFramework\Http\Attribute\ApiRoute; +use OCP\AppFramework\Http\Attribute\BruteForceProtection; +use OCP\AppFramework\Http\Attribute\OpenAPI; +use OCP\AppFramework\Http\Attribute\PublicPage; use OCP\AppFramework\Http\DataResponse; use OCP\IRequest; use OCP\IUserManager; use OCP\IUserSession; +use OCP\ServerVersion; +use OCP\Util; class OCSController extends \OCP\AppFramework\OCSController { - private CapabilitiesManager $capabilitiesManager; - private IUserSession $userSession; - private IUserManager $userManager; - private Manager $keyManager; - - public function __construct(string $appName, - IRequest $request, - CapabilitiesManager $capabilitiesManager, - IUserSession $userSession, - IUserManager $userManager, - Manager $keyManager) { + public function __construct( + string $appName, + IRequest $request, + private CapabilitiesManager $capabilitiesManager, + private IUserSession $userSession, + private IUserManager $userManager, + private Manager $keyManager, + private ServerVersion $serverVersion, + ) { parent::__construct($appName, $request); - $this->capabilitiesManager = $capabilitiesManager; - $this->userSession = $userSession; - $this->userManager = $userManager; - $this->keyManager = $keyManager; } - /** - * @PublicPage - */ + #[PublicPage] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] + #[ApiRoute(verb: 'GET', url: '/config', root: '')] public function getConfig(): DataResponse { $data = [ 'version' => '1.7', @@ -69,18 +49,23 @@ class OCSController extends \OCP\AppFramework\OCSController { } /** - * @PublicPage + * Get the capabilities + * + * @return DataResponse<Http::STATUS_OK, array{version: array{major: int, minor: int, micro: int, string: string, edition: '', extendedSupport: bool}, capabilities: array<string, mixed>}, array{}> + * + * 200: Capabilities returned */ + #[PublicPage] + #[ApiRoute(verb: 'GET', url: '/capabilities', root: '/cloud')] public function getCapabilities(): DataResponse { $result = []; - [$major, $minor, $micro] = \OCP\Util::getVersion(); $result['version'] = [ - 'major' => $major, - 'minor' => $minor, - 'micro' => $micro, - 'string' => \OC_Util::getVersionString(), + 'major' => $this->serverVersion->getMajorVersion(), + 'minor' => $this->serverVersion->getMinorVersion(), + 'micro' => $this->serverVersion->getPatchVersion(), + 'string' => $this->serverVersion->getVersionString(), 'edition' => '', - 'extendedSupport' => \OCP\Util::hasExtendedSupport() + 'extendedSupport' => Util::hasExtendedSupport() ]; if ($this->userSession->isLoggedIn()) { @@ -94,10 +79,10 @@ class OCSController extends \OCP\AppFramework\OCSController { return $response; } - /** - * @PublicPage - * @BruteForceProtection(action=login) - */ + #[PublicPage] + #[BruteForceProtection(action: 'login')] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] + #[ApiRoute(verb: 'POST', url: '/check', root: '/person')] public function personCheck(string $login = '', string $password = ''): DataResponse { if ($login !== '' && $password !== '') { if ($this->userManager->checkPassword($login, $password)) { @@ -115,9 +100,9 @@ class OCSController extends \OCP\AppFramework\OCSController { return new DataResponse([], 101); } - /** - * @PublicPage - */ + #[PublicPage] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] + #[ApiRoute(verb: 'GET', url: '/key/{cloudId}', root: '/identityproof')] public function getIdentityProof(string $cloudId): DataResponse { $userObject = $this->userManager->get($cloudId); @@ -129,6 +114,6 @@ class OCSController extends \OCP\AppFramework\OCSController { return new DataResponse($data); } - return new DataResponse(['User not found'], 404); + return new DataResponse(['Account not found'], 404); } } |