Skip to content

Commit dce2a26

Browse files
authored
Merge pull request #551 from nextcloud/chore/appconfig-deprecations
chore: replaced deprecated "IConfig" methods with "IAppConfig"
2 parents 31577f0 + 0879775 commit dce2a26

File tree

10 files changed

+45
-43
lines changed

10 files changed

+45
-43
lines changed

lib/BackgroundJob/ExAppInitStatusCheckJob.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use OCP\AppFramework\Utility\ITimeFactory;
1616
use OCP\BackgroundJob\TimedJob;
1717
use OCP\DB\Exception;
18-
use OCP\IConfig;
18+
use OCP\IAppConfig;
1919

2020
class ExAppInitStatusCheckJob extends TimedJob {
2121
private const everyMinuteInterval = 60;
@@ -24,7 +24,7 @@ public function __construct(
2424
ITimeFactory $time,
2525
private readonly ExAppMapper $mapper,
2626
private readonly AppAPIService $service,
27-
private readonly IConfig $config,
27+
private readonly IAppConfig $appConfig,
2828
) {
2929
parent::__construct($time);
3030

@@ -36,7 +36,7 @@ protected function run($argument): void {
3636
// set status.progress=0 and status.error message with timeout error
3737
try {
3838
$exApps = $this->mapper->findAll();
39-
$initTimeoutMinutesSetting = intval($this->config->getAppValue(Application::APP_ID, 'init_timeout', '40'));
39+
$initTimeoutMinutesSetting = intval($this->appConfig->getValueString(Application::APP_ID, 'init_timeout', '40', lazy: true));
4040
foreach ($exApps as $exApp) {
4141
$status = $exApp->getStatus();
4242
if (isset($status['init']) && $status['init'] !== 100) {

lib/Command/Daemon/ListDaemons.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
use OCA\AppAPI\AppInfo\Application;
1313
use OCA\AppAPI\Service\DaemonConfigService;
1414

15-
use OCP\IConfig;
15+
use OCP\IAppConfig;
1616
use Symfony\Component\Console\Command\Command;
1717
use Symfony\Component\Console\Helper\Table;
1818
use Symfony\Component\Console\Input\InputInterface;
@@ -21,8 +21,8 @@
2121
class ListDaemons extends Command {
2222

2323
public function __construct(
24-
private DaemonConfigService $daemonConfigService,
25-
private IConfig $config
24+
private readonly DaemonConfigService $daemonConfigService,
25+
private readonly IAppConfig $appConfig
2626
) {
2727
parent::__construct();
2828
}
@@ -39,7 +39,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
3939
return 0;
4040
}
4141

42-
$defaultDaemonName = $this->config->getAppValue(Application::APP_ID, 'default_daemon_config');
42+
$defaultDaemonName = $this->appConfig->getValueString(Application::APP_ID, 'default_daemon_config', lazy: true);
4343

4444
$output->writeln('Registered ExApp daemon configs:');
4545
$table = new Table($output);

lib/Command/ExApp/Register.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
use OCA\AppAPI\Service\DaemonConfigService;
1818
use OCA\AppAPI\Service\ExAppService;
1919

20-
use OCP\IConfig;
20+
use OCP\IAppConfig;
2121
use OCP\Security\ISecureRandom;
2222
use Psr\Log\LoggerInterface;
2323
use Symfony\Component\Console\Command\Command;
@@ -33,7 +33,7 @@ public function __construct(
3333
private readonly DaemonConfigService $daemonConfigService,
3434
private readonly DockerActions $dockerActions,
3535
private readonly ManualActions $manualActions,
36-
private readonly IConfig $config,
36+
private readonly IAppConfig $appConfig,
3737
private readonly ExAppService $exAppService,
3838
private readonly ISecureRandom $random,
3939
private readonly LoggerInterface $logger,
@@ -118,7 +118,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
118118

119119
$daemonConfigName = $input->getArgument('daemon-config-name');
120120
if (!isset($daemonConfigName) || $daemonConfigName === '') {
121-
$daemonConfigName = $this->config->getAppValue(Application::APP_ID, 'default_daemon_config');
121+
$daemonConfigName = $this->appConfig->getValueString(Application::APP_ID, 'default_daemon_config', lazy: true);
122122
}
123123
$daemonConfig = $this->daemonConfigService->getDaemonConfigByName($daemonConfigName);
124124
if ($daemonConfig === null) {

lib/Controller/ConfigController.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,23 @@
1414
use OCP\AppFramework\Controller;
1515
use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
1616
use OCP\AppFramework\Http\DataResponse;
17-
use OCP\IConfig;
17+
use OCP\IAppConfig;
1818
use OCP\IRequest;
1919

2020
class ConfigController extends Controller {
2121

2222
public function __construct(
23-
string $appName,
24-
IRequest $request,
25-
private IConfig $config,
23+
string $appName,
24+
IRequest $request,
25+
private readonly IAppConfig $appConfig,
2626
) {
2727
parent::__construct($appName, $request);
2828
}
2929

3030
#[NoCSRFRequired]
3131
public function setAdminConfig(array $values): DataResponse {
3232
foreach ($values as $key => $value) {
33-
$this->config->setAppValue(Application::APP_ID, $key, $value);
33+
$this->appConfig->setValueString(Application::APP_ID, $key, $value, lazy: true);
3434
}
3535
return new DataResponse(1);
3636
}

lib/Controller/DaemonConfigController.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
use OCP\AppFramework\Http\Attribute\PasswordConfirmationRequired;
2222
use OCP\AppFramework\Http\JSONResponse;
2323
use OCP\AppFramework\Http\Response;
24-
use OCP\IConfig;
24+
use OCP\IAppConfig;
2525
use OCP\IL10N;
2626
use OCP\IRequest;
2727
use OCP\Security\ICrypto;
@@ -33,7 +33,7 @@ class DaemonConfigController extends ApiController {
3333

3434
public function __construct(
3535
IRequest $request,
36-
private readonly IConfig $config,
36+
private readonly IAppConfig $appConfig,
3737
private readonly DaemonConfigService $daemonConfigService,
3838
private readonly DockerActions $dockerActions,
3939
private readonly AppAPIService $service,
@@ -47,15 +47,15 @@ public function __construct(
4747
public function getAllDaemonConfigs(): Response {
4848
return new JSONResponse([
4949
'daemons' => $this->daemonConfigService->getDaemonConfigsWithAppsCount(),
50-
'default_daemon_config' => $this->config->getAppValue(Application::APP_ID, 'default_daemon_config'),
50+
'default_daemon_config' => $this->appConfig->getValueString(Application::APP_ID, 'default_daemon_config', lazy: true),
5151
]);
5252
}
5353

5454
#[PasswordConfirmationRequired]
5555
public function registerDaemonConfig(array $daemonConfigParams, bool $defaultDaemon = false): Response {
5656
$daemonConfig = $this->daemonConfigService->registerDaemonConfig($daemonConfigParams);
5757
if ($daemonConfig !== null && $defaultDaemon) {
58-
$this->config->setAppValue(Application::APP_ID, 'default_daemon_config', $daemonConfig->getName());
58+
$this->appConfig->setValueString(Application::APP_ID, 'default_daemon_config', $daemonConfig->getName(), lazy: true);
5959
}
6060
return new JSONResponse([
6161
'success' => $daemonConfig !== null,
@@ -107,10 +107,10 @@ public function updateDaemonConfig(string $name, array $daemonConfigParams): Res
107107
#[PasswordConfirmationRequired]
108108
public function unregisterDaemonConfig(string $name): Response {
109109
$daemonConfig = $this->daemonConfigService->getDaemonConfigByName($name);
110-
$defaultDaemonConfig = $this->config->getAppValue(Application::APP_ID, 'default_daemon_config', '');
110+
$defaultDaemonConfig = $this->appConfig->getValueString(Application::APP_ID, 'default_daemon_config', '', lazy: true);
111111
$this->service->removeExAppsByDaemonConfigName($daemonConfig);
112112
if ($daemonConfig->getName() === $defaultDaemonConfig) {
113-
$this->config->deleteAppValue(Application::APP_ID, 'default_daemon_config');
113+
$this->appConfig->deleteKey(Application::APP_ID, 'default_daemon_config');
114114
}
115115
$daemonConfig = $this->daemonConfigService->unregisterDaemonConfig($daemonConfig);
116116
return new JSONResponse([

lib/DeployActions/AIODockerActions.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
use OCA\AppAPI\AppInfo\Application;
1313
use OCA\AppAPI\Db\DaemonConfig;
1414
use OCA\AppAPI\Service\DaemonConfigService;
15-
use OCP\IConfig;
15+
use OCP\IAppConfig;
1616

1717
/**
1818
* Class with utils methods for AIO setup
@@ -22,7 +22,7 @@ class AIODockerActions {
2222
public const AIO_DOCKER_SOCKET_PROXY_HOST = 'nextcloud-aio-docker-socket-proxy:2375';
2323

2424
public function __construct(
25-
private readonly IConfig $config,
25+
private readonly IAppConfig $appConfig,
2626
private readonly DaemonConfigService $daemonConfigService
2727
) {
2828
}
@@ -38,7 +38,7 @@ public function isAIO(): bool {
3838
* Registers DaemonConfig with default params to use AIO Docker Socket Proxy
3939
*/
4040
public function registerAIODaemonConfig(): ?DaemonConfig {
41-
$defaultDaemonConfig = $this->config->getAppValue(Application::APP_ID, 'default_daemon_config');
41+
$defaultDaemonConfig = $this->appConfig->getValueString(Application::APP_ID, 'default_daemon_config', lazy: true);
4242
if ($defaultDaemonConfig !== '') {
4343
$daemonConfig = $this->daemonConfigService->getDaemonConfigByName(self::AIO_DAEMON_CONFIG_NAME);
4444
if ($daemonConfig !== null) {
@@ -67,7 +67,7 @@ public function registerAIODaemonConfig(): ?DaemonConfig {
6767

6868
$daemonConfig = $this->daemonConfigService->registerDaemonConfig($daemonConfigParams);
6969
if ($daemonConfig !== null) {
70-
$this->config->setAppValue(Application::APP_ID, 'default_daemon_config', $daemonConfig->getName());
70+
$this->appConfig->setValueString(Application::APP_ID, 'default_daemon_config', $daemonConfig->getName(), lazy: true);
7171
}
7272
return $daemonConfig;
7373
}

lib/DeployActions/DockerActions.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
use OCA\AppAPI\Service\HarpService;
2323
use OCP\App\IAppManager;
2424

25+
use OCP\IAppConfig;
2526
use OCP\ICertificateManager;
2627
use OCP\IConfig;
2728
use OCP\ITempManager;
@@ -43,7 +44,8 @@ class DockerActions implements IDeployActions {
4344

4445
public function __construct(
4546
private readonly LoggerInterface $logger,
46-
private readonly IConfig $config,
47+
private readonly IAppConfig $appConfig,
48+
private readonly IConfig $config,
4749
private readonly ICertificateManager $certificateManager,
4850
private readonly IAppManager $appManager,
4951
private readonly IURLGenerator $urlGenerator,
@@ -334,7 +336,7 @@ public function createContainer(string $dockerUrl, string $imageId, DaemonConfig
334336
'NetworkMode' => $params['net'],
335337
'Mounts' => $this->buildDefaultExAppVolume($params['hostname']),
336338
'RestartPolicy' => [
337-
'Name' => $this->config->getAppValue(Application::APP_ID, 'container_restart_policy', 'unless-stopped'),
339+
'Name' => $this->appConfig->getValueString(Application::APP_ID, 'container_restart_policy', 'unless-stopped', lazy: true),
338340
],
339341
],
340342
'Env' => $params['env'],

lib/Service/ExAppsPageService.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
use OCA\AppAPI\Fetcher\ExAppFetcher;
1414
use OCP\App\IAppManager;
1515
use OCP\AppFramework\Services\IInitialState;
16-
use OCP\IConfig;
16+
use OCP\IAppConfig;
1717
use OCP\IURLGenerator;
1818
use Psr\Log\LoggerInterface;
1919

@@ -23,7 +23,7 @@ public function __construct(
2323
private readonly ExAppFetcher $exAppFetcher,
2424
private readonly DaemonConfigService $daemonConfigService,
2525
private readonly DockerActions $dockerActions,
26-
private readonly IConfig $config,
26+
private readonly IAppConfig $appConfig,
2727
private readonly IAppManager $appManager,
2828
private readonly LoggerInterface $logger,
2929
private readonly IURLGenerator $urlGenerator,
@@ -44,7 +44,7 @@ public function provideAppApiState(IInitialState $initialState): void {
4444
if ($appApiEnabled) {
4545
$initialState->provideInitialState('appstoreExAppUpdateCount', count($this->exAppFetcher->getExAppsWithUpdates()));
4646

47-
$defaultDaemonConfigName = $this->config->getAppValue('app_api', 'default_daemon_config');
47+
$defaultDaemonConfigName = $this->appConfig->getValueString('app_api', 'default_daemon_config', lazy: true);
4848
if ($defaultDaemonConfigName !== '') {
4949
$daemonConfig = $this->daemonConfigService->getDaemonConfigByName($defaultDaemonConfigName);
5050
if ($daemonConfig !== null) {

lib/Settings/Admin.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use OCA\AppAPI\Service\DaemonConfigService;
1616
use OCP\AppFramework\Http\TemplateResponse;
1717
use OCP\AppFramework\Services\IInitialState;
18-
use OCP\IConfig;
18+
use OCP\IAppConfig;
1919
use OCP\Settings\ISettings;
2020
use Psr\Log\LoggerInterface;
2121

@@ -24,7 +24,7 @@ class Admin implements ISettings {
2424
public function __construct(
2525
private readonly IInitialState $initialStateService,
2626
private readonly DaemonConfigService $daemonConfigService,
27-
private readonly IConfig $config,
27+
private readonly IAppConfig $appConfig,
2828
private readonly DockerActions $dockerActions,
2929
private readonly LoggerInterface $logger,
3030
) {
@@ -33,12 +33,12 @@ public function __construct(
3333
public function getForm(): TemplateResponse {
3434
$adminInitialData = [
3535
'daemons' => $this->daemonConfigService->getDaemonConfigsWithAppsCount(),
36-
'default_daemon_config' => $this->config->getAppValue(Application::APP_ID, 'default_daemon_config'),
37-
'init_timeout' => $this->config->getAppValue(Application::APP_ID, 'init_timeout', '40'),
38-
'container_restart_policy' => $this->config->getAppValue(Application::APP_ID, 'container_restart_policy', 'unless-stopped'),
36+
'default_daemon_config' => $this->appConfig->getValueString(Application::APP_ID, 'default_daemon_config', lazy: true),
37+
'init_timeout' => $this->appConfig->getValueString(Application::APP_ID, 'init_timeout', '40'),
38+
'container_restart_policy' => $this->appConfig->getValueString(Application::APP_ID, 'container_restart_policy', 'unless-stopped'),
3939
];
4040

41-
$defaultDaemonConfigName = $this->config->getAppValue(Application::APP_ID, 'default_daemon_config');
41+
$defaultDaemonConfigName = $this->appConfig->getValueString(Application::APP_ID, 'default_daemon_config', lazy: true);
4242
if ($defaultDaemonConfigName !== '') {
4343
$daemonConfig = $this->daemonConfigService->getDaemonConfigByName($defaultDaemonConfigName);
4444
if ($daemonConfig !== null) {

lib/SetupChecks/DaemonCheck.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@
2222

2323
class DaemonCheck implements ISetupCheck {
2424
public function __construct(
25-
private IL10N $l10n,
26-
private IConfig $config,
27-
private IAppConfig $appConfig,
28-
private DockerActions $dockerActions,
29-
private LoggerInterface $logger,
30-
private DaemonConfigService $daemonConfigService,
25+
private readonly IL10N $l10n,
26+
private readonly IConfig $config,
27+
private readonly IAppConfig $appConfig,
28+
private readonly DockerActions $dockerActions,
29+
private readonly LoggerInterface $logger,
30+
private readonly DaemonConfigService $daemonConfigService,
3131
) {
3232
}
3333

@@ -40,7 +40,7 @@ public function getCategory(): string {
4040
}
4141

4242
public function getDefaultDaemonConfig(): ?DaemonConfig {
43-
$defaultDaemonConfigName = $this->appConfig->getValueString(Application::APP_ID, 'default_daemon_config');
43+
$defaultDaemonConfigName = $this->appConfig->getValueString(Application::APP_ID, 'default_daemon_config', lazy: true);
4444
if ($defaultDaemonConfigName === '') {
4545
return null;
4646
}

0 commit comments

Comments
 (0)