mirror of
https://github.com/nextcloud/server.git
synced 2025-02-23 00:19:14 +00:00
108 lines
3.4 KiB
PHP
108 lines
3.4 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* @copyright Copyright (c) 2023 Kate Döen <kate.doeen@nextcloud.com>
|
|
*
|
|
* @author Kate Döen <kate.doeen@nextcloud.com>
|
|
*
|
|
* @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\Settings\Controller;
|
|
|
|
use Exception;
|
|
use OC\AppFramework\Middleware\Security\Exceptions\NotAdminException;
|
|
use OC\AppFramework\Middleware\Security\Exceptions\NotLoggedInException;
|
|
use OCA\Settings\ResponseDefinitions;
|
|
use OCP\AppFramework\Http;
|
|
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
|
|
use OCP\AppFramework\Http\DataResponse;
|
|
use OCP\AppFramework\OCS\OCSBadRequestException;
|
|
use OCP\AppFramework\OCSController;
|
|
use OCP\IRequest;
|
|
use OCP\IUserSession;
|
|
use OCP\Settings\IDeclarativeManager;
|
|
use Psr\Log\LoggerInterface;
|
|
|
|
/**
|
|
* @psalm-import-type SettingsDeclarativeForm from ResponseDefinitions
|
|
*/
|
|
class DeclarativeSettingsController extends OCSController {
|
|
public function __construct(
|
|
string $appName,
|
|
IRequest $request,
|
|
private IUserSession $userSession,
|
|
private IDeclarativeManager $declarativeManager,
|
|
private LoggerInterface $logger,
|
|
) {
|
|
parent::__construct($appName, $request);
|
|
}
|
|
|
|
/**
|
|
* Sets a declarative settings value
|
|
*
|
|
* @param string $app ID of the app
|
|
* @param string $formId ID of the form
|
|
* @param string $fieldId ID of the field
|
|
* @param mixed $value Value to be saved
|
|
* @return DataResponse<Http::STATUS_OK, null, array{}>
|
|
* @throws NotLoggedInException Not logged in or not an admin user
|
|
* @throws NotAdminException Not logged in or not an admin user
|
|
* @throws OCSBadRequestException Invalid arguments to save value
|
|
*
|
|
* 200: Value set successfully
|
|
*/
|
|
#[NoAdminRequired]
|
|
public function setValue(string $app, string $formId, string $fieldId, mixed $value): DataResponse {
|
|
$user = $this->userSession->getUser();
|
|
if ($user === null) {
|
|
throw new NotLoggedInException();
|
|
}
|
|
|
|
try {
|
|
$this->declarativeManager->loadSchemas();
|
|
$this->declarativeManager->setValue($user, $app, $formId, $fieldId, $value);
|
|
return new DataResponse(null);
|
|
} catch (NotAdminException $e) {
|
|
throw $e;
|
|
} catch (Exception $e) {
|
|
$this->logger->error('Failed to set declarative settings value: ' . $e->getMessage());
|
|
throw new OCSBadRequestException();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets all declarative forms with the values prefilled.
|
|
*
|
|
* @return DataResponse<Http::STATUS_OK, list<SettingsDeclarativeForm>, array{}>
|
|
* @throws NotLoggedInException
|
|
* @NoSubAdminRequired
|
|
*
|
|
* 200: Forms returned
|
|
*/
|
|
#[NoAdminRequired]
|
|
public function getForms(): DataResponse {
|
|
$user = $this->userSession->getUser();
|
|
if ($user === null) {
|
|
throw new NotLoggedInException();
|
|
}
|
|
$this->declarativeManager->loadSchemas();
|
|
return new DataResponse($this->declarativeManager->getFormsWithValues($user, null, null));
|
|
}
|
|
}
|