nextcloud
/
server
mirror of https://github.com/nextcloud/server
0
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #33640 from nextcloud/fix/fix-symfony-event-typing 

Port Repair and Migrator events to IEventDispatcher
This commit is contained in:
Côme Chilliet 2022-08-30 14:47:05 +02:00 committed by GitHub
parent 66648011c6 0b9a878250
commit f56ecf9242
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
26 changed files with 684 additions and 397 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
build/psalm-baseline.xml
View File

@ -3946,23 +3946,6 @@
<code>$path</code>
</InvalidReturnStatement>
</file>
<file src="lib/private/Updater.php">
<InvalidScalarArgument occurrences="13">
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>1</code>
<code>1</code>
<code>1</code>
<code>1</code>
</InvalidScalarArgument>
</file>
<file src="lib/private/Updater/VersionCheck.php">
<InvalidScalarArgument occurrences="2">
<code>microtime(true)</code>

72
core/Command/Maintenance/Repair.php
View File

@ -30,24 +30,31 @@ namespace OC\Core\Command\Maintenance;
use Exception;
use OCP\App\IAppManager;
use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IConfig;
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 Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
class Repair extends Command {
protected \OC\Repair $repair;
protected IConfig $config;
private EventDispatcherInterface $dispatcher;
private IEventDispatcher $dispatcher;
private ProgressBar $progress;
private OutputInterface $output;
private IAppManager $appManager;
public function __construct(\OC\Repair $repair, IConfig $config, EventDispatcherInterface $dispatcher, IAppManager $appManager) {
public function __construct(\OC\Repair $repair, IConfig $config, IEventDispatcher $dispatcher, IAppManager $appManager) {
$this->repair = $repair;
$this->config = $config;
$this->dispatcher = $dispatcher;
@ -102,13 +109,13 @@ class Repair extends Command {
$this->progress = new ProgressBar($output);
$this->output = $output;
$this->dispatcher->addListener('\OC\Repair::startProgress', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::advance', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::finishProgress', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::step', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::info', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::warning', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::error', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairStartEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairAdvanceEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairFinishEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairStepEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairInfoEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairWarningEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairErrorEvent::class, [$this, 'handleRepairFeedBack']);
$this->repair->run();
@ -116,33 +123,22 @@ class Repair extends Command {
return 0;
}
public function handleRepairFeedBack($event) {
if (!$event instanceof GenericEvent) {
return;
}
switch ($event->getSubject()) {
case '\OC\Repair::startProgress':
$this->progress->start($event->getArgument(0));
break;
case '\OC\Repair::advance':
$this->progress->advance($event->getArgument(0));
break;
case '\OC\Repair::finishProgress':
$this->progress->finish();
$this->output->writeln('');
break;
case '\OC\Repair::step':
$this->output->writeln(' - ' . $event->getArgument(0));
break;
case '\OC\Repair::info':
$this->output->writeln(' - ' . $event->getArgument(0));
break;
case '\OC\Repair::warning':
$this->output->writeln(' - WARNING: ' . $event->getArgument(0));
break;
case '\OC\Repair::error':
$this->output->writeln('<error> - ERROR: ' . $event->getArgument(0) . '</error>');
break;
public function handleRepairFeedBack(Event $event): void {
if ($event instanceof RepairStartEvent) {
$this->progress->start($event->getMaxStep());
} elseif ($event instanceof RepairAdvanceEvent) {
$this->progress->advance($event->getIncrement());
} elseif ($event instanceof RepairFinishEvent) {
$this->progress->finish();
$this->output->writeln('');
} elseif ($event instanceof RepairStepEvent) {
$this->output->writeln('<info> - ' . $event->getStepName() . '</info>');
} elseif ($event instanceof RepairInfoEvent) {
$this->output->writeln('<info> - ' . $event->getMessage() . '</info>');
} elseif ($event instanceof RepairWarningEvent) {
$this->output->writeln('<comment> - WARNING: ' . $event->getMessage()) . '</comment>';
} elseif ($event instanceof RepairErrorEvent) {
$this->output->writeln('<error> - ERROR: ' . $event->getMessage() . '</error>');
}
}
}

139
core/Command/Upgrade.php
View File

@ -33,17 +33,26 @@
*/
namespace OC\Core\Command;
use OC\Console\TimestampFormatter;
use OC\Installer;
use OC\Updater;
use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IConfig;
use OCP\Util;
use OC\Console\TimestampFormatter;
use OC\DB\MigratorExecuteSqlEvent;
use OC\Installer;
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 Psr\Log\LoggerInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
class Upgrade extends Command {
public const ERROR_SUCCESS = 0;
@ -92,84 +101,70 @@ class Upgrade extends Command {
$this->installer
);
$dispatcher = \OC::$server->getEventDispatcher();
/** @var IEventDispatcher $dispatcher */
$dispatcher = \OC::$server->get(IEventDispatcher::class);
$progress = new ProgressBar($output);
$progress->setFormat(" %message%\n %current%/%max% [%bar%] %percent:3s%%");
$listener = function ($event) use ($progress, $output) {
if ($event instanceof GenericEvent) {
$message = $event->getSubject();
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln(' Checking table ' . $message);
} else {
if (strlen($message) > 60) {
$message = substr($message, 0, 57) . '...';
}
$progress->setMessage($message);
if ($event[0] === 1) {
$output->writeln('');
$progress->start($event[1]);
}
$progress->setProgress($event[0]);
if ($event[0] === $event[1]) {
$progress->setMessage('Done');
$progress->finish();
$output->writeln('');
}
$listener = function (MigratorExecuteSqlEvent $event) use ($progress, $output): void {
$message = $event->getSql();
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln(' Executing SQL ' . $message);
} else {
if (strlen($message) > 60) {
$message = substr($message, 0, 57) . '...';
}
}
};
$repairListener = function ($event) use ($progress, $output) {
if (!$event instanceof GenericEvent) {
return;
}
switch ($event->getSubject()) {
case '\OC\Repair::startProgress':
$progress->setMessage('Starting ...');
$output->writeln($event->getArgument(1));
$progress->setMessage($message);
if ($event->getCurrentStep() === 1) {
$output->writeln('');
$progress->start($event->getArgument(0));
break;
case '\OC\Repair::advance':
$desc = $event->getArgument(1);
if (!empty($desc)) {
$progress->setMessage($desc);
}
$progress->advance($event->getArgument(0));
break;
case '\OC\Repair::finishProgress':
$progress->start($event->getMaxStep());
}
$progress->setProgress($event->getCurrentStep());
if ($event->getCurrentStep() === $event->getMaxStep()) {
$progress->setMessage('Done');
$progress->finish();
$output->writeln('');
break;
case '\OC\Repair::step':
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln('<info>Repair step: ' . $event->getArgument(0) . '</info>');
}
break;
case '\OC\Repair::info':
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln('<info>Repair info: ' . $event->getArgument(0) . '</info>');
}
break;
case '\OC\Repair::warning':
$output->writeln('<error>Repair warning: ' . $event->getArgument(0) . '</error>');
break;
case '\OC\Repair::error':
$output->writeln('<error>Repair error: ' . $event->getArgument(0) . '</error>');
break;
}
}
};
$repairListener = function (Event $event) use ($progress, $output): void {
if ($event instanceof RepairStartEvent) {
$progress->setMessage('Starting ...');
$output->writeln($event->getCurrentStepName());
$output->writeln('');
$progress->start($event->getMaxStep());
} elseif ($event instanceof RepairAdvanceEvent) {
$desc = $event->getDescription();
if (!empty($desc)) {
$progress->setMessage($desc);
}
$progress->advance($event->getIncrement());
} elseif ($event instanceof RepairFinishEvent) {
$progress->setMessage('Done');
$progress->finish();
$output->writeln('');
} elseif ($event instanceof RepairStepEvent) {
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln('<info>Repair step: ' . $event->getStepName() . '</info>');
}
} elseif ($event instanceof RepairInfoEvent) {
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln('<info>Repair info: ' . $event->getMessage() . '</info>');
}
} elseif ($event instanceof RepairWarningEvent) {
$output->writeln('<error>Repair warning: ' . $event->getMessage() . '</error>');
} elseif ($event instanceof RepairErrorEvent) {
$output->writeln('<error>Repair error: ' . $event->getMessage() . '</error>');
}
};
$dispatcher->addListener('\OC\DB\Migrator::executeSql', $listener);
$dispatcher->addListener('\OC\DB\Migrator::checkTable', $listener);
$dispatcher->addListener('\OC\Repair::startProgress', $repairListener);
$dispatcher->addListener('\OC\Repair::advance', $repairListener);
$dispatcher->addListener('\OC\Repair::finishProgress', $repairListener);
$dispatcher->addListener('\OC\Repair::step', $repairListener);
$dispatcher->addListener('\OC\Repair::info', $repairListener);
$dispatcher->addListener('\OC\Repair::warning', $repairListener);
$dispatcher->addListener('\OC\Repair::error', $repairListener);
$dispatcher->addListener(MigratorExecuteSqlEvent::class, $listener);
$dispatcher->addListener(RepairStartEvent::class, $repairListener);
$dispatcher->addListener(RepairAdvanceEvent::class, $repairListener);
$dispatcher->addListener(RepairFinishEvent::class, $repairListener);
$dispatcher->addListener(RepairStepEvent::class, $repairListener);
$dispatcher->addListener(RepairInfoEvent::class, $repairListener);
$dispatcher->addListener(RepairWarningEvent::class, $repairListener);
$dispatcher->addListener(RepairErrorEvent::class, $repairListener);
$updater->listen('\OC\Updater', 'maintenanceEnabled', function () use ($output) {

119
core/ajax/update.php
View File

@ -30,8 +30,19 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IEventSource;
use OCP\IL10N;
use OCP\ILogger;
use Symfony\Component\EventDispatcher\GenericEvent;
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;
if (strpos(@ini_get('disable_functions'), 'set_time_limit') === false) {
@set_time_limit(0);
@ -48,57 +59,40 @@ $eventSource = \OC::$server->createEventSource();
$eventSource->send('success', $l->t('Preparing update'));
class FeedBackHandler {
/** @var integer */
private $progressStateMax = 100;
/** @var integer */
private $progressStateStep = 0;
/** @var string */
private $currentStep;
/** @var \OCP\IEventSource */
private $eventSource;
/** @var \OCP\IL10N */
private $l10n;
private int $progressStateMax = 100;
private int $progressStateStep = 0;
private string $currentStep = '';
private IEventSource $eventSource;
private IL10N $l10n;
public function __construct(\OCP\IEventSource $eventSource, \OCP\IL10N $l10n) {
public function __construct(IEventSource $eventSource, IL10N $l10n) {
$this->eventSource = $eventSource;
$this->l10n = $l10n;
}
public function handleRepairFeedback($event) {
if (!$event instanceof GenericEvent) {
return;
}
switch ($event->getSubject()) {
case '\OC\Repair::startProgress':
$this->progressStateMax = $event->getArgument(0);
$this->progressStateStep = 0;
$this->currentStep = $event->getArgument(1);
break;
case '\OC\Repair::advance':
$this->progressStateStep += $event->getArgument(0);
$desc = $event->getArgument(1);
if (empty($desc)) {
$desc = $this->currentStep;
}
$this->eventSource->send('success', $this->l10n->t('[%d / %d]: %s', [$this->progressStateStep, $this->progressStateMax, $desc]));
break;
case '\OC\Repair::finishProgress':
$this->progressStateMax = $this->progressStateStep;
$this->eventSource->send('success', $this->l10n->t('[%d / %d]: %s', [$this->progressStateStep, $this->progressStateMax, $this->currentStep]));
break;
case '\OC\Repair::step':
$this->eventSource->send('success', $this->l10n->t('Repair step:') . ' ' . $event->getArgument(0));
break;
case '\OC\Repair::info':
$this->eventSource->send('success', $this->l10n->t('Repair info:') . ' ' . $event->getArgument(0));
break;
case '\OC\Repair::warning':
$this->eventSource->send('notice', $this->l10n->t('Repair warning:') . ' ' . $event->getArgument(0));
break;
case '\OC\Repair::error':
$this->eventSource->send('notice', $this->l10n->t('Repair error:') . ' ' . $event->getArgument(0));
break;
public function handleRepairFeedback(Event $event): void {
if ($event instanceof RepairStartEvent) {
$this->progressStateMax = $event->getMaxStep();
$this->progressStateStep = 0;
$this->currentStep = $event->getCurrentStepName();
} elseif ($event instanceof RepairAdvanceEvent) {
$this->progressStateStep += $event->getIncrement();
$desc = $event->getDescription();
if (empty($desc)) {
$desc = $this->currentStep;
}
$this->eventSource->send('success', $this->l10n->t('[%d / %d]: %s', [$this->progressStateStep, $this->progressStateMax, $desc]));
} elseif ($event instanceof RepairFinishEvent) {
$this->progressStateMax = $this->progressStateStep;
$this->eventSource->send('success', $this->l10n->t('[%d / %d]: %s', [$this->progressStateStep, $this->progressStateMax, $this->currentStep]));
} elseif ($event instanceof RepairStepEvent) {
$this->eventSource->send('success', $this->l10n->t('Repair step:') . ' ' . $event->getStepName());
} elseif ($event instanceof RepairInfoEvent) {
$this->eventSource->send('success', $this->l10n->t('Repair info:') . ' ' . $event->getMessage());
} elseif ($event instanceof RepairWarningEvent) {
$this->eventSource->send('notice', $this->l10n->t('Repair warning:') . ' ' . $event->getMessage());
} elseif ($event instanceof RepairErrorEvent) {
$this->eventSource->send('error', $this->l10n->t('Repair error:') . ' ' . $event->getMessage());
}
}
}
@ -125,25 +119,22 @@ if (\OCP\Util::needUpgrade()) {
);
$incompatibleApps = [];
$dispatcher = \OC::$server->getEventDispatcher();
$dispatcher->addListener('\OC\DB\Migrator::executeSql', function ($event) use ($eventSource, $l) {
if ($event instanceof GenericEvent) {
$eventSource->send('success', $l->t('[%d / %d]: %s', [$event[0], $event[1], $event->getSubject()]));
/** @var IEventDispatcher $dispatcher */
$dispatcher = \OC::$server->get(IEventDispatcher::class);
$dispatcher->addListener(
MigratorExecuteSqlEvent::class,
function (MigratorExecuteSqlEvent $event) use ($eventSource, $l): void {
$eventSource->send('success', $l->t('[%d / %d]: %s', [$event->getCurrentStep(), $event->getMaxStep(), $event->getSql()]));
}
});
$dispatcher->addListener('\OC\DB\Migrator::checkTable', function ($event) use ($eventSource, $l) {
if ($event instanceof GenericEvent) {
$eventSource->send('success', $l->t('[%d / %d]: Checking table %s', [$event[0], $event[1], $event->getSubject()]));
}
});
);
$feedBack = new FeedBackHandler($eventSource, $l);
$dispatcher->addListener('\OC\Repair::startProgress', [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener('\OC\Repair::advance', [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener('\OC\Repair::finishProgress', [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener('\OC\Repair::step', [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener('\OC\Repair::info', [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener('\OC\Repair::warning', [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener('\OC\Repair::error', [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener(RepairStartEvent::class, [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener(RepairAdvanceEvent::class, [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener(RepairFinishEvent::class, [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener(RepairStepEvent::class, [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener(RepairInfoEvent::class, [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener(RepairWarningEvent::class, [$feedBack, 'handleRepairFeedback']);
$dispatcher->addListener(RepairErrorEvent::class, [$feedBack, 'handleRepairFeedback']);
$updater->listen('\OC\Updater', 'maintenanceEnabled', function () use ($eventSource, $l) {
$eventSource->send('success', $l->t('Turned on maintenance mode'));

4
core/register_command.php
View File

@ -168,9 +168,9 @@ if (\OC::$server->getConfig()->getSystemValue('installed', false)) {
$application->add(new OC\Core\Command\Upgrade(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class), \OC::$server->query(\OC\Installer::class)));
$application->add(new OC\Core\Command\Maintenance\Repair(
new \OC\Repair([], \OC::$server->getEventDispatcher(), \OC::$server->get(LoggerInterface::class)),
new \OC\Repair([], \OC::$server->get(\OCP\EventDispatcher\IEventDispatcher::class), \OC::$server->get(LoggerInterface::class)),
\OC::$server->getConfig(),
\OC::$server->getEventDispatcher(),
\OC::$server->get(\OCP\EventDispatcher\IEventDispatcher::class),
\OC::$server->getAppManager()
));

8
lib/composer/composer/autoload_classmap.php
View File

@ -1063,6 +1063,7 @@ return array(
'OC\\DB\\MigrationException' => $baseDir . '/lib/private/DB/MigrationException.php',
'OC\\DB\\MigrationService' => $baseDir . '/lib/private/DB/MigrationService.php',
'OC\\DB\\Migrator' => $baseDir . '/lib/private/DB/Migrator.php',
'OC\\DB\\MigratorExecuteSqlEvent' => $baseDir . '/lib/private/DB/MigratorExecuteSqlEvent.php',
'OC\\DB\\MissingColumnInformation' => $baseDir . '/lib/private/DB/MissingColumnInformation.php',
'OC\\DB\\MissingIndexInformation' => $baseDir . '/lib/private/DB/MissingIndexInformation.php',
'OC\\DB\\MissingPrimaryKeyInformation' => $baseDir . '/lib/private/DB/MissingPrimaryKeyInformation.php',
@ -1417,6 +1418,13 @@ return array(
'OC\\Repair\\ClearFrontendCaches' => $baseDir . '/lib/private/Repair/ClearFrontendCaches.php',
'OC\\Repair\\ClearGeneratedAvatarCache' => $baseDir . '/lib/private/Repair/ClearGeneratedAvatarCache.php',
'OC\\Repair\\Collation' => $baseDir . '/lib/private/Repair/Collation.php',
'OC\\Repair\\Events\\RepairAdvanceEvent' => $baseDir . '/lib/private/Repair/Events/RepairAdvanceEvent.php',
'OC\\Repair\\Events\\RepairErrorEvent' => $baseDir . '/lib/private/Repair/Events/RepairErrorEvent.php',
'OC\\Repair\\Events\\RepairFinishEvent' => $baseDir . '/lib/private/Repair/Events/RepairFinishEvent.php',
'OC\\Repair\\Events\\RepairInfoEvent' => $baseDir . '/lib/private/Repair/Events/RepairInfoEvent.php',
'OC\\Repair\\Events\\RepairStartEvent' => $baseDir . '/lib/private/Repair/Events/RepairStartEvent.php',
'OC\\Repair\\Events\\RepairStepEvent' => $baseDir . '/lib/private/Repair/Events/RepairStepEvent.php',
'OC\\Repair\\Events\\RepairWarningEvent' => $baseDir . '/lib/private/Repair/Events/RepairWarningEvent.php',
'OC\\Repair\\MoveUpdaterStepFile' => $baseDir . '/lib/private/Repair/MoveUpdaterStepFile.php',
'OC\\Repair\\NC11\\FixMountStorages' => $baseDir . '/lib/private/Repair/NC11/FixMountStorages.php',
'OC\\Repair\\NC13\\AddLogRotateJob' => $baseDir . '/lib/private/Repair/NC13/AddLogRotateJob.php',

8
lib/composer/composer/autoload_static.php
View File

@ -1096,6 +1096,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OC\\DB\\MigrationException' => __DIR__ . '/../../..' . '/lib/private/DB/MigrationException.php',
'OC\\DB\\MigrationService' => __DIR__ . '/../../..' . '/lib/private/DB/MigrationService.php',
'OC\\DB\\Migrator' => __DIR__ . '/../../..' . '/lib/private/DB/Migrator.php',
'OC\\DB\\MigratorExecuteSqlEvent' => __DIR__ . '/../../..' . '/lib/private/DB/MigratorExecuteSqlEvent.php',
'OC\\DB\\MissingColumnInformation' => __DIR__ . '/../../..' . '/lib/private/DB/MissingColumnInformation.php',
'OC\\DB\\MissingIndexInformation' => __DIR__ . '/../../..' . '/lib/private/DB/MissingIndexInformation.php',
'OC\\DB\\MissingPrimaryKeyInformation' => __DIR__ . '/../../..' . '/lib/private/DB/MissingPrimaryKeyInformation.php',
@ -1450,6 +1451,13 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OC\\Repair\\ClearFrontendCaches' => __DIR__ . '/../../..' . '/lib/private/Repair/ClearFrontendCaches.php',
'OC\\Repair\\ClearGeneratedAvatarCache' => __DIR__ . '/../../..' . '/lib/private/Repair/ClearGeneratedAvatarCache.php',
'OC\\Repair\\Collation' => __DIR__ . '/../../..' . '/lib/private/Repair/Collation.php',
'OC\\Repair\\Events\\RepairAdvanceEvent' => __DIR__ . '/../../..' . '/lib/private/Repair/Events/RepairAdvanceEvent.php',
'OC\\Repair\\Events\\RepairErrorEvent' => __DIR__ . '/../../..' . '/lib/private/Repair/Events/RepairErrorEvent.php',
'OC\\Repair\\Events\\RepairFinishEvent' => __DIR__ . '/../../..' . '/lib/private/Repair/Events/RepairFinishEvent.php',
'OC\\Repair\\Events\\RepairInfoEvent' => __DIR__ . '/../../..' . '/lib/private/Repair/Events/RepairInfoEvent.php',
'OC\\Repair\\Events\\RepairStartEvent' => __DIR__ . '/../../..' . '/lib/private/Repair/Events/RepairStartEvent.php',
'OC\\Repair\\Events\\RepairStepEvent' => __DIR__ . '/../../..' . '/lib/private/Repair/Events/RepairStepEvent.php',
'OC\\Repair\\Events\\RepairWarningEvent' => __DIR__ . '/../../..' . '/lib/private/Repair/Events/RepairWarningEvent.php',
'OC\\Repair\\MoveUpdaterStepFile' => __DIR__ . '/../../..' . '/lib/private/Repair/MoveUpdaterStepFile.php',
'OC\\Repair\\NC11\\FixMountStorages' => __DIR__ . '/../../..' . '/lib/private/Repair/NC11/FixMountStorages.php',
'OC\\Repair\\NC13\\AddLogRotateJob' => __DIR__ . '/../../..' . '/lib/private/Repair/NC13/AddLogRotateJob.php',

2
lib/private/DB/Connection.php
View File

@ -588,7 +588,7 @@ class Connection extends \Doctrine\DBAL\Connection {
$random = \OC::$server->getSecureRandom();
$platform = $this->getDatabasePlatform();
$config = \OC::$server->getConfig();
$dispatcher = \OC::$server->getEventDispatcher();
$dispatcher = \OC::$server->get(\OCP\EventDispatcher\IEventDispatcher::class);
if ($platform instanceof SqlitePlatform) {
return new SQLiteMigrator($this, $config, $dispatcher);
} elseif ($platform instanceof OraclePlatform) {

37
lib/private/DB/Migrator.php
View File

@ -27,48 +27,41 @@
*/
namespace OC\DB;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Exception;
use Doctrine\DBAL\Platforms\MySQLPlatform;
use Doctrine\DBAL\Schema\AbstractAsset;
use Doctrine\DBAL\Schema\Comparator;
use Doctrine\DBAL\Schema\Schema;
use Doctrine\DBAL\Schema\SchemaDiff;
use Doctrine\DBAL\Types\StringType;
use Doctrine\DBAL\Types\Type;
use OCP\IConfig;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
use function preg_match;
use OCP\EventDispatcher\IEventDispatcher;
class Migrator {
/** @var \Doctrine\DBAL\Connection */
/** @var Connection */
protected $connection;
/** @var IConfig */
protected $config;
/** @var EventDispatcherInterface */
private $dispatcher;
private ?IEventDispatcher $dispatcher;
/** @var bool */
private $noEmit = false;
/**
* @param \Doctrine\DBAL\Connection $connection
* @param IConfig $config
* @param EventDispatcherInterface $dispatcher
*/
public function __construct(\Doctrine\DBAL\Connection $connection,
public function __construct(Connection $connection,
IConfig $config,
EventDispatcherInterface $dispatcher = null) {
?IEventDispatcher $dispatcher = null) {
$this->connection = $connection;
$this->config = $config;
$this->dispatcher = $dispatcher;
}
/**
* @param \Doctrine\DBAL\Schema\Schema $targetSchema
*
* @throws Exception
*/
public function migrate(Schema $targetSchema) {
@ -77,7 +70,6 @@ class Migrator {
}
/**
* @param \Doctrine\DBAL\Schema\Schema $targetSchema
* @return string
*/
public function generateChangeScript(Schema $targetSchema) {
@ -108,11 +100,9 @@ class Migrator {
}
/**
* @param Schema $targetSchema
* @param \Doctrine\DBAL\Connection $connection
* @return \Doctrine\DBAL\Schema\SchemaDiff
* @return SchemaDiff
*/
protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
protected function getDiff(Schema $targetSchema, Connection $connection) {
// adjust varchar columns with a length higher then getVarcharMaxLength to clob
foreach ($targetSchema->getTables() as $table) {
foreach ($table->getColumns() as $column) {
@ -153,12 +143,9 @@ class Migrator {
}
/**
* @param \Doctrine\DBAL\Schema\Schema $targetSchema
* @param \Doctrine\DBAL\Connection $connection
*
* @throws Exception
*/
protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
protected function applySchema(Schema $targetSchema, Connection $connection = null) {
if (is_null($connection)) {
$connection = $this->connection;
}
@ -194,13 +181,13 @@ class Migrator {
return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
}
protected function emit($sql, $step, $max) {
protected function emit(string $sql, int $step, int $max): void {
if ($this->noEmit) {
return;
}
if (is_null($this->dispatcher)) {
return;
}
$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step + 1, $max]));
$this->dispatcher->dispatchTyped(new MigratorExecuteSqlEvent($sql, $step, $max));
}
}

55
lib/private/DB/MigratorExecuteSqlEvent.php Normal file
View File

@ -0,0 +1,55 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.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/>
*
*/
namespace OC\DB;
use OCP\EventDispatcher\Event;
class MigratorExecuteSqlEvent extends Event {
private string $sql;
private int $current;
private int $max;
public function __construct(
string $sql,
int $current,
int $max
) {
$this->sql = $sql;
$this->current = $current;
$this->max = $max;
}
public function getSql(): string {
return $this->sql;
}
public function getCurrentStep(): int {
return $this->current;
}
public function getMaxStep(): int {
return $this->max;
}
}

12
lib/private/Migration/BackgroundRepair.php
View File

@ -26,14 +26,14 @@
*/
namespace OC\Migration;
use OC\NeedsUpdateException;
use OC\Repair;
use OC_App;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\IJobList;
use OCP\BackgroundJob\TimedJob;
use OCP\EventDispatcher\IEventDispatcher;
use OC\NeedsUpdateException;
use OC\Repair;
use OC_App;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
* Class BackgroundRepair
@ -43,9 +43,9 @@ use Symfony\Component\EventDispatcher\EventDispatcherInterface;
class BackgroundRepair extends TimedJob {
private IJobList $jobList;
private LoggerInterface $logger;
private EventDispatcherInterface $dispatcher;
private IEventDispatcher $dispatcher;
public function __construct(EventDispatcherInterface $dispatcher, ITimeFactory $time, LoggerInterface $logger, IJobList $jobList) {
public function __construct(IEventDispatcher $dispatcher, ITimeFactory $time, LoggerInterface $logger, IJobList $jobList) {
parent::__construct($time);
$this->dispatcher = $dispatcher;
$this->logger = $logger;

72
lib/private/Repair.php
View File

@ -34,6 +34,12 @@
*/
namespace OC;
use OCP\AppFramework\QueryException;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Collaboration\Resources\IManager;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;
use OC\App\AppStore\Bundles\BundleFetcher;
use OC\Avatar\AvatarManager;
use OC\DB\Connection;
@ -44,15 +50,15 @@ use OC\Repair\CleanTags;
use OC\Repair\ClearFrontendCaches;
use OC\Repair\ClearGeneratedAvatarCache;
use OC\Repair\Collation;
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\Repair\MoveUpdaterStepFile;
use OC\Repair\NC22\LookupServerSendCheck;
use OC\Repair\NC24\AddTokenCleanupJob;
use OC\Repair\Owncloud\CleanPreviews;
use OC\Repair\Owncloud\MigrateOauthTables;
use OC\Repair\NC11\FixMountStorages;
use OC\Repair\Owncloud\MoveAvatars;
use OC\Repair\Owncloud\InstallCoreBundle;
use OC\Repair\Owncloud\UpdateLanguageCodes;
use OC\Repair\NC13\AddLogRotateJob;
use OC\Repair\NC14\AddPreviewBackgroundCleanupJob;
use OC\Repair\NC16\AddClenupLoginFlowV2BackgroundJob;
@ -64,23 +70,23 @@ use OC\Repair\NC20\EncryptionMigration;
use OC\Repair\NC20\ShippedDashboardEnable;
use OC\Repair\NC21\AddCheckForUserCertificatesJob;
use OC\Repair\NC21\ValidatePhoneNumber;
use OC\Repair\NC22\LookupServerSendCheck;
use OC\Repair\NC24\AddTokenCleanupJob;
use OC\Repair\OldGroupMembershipShares;
use OC\Repair\Owncloud\CleanPreviews;
use OC\Repair\Owncloud\DropAccountTermsTable;
use OC\Repair\Owncloud\InstallCoreBundle;
use OC\Repair\Owncloud\MigrateOauthTables;
use OC\Repair\Owncloud\MoveAvatars;
use OC\Repair\Owncloud\SaveAccountsTableData;
use OC\Repair\Owncloud\UpdateLanguageCodes;
use OC\Repair\RemoveLinkShares;
use OC\Repair\RepairDavShares;
use OC\Repair\RepairInvalidShares;
use OC\Repair\RepairMimeTypes;
use OC\Repair\SqliteAutoincrement;
use OC\Template\JSCombiner;
use OCP\AppFramework\QueryException;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Collaboration\Resources\IManager;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
use Throwable;
class Repair implements IOutput {
@ -88,8 +94,7 @@ class Repair implements IOutput {
/** @var IRepairStep[] */
private $repairSteps;
/** @var EventDispatcherInterface */
private $dispatcher;
private IEventDispatcher $dispatcher;
/** @var string */
private $currentStep;
@ -101,7 +106,7 @@ class Repair implements IOutput {
*
* @param IRepairStep[] $repairSteps array of RepairStep instances
*/
public function __construct(array $repairSteps, EventDispatcherInterface $dispatcher, LoggerInterface $logger) {
public function __construct(array $repairSteps, IEventDispatcher $dispatcher, LoggerInterface $logger) {
$this->repairSteps = $repairSteps;
$this->dispatcher = $dispatcher;
$this->logger = $logger;
@ -112,19 +117,19 @@ class Repair implements IOutput {
*/
public function run() {
if (count($this->repairSteps) === 0) {
$this->emit('\OC\Repair', 'info', ['No repair steps available']);
$this->dispatcher->dispatchTyped(new RepairInfoEvent('No repair steps available'));
return;
}
// run each repair step
foreach ($this->repairSteps as $step) {
$this->currentStep = $step->getName();
$this->emit('\OC\Repair', 'step', [$this->currentStep]);
$this->dispatcher->dispatchTyped(new RepairStepEvent($this->currentStep));
try {
$step->run($this);
} catch (\Exception $e) {
$this->logger->error("Exception while executing repair step " . $step->getName(), ['exception' => $e]);
$this->emit('\OC\Repair', 'error', [$e->getMessage()]);
$this->dispatcher->dispatchTyped(new RepairErrorEvent($e->getMessage()));
}
}
}
@ -138,7 +143,7 @@ class Repair implements IOutput {
public function addStep($repairStep) {
if (is_string($repairStep)) {
try {
$s = \OC::$server->query($repairStep);
$s = \OC::$server->get($repairStep);
} catch (QueryException $e) {
if (class_exists($repairStep)) {
try {
@ -250,20 +255,11 @@ class Repair implements IOutput {
}
/**
* @param string $scope
* @param string $method
* @param array $arguments
* @param string $message
*/
public function emit($scope, $method, array $arguments = []) {
if (!is_null($this->dispatcher)) {
$this->dispatcher->dispatch("$scope::$method",
new GenericEvent("$scope::$method", $arguments));
}
}
public function info($string) {
public function info($message) {
// for now just emit as we did in the past
$this->emit('\OC\Repair', 'info', [$string]);
$this->dispatcher->dispatchTyped(new RepairInfoEvent($message));
}
/**
@ -271,7 +267,7 @@ class Repair implements IOutput {
*/
public function warning($message) {
// for now just emit as we did in the past
$this->emit('\OC\Repair', 'warning', [$message]);
$this->dispatcher->dispatchTyped(new RepairWarningEvent($message));
}
/**
@ -279,16 +275,16 @@ class Repair implements IOutput {
*/
public function startProgress($max = 0) {
// for now just emit as we did in the past
$this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
$this->dispatcher->dispatchTyped(new RepairStartEvent($max, $this->currentStep));
}
/**
* @param int $step
* @param int $step number of step to advance
* @param string $description
*/
public function advance($step = 1, $description = '') {
// for now just emit as we did in the past
$this->emit('\OC\Repair', 'advance', [$step, $description]);
$this->dispatcher->dispatchTyped(new RepairAdvanceEvent($step, $description));
}
/**
@ -296,6 +292,6 @@ class Repair implements IOutput {
*/
public function finishProgress() {
// for now just emit as we did in the past
$this->emit('\OC\Repair', 'finishProgress', []);
$this->dispatcher->dispatchTyped(new RepairFinishEvent());
}
}

48
lib/private/Repair/Events/RepairAdvanceEvent.php Normal file
View File

@ -0,0 +1,48 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.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/>
*
*/
namespace OC\Repair\Events;
use OCP\EventDispatcher\Event;
class RepairAdvanceEvent extends Event {
private int $increment;
private string $description;
public function __construct(
int $increment,
string $description
) {
$this->increment = $increment;
$this->description = $description;
}
public function getIncrement(): int {
return $this->increment;
}
public function getDescription(): string {
return $this->description;
}
}

41
lib/private/Repair/Events/RepairErrorEvent.php Normal file
View File

@ -0,0 +1,41 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.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/>
*
*/
namespace OC\Repair\Events;
use OCP\EventDispatcher\Event;
class RepairErrorEvent extends Event {
private string $message;
public function __construct(
string $message
) {
$this->message = $message;
}
public function getMessage(): string {
return $this->message;
}
}

30
lib/private/Repair/Events/RepairFinishEvent.php Normal file
View File

@ -0,0 +1,30 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.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/>
*
*/
namespace OC\Repair\Events;
use OCP\EventDispatcher\Event;
class RepairFinishEvent extends Event {
}

41
lib/private/Repair/Events/RepairInfoEvent.php Normal file
View File

@ -0,0 +1,41 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.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/>
*
*/
namespace OC\Repair\Events;
use OCP\EventDispatcher\Event;
class RepairInfoEvent extends Event {
private string $message;
public function __construct(
string $message
) {
$this->message = $message;
}
public function getMessage(): string {
return $this->message;
}
}

48
lib/private/Repair/Events/RepairStartEvent.php Normal file
View File

@ -0,0 +1,48 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.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/>
*
*/
namespace OC\Repair\Events;
use OCP\EventDispatcher\Event;
class RepairStartEvent extends Event {
private int $max;
private string $current;
public function __construct(
int $max,
string $current
) {
$this->max = $max;
$this->current = $current;
}
public function getMaxStep(): int {
return $this->max;
}
public function getCurrentStepName(): string {
return $this->current;
}
}

41
lib/private/Repair/Events/RepairStepEvent.php Normal file
View File

@ -0,0 +1,41 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.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/>
*
*/
namespace OC\Repair\Events;
use OCP\EventDispatcher\Event;
class RepairStepEvent extends Event {
private string $stepName;
public function __construct(
string $stepName
) {
$this->stepName = $stepName;
}
public function getStepName(): string {
return $this->stepName;
}
}

41
lib/private/Repair/Events/RepairWarningEvent.php Normal file
View File

@ -0,0 +1,41 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.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/>
*
*/
namespace OC\Repair\Events;
use OCP\EventDispatcher\Event;
class RepairWarningEvent extends Event {
private string $message;
public function __construct(
string $message
) {
$this->message = $message;
}
public function getMessage(): string {
return $this->message;
}
}

140
lib/private/Updater.php
View File

@ -40,19 +40,28 @@ declare(strict_types=1);
*/
namespace OC;
use OC\App\AppManager;
use OC\DB\Connection;
use OC\DB\MigrationService;
use OC\Hooks\BasicEmitter;
use OC\IntegrityCheck\Checker;
use OC_App;
use OCP\App\IAppManager;
use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\HintException;
use OCP\IConfig;
use OCP\ILogger;
use OCP\Util;
use OC\App\AppManager;
use OC\DB\Connection;
use OC\DB\MigrationService;
use OC\DB\MigratorExecuteSqlEvent;
use OC\Hooks\BasicEmitter;
use OC\IntegrityCheck\Checker;
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_App;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
/**
* Class that handles autoupdating of ownCloud
@ -102,7 +111,6 @@ class Updater extends BasicEmitter {
* @return bool true if the operation succeeded, false otherwise
*/
public function upgrade(): bool {
$this->emitRepairEvents();
$this->logAllEvents();
$logLevel = $this->config->getSystemValue('loglevel', ILogger::WARN);
@ -248,7 +256,7 @@ class Updater extends BasicEmitter {
file_put_contents($this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/.ocdata', '');
// pre-upgrade repairs
$repair = new Repair(Repair::getBeforeUpgradeRepairSteps(), \OC::$server->getEventDispatcher(), \OC::$server->get(LoggerInterface::class));
$repair = new Repair(Repair::getBeforeUpgradeRepairSteps(), \OC::$server->get(\OCP\EventDispatcher\IEventDispatcher::class), \OC::$server->get(LoggerInterface::class));
$repair->run();
$this->doCoreUpgrade();
@ -289,11 +297,11 @@ class Updater extends BasicEmitter {
}
// post-upgrade repairs
$repair = new Repair(Repair::getRepairSteps(), \OC::$server->getEventDispatcher(), \OC::$server->get(LoggerInterface::class));
$repair = new Repair(Repair::getRepairSteps(), \OC::$server->get(\OCP\EventDispatcher\IEventDispatcher::class), \OC::$server->get(LoggerInterface::class));
$repair->run();
//Invalidate update feed
$this->config->setAppValue('core', 'lastupdatedat', 0);
$this->config->setAppValue('core', 'lastupdatedat', '0');
// Check for code integrity if not disabled
if (\OC::$server->getIntegrityCodeChecker()->isCodeCheckEnforced()) {
@ -432,91 +440,47 @@ class Updater extends BasicEmitter {
}
}
/**
* Forward messages emitted by the repair routine
*/
private function emitRepairEvents(): void {
$dispatcher = \OC::$server->getEventDispatcher();
$dispatcher->addListener('\OC\Repair::warning', function ($event) {
if ($event instanceof GenericEvent) {
$this->emit('\OC\Updater', 'repairWarning', $event->getArguments());
}
});
$dispatcher->addListener('\OC\Repair::error', function ($event) {
if ($event instanceof GenericEvent) {
$this->emit('\OC\Updater', 'repairError', $event->getArguments());
}
});
$dispatcher->addListener('\OC\Repair::info', function ($event) {
if ($event instanceof GenericEvent) {
$this->emit('\OC\Updater', 'repairInfo', $event->getArguments());
}
});
$dispatcher->addListener('\OC\Repair::step', function ($event) {
if ($event instanceof GenericEvent) {
$this->emit('\OC\Updater', 'repairStep', $event->getArguments());
}
});
}
private function logAllEvents(): void {
$log = $this->log;
$dispatcher = \OC::$server->getEventDispatcher();
$dispatcher->addListener('\OC\DB\Migrator::executeSql', function ($event) use ($log) {
if (!$event instanceof GenericEvent) {
return;
/** @var IEventDispatcher $dispatcher */
$dispatcher = \OC::$server->get(IEventDispatcher::class);
$dispatcher->addListener(
MigratorExecuteSqlEvent::class,
function (MigratorExecuteSqlEvent $event) use ($log): void {
$log->info(get_class($event).': ' . $event->getSql() . ' (' . $event->getCurrentStep() . ' of ' . $event->getMaxStep() . ')', ['app' => 'updater']);
}
$log->info('\OC\DB\Migrator::executeSql: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
});
$dispatcher->addListener('\OC\DB\Migrator::checkTable', function ($event) use ($log) {
if (!$event instanceof GenericEvent) {
return;
}
$log->info('\OC\DB\Migrator::checkTable: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
});
);
$repairListener = function ($event) use ($log) {
if (!$event instanceof GenericEvent) {
return;
}
switch ($event->getSubject()) {
case '\OC\Repair::startProgress':
$log->info('\OC\Repair::startProgress: Starting ... ' . $event->getArgument(1) . ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
break;
case '\OC\Repair::advance':
$desc = $event->getArgument(1);
if (empty($desc)) {
$desc = '';
}
$log->info('\OC\Repair::advance: ' . $desc . ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
break;
case '\OC\Repair::finishProgress':
$log->info('\OC\Repair::finishProgress', ['app' => 'updater']);
break;
case '\OC\Repair::step':
$log->info('\OC\Repair::step: Repair step: ' . $event->getArgument(0), ['app' => 'updater']);
break;
case '\OC\Repair::info':
$log->info('\OC\Repair::info: Repair info: ' . $event->getArgument(0), ['app' => 'updater']);
break;
case '\OC\Repair::warning':
$log->warning('\OC\Repair::warning: Repair warning: ' . $event->getArgument(0), ['app' => 'updater']);
break;
case '\OC\Repair::error':
$log->error('\OC\Repair::error: Repair error: ' . $event->getArgument(0), ['app' => 'updater']);
break;
$repairListener = function (Event $event) use ($log): void {
if ($event instanceof RepairStartEvent) {
$log->info(get_class($event).': Starting ... ' . $event->getMaxStep() . ' (' . $event->getCurrentStepName() . ')', ['app' => 'updater']);
} elseif ($event instanceof RepairAdvanceEvent) {
$desc = $event->getDescription();
if (empty($desc)) {
$desc = '';
}
$log->info(get_class($event).': ' . $desc . ' (' . $event->getIncrement() . ')', ['app' => 'updater']);
} elseif ($event instanceof RepairFinishEvent) {
$log->info(get_class($event), ['app' => 'updater']);
} elseif ($event instanceof RepairStepEvent) {
$log->info(get_class($event).': Repair step: ' . $event->getStepName(), ['app' => 'updater']);
} elseif ($event instanceof RepairInfoEvent) {
$log->info(get_class($event).': Repair info: ' . $event->getMessage(), ['app' => 'updater']);
} elseif ($event instanceof RepairWarningEvent) {
$log->warning(get_class($event).': Repair warning: ' . $event->getMessage(), ['app' => 'updater']);
} elseif ($event instanceof RepairErrorEvent) {
$log->error(get_class($event).': Repair error: ' . $event->getMessage(), ['app' => 'updater']);
}
};
$dispatcher->addListener('\OC\Repair::startProgress', $repairListener);
$dispatcher->addListener('\OC\Repair::advance', $repairListener);
$dispatcher->addListener('\OC\Repair::finishProgress', $repairListener);
$dispatcher->addListener('\OC\Repair::step', $repairListener);
$dispatcher->addListener('\OC\Repair::info', $repairListener);
$dispatcher->addListener('\OC\Repair::warning', $repairListener);
$dispatcher->addListener('\OC\Repair::error', $repairListener);
$dispatcher->addListener(RepairStartEvent::class, $repairListener);
$dispatcher->addListener(RepairAdvanceEvent::class, $repairListener);
$dispatcher->addListener(RepairFinishEvent::class, $repairListener);
$dispatcher->addListener(RepairStepEvent::class, $repairListener);
$dispatcher->addListener(RepairInfoEvent::class, $repairListener);
$dispatcher->addListener(RepairWarningEvent::class, $repairListener);
$dispatcher->addListener(RepairErrorEvent::class, $repairListener);
$this->listen('\OC\Updater', 'maintenanceEnabled', function () use ($log) {

21
lib/private/legacy/OC_App.php
View File

@ -50,18 +50,19 @@ declare(strict_types=1);
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
use OC\App\DependencyAnalyzer;
use OC\App\Platform;
use OC\AppFramework\Bootstrap\Coordinator;
use OC\DB\MigrationService;
use OC\Installer;
use OC\Repair;
use OC\ServerNotAvailableException;
use OCP\App\ManagerEvent;
use OCP\AppFramework\QueryException;
use OCP\App\ManagerEvent;
use OCP\Authentication\IAlternativeLogin;
use OCP\ILogger;
use OCP\Settings\IManager as ISettingsManager;
use OC\AppFramework\Bootstrap\Coordinator;
use OC\App\DependencyAnalyzer;
use OC\App\Platform;
use OC\DB\MigrationService;
use OC\Installer;
use OC\Repair;
use OC\Repair\Events\RepairErrorEvent;
use OC\ServerNotAvailableException;
use Psr\Log\LoggerInterface;
/**
@ -1047,7 +1048,7 @@ class OC_App {
// load the app
self::loadApp($appId);
$dispatcher = OC::$server->getEventDispatcher();
$dispatcher = \OC::$server->get(\OCP\EventDispatcher\IEventDispatcher::class);
// load the steps
$r = new Repair([], $dispatcher, \OC::$server->get(LoggerInterface::class));
@ -1055,7 +1056,7 @@ class OC_App {
try {
$r->addStep($step);
} catch (Exception $ex) {
$r->emit('\OC\Repair', 'error', [$ex->getMessage()]);
$dispatcher->dispatchTyped(new RepairErrorEvent($ex->getMessage()));
\OC::$server->getLogger()->logException($ex);
}
}

2
lib/public/IEventSource.php
View File

@ -35,7 +35,7 @@ interface IEventSource {
/**
* send a message to the client
*
* @param string $type
* @param string $type One of success, notice, error, failure and done. Used in core/js/update.js
* @param mixed $data
*
* if only one parameter is given, a typeless message will be send with that parameter as data

6
lib/public/Migration/IOutput.php
View File

@ -32,18 +32,21 @@ interface IOutput {
/**
* @param string $message
* @return void
* @since 9.1.0
*/
public function info($message);
/**
* @param string $message
* @return void
* @since 9.1.0
*/
public function warning($message);
/**
* @param int $max
* @return void
* @since 9.1.0
*/
public function startProgress($max = 0);
@ -51,12 +54,13 @@ interface IOutput {
/**
* @param int $step
* @param string $description
* @return void
* @since 9.1.0
*/
public function advance($step = 1, $description = '');
/**
* @param int $max
* @return void
* @since 9.1.0
*/
public function finishProgress();

2
tests/lib/DB/MigratorTest.php
View File

@ -62,7 +62,7 @@ class MigratorTest extends \Test\TestCase {
private function getMigrator(): Migrator {
$platform = $this->connection->getDatabasePlatform();
$random = \OC::$server->getSecureRandom();
$dispatcher = \OC::$server->getEventDispatcher();
$dispatcher = \OC::$server->get(\OCP\EventDispatcher\IEventDispatcher::class);
if ($platform instanceof SqlitePlatform) {
return new SQLiteMigrator($this->connection, $this->config, $dispatcher);
} elseif ($platform instanceof OraclePlatform) {

30
tests/lib/Migration/BackgroundRepairTest.php
View File

@ -21,15 +21,17 @@
namespace Test\Migration;
use OC\Migration\BackgroundRepair;
use OC\NeedsUpdateException;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
use Test\TestCase;
use OC\BackgroundJob\JobList;
use OC\Migration\BackgroundRepair;
use OC\NeedsUpdateException;
use OC\Repair\Events\RepairStepEvent;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
use Test\TestCase;
class TestRepairStep implements IRepairStep {
@ -57,16 +59,16 @@ class TestRepairStep implements IRepairStep {
class BackgroundRepairTest extends TestCase {
/** @var \OC\BackgroundJob\JobList|\PHPUnit\Framework\MockObject\MockObject */
/** @var JobList|MockObject */
private $jobList;
/** @var BackgroundRepair|\PHPUnit\Framework\MockObject\MockObject */
/** @var BackgroundRepair|MockObject */
private $job;
/** @var LoggerInterface|\PHPUnit\Framework\MockObject\MockObject */
/** @var LoggerInterface|MockObject */
private $logger;
/** @var EventDispatcherInterface|\PHPUnit\Framework\MockObject\MockObject $dispatcher */
/** @var IEventDispatcher|MockObject $dispatcher */
private $dispatcher;
/** @var ITimeFactory|\PHPUnit\Framework\MockObject\MockObject $dispatcher */
@ -75,13 +77,13 @@ class BackgroundRepairTest extends TestCase {
protected function setUp(): void {
parent::setUp();
$this->jobList = $this->getMockBuilder('OC\BackgroundJob\JobList')
$this->jobList = $this->getMockBuilder(JobList::class)
->disableOriginalConstructor()
->getMock();
$this->logger = $this->getMockBuilder(LoggerInterface::class)
->disableOriginalConstructor()
->getMock();
$this->dispatcher = $this->createMock(EventDispatcherInterface::class);
$this->dispatcher = $this->createMock(IEventDispatcher::class);
$this->time = $this->createMock(ITimeFactory::class);
$this->time->method('getTime')
->willReturn(999999);
@ -107,7 +109,7 @@ class BackgroundRepairTest extends TestCase {
}
public function testUnknownStep() {
$this->dispatcher->expects($this->never())->method('dispatch');
$this->dispatcher->expects($this->never())->method('dispatchTyped');
$this->jobList->expects($this->once())->method('remove');
$this->logger->expects($this->once())->method('error');
@ -120,8 +122,8 @@ class BackgroundRepairTest extends TestCase {
}
public function testWorkingStep() {
$this->dispatcher->expects($this->once())->method('dispatch')
->with('\OC\Repair::step', new GenericEvent('\OC\Repair::step', ['A test repair step']));
$this->dispatcher->expects($this->once())->method('dispatchTyped')
->with($this->equalTo(new RepairStepEvent('A test repair step')));
$this->jobList->expects($this->once())->method('remove');

45
tests/lib/RepairStepTest.php → tests/lib/RepairTest.php
View File

@ -8,14 +8,19 @@
namespace Test;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Migration\IRepairStep;
use OC\Repair;
use OC\Repair\Events\RepairInfoEvent;
use OC\Repair\Events\RepairStepEvent;
use OC\Repair\Events\RepairWarningEvent;
use OC\Repair\Events\RepairErrorEvent;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcher;
class RepairStepTest implements IRepairStep {
private $warning;
class TestRepairStep implements IRepairStep {
private bool $warning;
public function __construct($warning = false) {
public function __construct(bool $warning = false) {
$this->warning = $warning;
}
@ -33,28 +38,27 @@ class RepairStepTest implements IRepairStep {
}
class RepairTest extends TestCase {
/** @var \OC\Repair */
private $repair;
private Repair $repair;
/** @var string[] */
private $outputArray;
private array $outputArray = [];
protected function setUp(): void {
parent::setUp();
$dispatcher = new EventDispatcher();
$dispatcher = \OC::$server->get(IEventDispatcher::class);
$this->repair = new \OC\Repair([], $dispatcher, $this->createMock(LoggerInterface::class));
$dispatcher->addListener('\OC\Repair::warning', function ($event) {
/** @var \Symfony\Component\EventDispatcher\GenericEvent $event */
$this->outputArray[] = 'warning: ' . $event->getArgument(0);
$dispatcher->addListener(RepairWarningEvent::class, function (RepairWarningEvent $event) {
$this->outputArray[] = 'warning: ' . $event->getMessage();
});
$dispatcher->addListener('\OC\Repair::info', function ($event) {
/** @var \Symfony\Component\EventDispatcher\GenericEvent $event */
$this->outputArray[] = 'info: ' . $event->getArgument(0);
$dispatcher->addListener(RepairInfoEvent::class, function (RepairInfoEvent $event) {
$this->outputArray[] = 'info: ' . $event->getMessage();
});
$dispatcher->addListener('\OC\Repair::step', function ($event) {
/** @var \Symfony\Component\EventDispatcher\GenericEvent $event */
$this->outputArray[] = 'step: ' . $event->getArgument(0);
$dispatcher->addListener(RepairStepEvent::class, function (RepairStepEvent $event) {
$this->outputArray[] = 'step: ' . $event->getStepName();
});
$dispatcher->addListener(RepairErrorEvent::class, function (RepairErrorEvent $event) {
$this->outputArray[] = 'error: ' . $event->getMessage();
});
}
@ -88,7 +92,7 @@ class RepairTest extends TestCase {
$mock = $this->createMock(TestRepairStep::class);
$mock->expects($this->any())
->method('run')
->will($this->throwException(new \Exception()));
->will($this->throwException(new \Exception('Exception text')));
$mock->expects($this->any())
->method('getName')
->willReturn('Exception Test');
@ -103,11 +107,14 @@ class RepairTest extends TestCase {
$thrown = true;
}
$this->assertTrue($thrown);
$this->assertFalse($thrown);
// jump out after exception
$this->assertEquals(
[
'step: Exception Test',
'error: Exception text',
'step: Test Name',
'info: Simulated info',
],
$this->outputArray
);