diff options
Diffstat (limited to 'apps/provisioning_api/lib/Controller/AppsController.php')
| -rw-r--r-- | apps/provisioning_api/lib/Controller/AppsController.php | 152 |
1 files changed, 90 insertions, 62 deletions
diff --git a/apps/provisioning_api/lib/Controller/AppsController.php b/apps/provisioning_api/lib/Controller/AppsController.php index 30062d94a44..3f6cff7442a 100644 --- a/apps/provisioning_api/lib/Controller/AppsController.php +++ b/apps/provisioning_api/lib/Controller/AppsController.php @@ -1,125 +1,153 @@ <?php + +declare(strict_types=1); /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Joas Schilling <coding@schilljs.com> - * @author Lukas Reschke <lukas@statuscode.ch> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * @author Tom Needham <tom@owncloud.com> - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * 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, version 3, - * along with this program. If not, see <http://www.gnu.org/licenses/> - * + * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ - namespace OCA\Provisioning_API\Controller; -use \OC_App; +use OC\App\AppStore\AppNotFoundException; +use OC\Installer; +use OC_App; use OCP\App\AppPathNotFoundException; use OCP\App\IAppManager; +use OCP\AppFramework\Http; +use OCP\AppFramework\Http\Attribute\PasswordConfirmationRequired; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\OCS\OCSException; use OCP\AppFramework\OCSController; +use OCP\IAppConfig; use OCP\IRequest; class AppsController extends OCSController { - /** @var \OCP\App\IAppManager */ - private $appManager; - - /** - * @param string $appName - * @param IRequest $request - * @param IAppManager $appManager - */ public function __construct( - $appName, + string $appName, IRequest $request, - IAppManager $appManager + private IAppManager $appManager, + private Installer $installer, + private IAppConfig $appConfig, ) { parent::__construct($appName, $request); + } - $this->appManager = $appManager; + /** + * @throws \InvalidArgumentException + */ + protected function verifyAppId(string $app): string { + $cleanId = $this->appManager->cleanAppId($app); + if ($cleanId !== $app) { + throw new \InvalidArgumentException('Invalid app id given'); + } + return $cleanId; } /** - * @param string $filter - * @return DataResponse + * Get a list of installed apps + * + * @param ?string $filter Filter for enabled or disabled apps + * @return DataResponse<Http::STATUS_OK, array{apps: list<string>}, array{}> * @throws OCSException + * + * 200: Installed apps returned */ - public function getApps($filter = null) { + public function getApps(?string $filter = null): DataResponse { $apps = (new OC_App())->listAllApps(); + /** @var list<string> $list */ $list = []; - foreach($apps as $app) { + foreach ($apps as $app) { $list[] = $app['id']; } - if($filter){ - switch($filter){ + if ($filter) { + switch ($filter) { case 'enabled': return new DataResponse(['apps' => \OC_App::getEnabledApps()]); break; case 'disabled': $enabled = OC_App::getEnabledApps(); - return new DataResponse(['apps' => array_diff($list, $enabled)]); + return new DataResponse(['apps' => array_values(array_diff($list, $enabled))]); break; default: // Invalid filter variable throw new OCSException('', 101); } - } else { return new DataResponse(['apps' => $list]); } } /** - * @param string $app - * @return DataResponse + * Get the app info for an app + * + * @param string $app ID of the app + * @return DataResponse<Http::STATUS_OK, array<string, ?mixed>, array{}> * @throws OCSException + * + * 200: App info returned */ - public function getAppInfo($app) { - $info = \OCP\App::getAppInfo($app); - if(!is_null($info)) { - return new DataResponse(OC_App::getAppInfo($app)); + public function getAppInfo(string $app): DataResponse { + try { + $app = $this->verifyAppId($app); + } catch (\InvalidArgumentException $e) { + throw new OCSException($e->getMessage(), OCSController::RESPOND_UNAUTHORISED); + } + $info = $this->appManager->getAppInfo($app); + if (!is_null($info)) { + return new DataResponse($info); } - throw new OCSException('The request app was not found', \OCP\API::RESPOND_NOT_FOUND); + throw new OCSException('The request app was not found', OCSController::RESPOND_NOT_FOUND); } /** - * @PasswordConfirmationRequired - * @param string $app - * @return DataResponse + * Enable an app + * + * @param string $app ID of the app + * @return DataResponse<Http::STATUS_OK, list<empty>, array{}> * @throws OCSException + * + * 200: App enabled successfully */ - public function enable($app) { + #[PasswordConfirmationRequired] + public function enable(string $app): DataResponse { try { + $app = $this->verifyAppId($app); + + if (!$this->installer->isDownloaded($app)) { + $this->installer->downloadApp($app); + } + + if ($this->appConfig->getValueString($app, 'installed_version', '') === '') { + $this->installer->installApp($app); + } + $this->appManager->enableApp($app); - } catch (AppPathNotFoundException $e) { - throw new OCSException('The request app was not found', \OCP\API::RESPOND_NOT_FOUND); + } catch (\InvalidArgumentException $e) { + throw new OCSException($e->getMessage(), OCSController::RESPOND_UNAUTHORISED); + } catch (AppPathNotFoundException|AppNotFoundException $e) { + throw new OCSException('The request app was not found', OCSController::RESPOND_NOT_FOUND); } return new DataResponse(); } /** - * @PasswordConfirmationRequired - * @param string $app - * @return DataResponse + * Disable an app + * + * @param string $app ID of the app + * @return DataResponse<Http::STATUS_OK, list<empty>, array{}> + * @throws OCSException + * + * 200: App disabled successfully */ - public function disable($app) { - $this->appManager->disableApp($app); + #[PasswordConfirmationRequired] + public function disable(string $app): DataResponse { + try { + $app = $this->verifyAppId($app); + $this->appManager->disableApp($app); + } catch (\InvalidArgumentException $e) { + throw new OCSException($e->getMessage(), OCSController::RESPOND_UNAUTHORISED); + } return new DataResponse(); } - } |