Skip to content

refactor(updater): Move updater to a Controller #58576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CarlSchwan wants to merge 1 commit into
base: master
Choose a base branch
from
Open

refactor(updater): Move updater to a Controller #58576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 176 additions & 0 deletions core/Controller/UpdateController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH
* SPDX-FileContributor: Carl Schwan
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OC\Core\Controller;

use OC\Core\Listener\FeedBackHandler;
use OC\DB\MigratorExecuteSqlEvent;
use OC\Repair\Events\RepairAdvanceEvent;
use OC\Repair\Events\RepairErrorEvent;
use OC\Repair\Events\RepairFinishEvent;
use OC\Repair\Events\RepairInfoEvent;
use OC\Repair\Events\RepairStartEvent;
use OC\Repair\Events\RepairStepEvent;
use OC\Repair\Events\RepairWarningEvent;
use OC\Updater;
use OCP\AppFramework\Http\Attribute\ApiRoute;
use OCP\AppFramework\Http\Attribute\PublicPage;
use OCP\AppFramework\Http\DataResponse;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IConfig;
use OCP\IEventSourceFactory;
use OCP\IL10N;
use OCP\IRequest;
use OCP\Util;
use Psr\Log\LoggerInterface;

class UpdateController extends \OCP\AppFramework\OCSController {
public function __construct(
string $appName,
IRequest $request,
private readonly IEventSourceFactory $eventSourceFactory,
private readonly IL10N $l,
private readonly IConfig $config,
private readonly Updater $updater,
private readonly IEventDispatcher $dispatcher,
private readonly LoggerInterface $logger,
) {
parent::__construct($appName, $request);
}

/**
* Update the server via the web interface
*
* @return DataResponse<Http::STATUS_OK, array{}, array{}>

Check failure on line 51 in core/Controller/UpdateController.php

View workflow job for this annotation

GitHub Actions / static-code-analysis

UndefinedDocblockClass 

core/Controller/UpdateController.php:51:13: UndefinedDocblockClass: Docblock-defined class, interface or enum named OC\Core\Controller\Http does not exist (see https://psalm.dev/200)

Check failure on line 51 in core/Controller/UpdateController.php

View workflow job for this annotation

GitHub Actions / static-code-analysis

InvalidTemplateParam 

core/Controller/UpdateController.php:51:13: InvalidTemplateParam: Extended template param S of OCP\AppFramework\Http\DataResponse<OC\Core\Controller\Http::STATUS_OK, array<never, never>, array<never, never>> expects type 100|101|102|200|201|202|203|204|205|206|207|208|226|300|301|302|303|304|305|306|307|400|401|402|403|404|405|406|407|408|409|410|411|412|413|414|415|416|417|418|422|423|424|426|428|429|431|500|501|502|503|504|505|506|507|508|509|510|511, type OC\Core\Controller\Http::STATUS_OK given (see https://psalm.dev/183)
* 200: Success
*/
#[ApiRoute(verb: 'GET', url: '/update', root: '/core')]
#[PublicPage]
public function update(): DataResponse {
if (!str_contains(@ini_get('disable_functions'), 'set_time_limit')) {
@set_time_limit(0);
}

\OC_User::setIncognitoMode(true);

$eventSource = $this->eventSourceFactory->create();
// need to send an initial message to force-init the event source,
// which will then trigger its own CSRF check and produces its own CSRF error
// message
$eventSource->send('success', $this->l->t('Preparing update'));
if (!Util::needUpgrade()) {
$eventSource->send('notice', $this->l->t('Already up to date'));
$eventSource->send('done', '');
$eventSource->close();
return new DataResponse([]);
}

if ($this->config->getSystemValueBool('upgrade.disable-web', false)) {
$eventSource->send('failure', $this->l->t('Please use the command line updater because updating via browser is disabled in your config.php.'));
$eventSource->close();
return new DataResponse([]);
}

// if a user is currently logged in, their session must be ignored to
// avoid side effects
\OC_User::setIncognitoMode(true);

$incompatibleApps = [];
$incompatibleOverwrites = $this->config->getSystemValue('app_install_overwrite', []);

$this->dispatcher->addListener(
MigratorExecuteSqlEvent::class,
function (MigratorExecuteSqlEvent $event) use ($eventSource): void {
$eventSource->send('success', $this->l->t('[%d / %d]: %s', [$event->getCurrentStep(), $event->getMaxStep(), $event->getSql()]));
}
);
$feedBack = new FeedBackHandler($eventSource, $this->l);
$this->dispatcher->addListener(RepairStartEvent::class, $feedBack->handleRepairFeedback(...));
$this->dispatcher->addListener(RepairAdvanceEvent::class, $feedBack->handleRepairFeedback(...));
$this->dispatcher->addListener(RepairFinishEvent::class, $feedBack->handleRepairFeedback(...));
$this->dispatcher->addListener(RepairStepEvent::class, $feedBack->handleRepairFeedback(...));
$this->dispatcher->addListener(RepairInfoEvent::class, $feedBack->handleRepairFeedback(...));
$this->dispatcher->addListener(RepairWarningEvent::class, $feedBack->handleRepairFeedback(...));
$this->dispatcher->addListener(RepairErrorEvent::class, $feedBack->handleRepairFeedback(...));

$this->updater->listen('\OC\Updater', 'maintenanceEnabled', function () use ($eventSource): void {
$eventSource->send('success', $this->l->t('Turned on maintenance mode'));
});
$this->updater->listen('\OC\Updater', 'maintenanceDisabled', function () use ($eventSource): void {
$eventSource->send('success', $this->l->t('Turned off maintenance mode'));
});
$this->updater->listen('\OC\Updater', 'maintenanceActive', function () use ($eventSource): void {
$eventSource->send('success', $this->l->t('Maintenance mode is kept active'));
});
$this->updater->listen('\OC\Updater', 'dbUpgradeBefore', function () use ($eventSource): void {
$eventSource->send('success', $this->l->t('Updating database schema'));
});
$this->updater->listen('\OC\Updater', 'dbUpgrade', function () use ($eventSource): void {
$eventSource->send('success', $this->l->t('Updated database'));
});
$this->updater->listen('\OC\Updater', 'upgradeAppStoreApp', function ($app) use ($eventSource): void {
$eventSource->send('success', $this->l->t('Update app "%s" from App Store', [$app]));
});
$this->updater->listen('\OC\Updater', 'appSimulateUpdate', function ($app) use ($eventSource): void {
$eventSource->send('success', $this->l->t('Checking whether the database schema for %s can be updated (this can take a long time depending on the database size)', [$app]));
});
$this->updater->listen('\OC\Updater', 'appUpgrade', function ($app, $version) use ($eventSource): void {
$eventSource->send('success', $this->l->t('Updated "%1$s" to %2$s', [$app, $version]));
});
$this->updater->listen('\OC\Updater', 'incompatibleAppDisabled', function ($app) use (&$incompatibleApps, &$incompatibleOverwrites): void {
if (!in_array($app, $incompatibleOverwrites)) {
$incompatibleApps[] = $app;
}
});
$this->updater->listen('\OC\Updater', 'failure', function ($message) use ($eventSource): void {
$eventSource->send('failure', $message);
$this->config->setSystemValue('maintenance', false);
});
$this->updater->listen('\OC\Updater', 'setDebugLogLevel', function ($logLevel, $logLevelName) use ($eventSource): void {
$eventSource->send('success', $this->l->t('Set log level to debug'));
});
$this->updater->listen('\OC\Updater', 'resetLogLevel', function ($logLevel, $logLevelName) use ($eventSource): void {
$eventSource->send('success', $this->l->t('Reset log level'));
});
$this->updater->listen('\OC\Updater', 'startCheckCodeIntegrity', function () use ($eventSource): void {
$eventSource->send('success', $this->l->t('Starting code integrity check'));
});
$this->updater->listen('\OC\Updater', 'finishedCheckCodeIntegrity', function () use ($eventSource): void {
$eventSource->send('success', $this->l->t('Finished code integrity check'));
});

try {
$this->updater->upgrade();
} catch (\Exception $e) {
$this->logger->error(
$e->getMessage(),
[
'exception' => $e,
'app' => 'update',
]);
$eventSource->send('failure', get_class($e) . ': ' . $e->getMessage());
$eventSource->close();
return new DataResponse([]);
}

$disabledApps = [];
foreach ($incompatibleApps as $app) {
$disabledApps[$app] = $this->l->t('%s (incompatible)', [$app]);
}

if (!empty($disabledApps)) {
$eventSource->send('notice', $this->l->t('The following apps have been disabled: %s', [implode(', ', $disabledApps)]));
}

$eventSource->send('done', '');
$eventSource->close();
return new DataResponse([]);
}
}
151 changes: 0 additions & 151 deletions core/ajax/update.php
View file
Open in desktop

This file was deleted.

62 changes: 62 additions & 0 deletions core/openapi-full.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9002,6 +9002,68 @@
}
}
},
"/ocs/v2.php/core/update": {
"get": {
"operationId": "update-update",
"summary": "Update the server via the web interface",
"tags": [
"update"
],
"security": [
{},
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
"required": true,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
}
}
},
"/index.php/avatar/{userId}/{size}/dark": {
"get": {
"operationId": "avatar-get-avatar-dark",
Expand Down
Loading
Loading