upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-06-14 19:20:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Merge pull request #39487 from nextcloud/feat/noid/typed-events-for-db_add-missing

Browse source 
Feat/noid/typed events for db add missing
This commit is contained in:
Joas Schilling 2023-07-25 13:37:51 +02:00 committed by GitHub
commit f824d87fc1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 474 additions and 868 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
apps/settings/lib/Controller/CheckSetupController.php
View file

@ -74,7 +74,9 @@ use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI;
use OCP\AppFramework\Http\DataDisplayResponse;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\RedirectResponse;
use OCP\DB\Events\AddMissingColumnsEvent;
use OCP\DB\Events\AddMissingIndicesEvent;
use OCP\DB\Events\AddMissingPrimaryKeyEvent;
use OCP\DB\Types;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Http\Client\IClientService;
@ -90,8 +92,6 @@ use OCP\Lock\ILockingProvider;
use OCP\Notification\IManager;
use OCP\Security\ISecureRandom;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
#[IgnoreOpenAPI]
class CheckSetupController extends Controller {
@ -108,8 +108,6 @@ class CheckSetupController extends Controller {
/** @var LoggerInterface */
private $logger;
/** @var IEventDispatcher */
private $eventDispatcher;
/** @var EventDispatcherInterface */
private $dispatcher;
/** @var Connection */
private $db;
@ -142,8 +140,7 @@ class CheckSetupController extends Controller {
IL10N $l10n,
Checker $checker,
LoggerInterface $logger,
IEventDispatcher $eventDispatcher,
EventDispatcherInterface $dispatcher,
IEventDispatcher $dispatcher,
Connection $db,
ILockingProvider $lockingProvider,
IDateTimeFormatter $dateTimeFormatter,
@ -163,7 +160,6 @@ class CheckSetupController extends Controller {
$this->l10n = $l10n;
$this->checker = $checker;
$this->logger = $logger;
$this->eventDispatcher = $eventDispatcher;
$this->dispatcher = $dispatcher;
$this->db = $db;
$this->lockingProvider = $lockingProvider;
@ -551,11 +547,8 @@ Raw output
$indexInfo = new MissingIndexInformation();
// Dispatch event so apps can also hint for pending index updates if needed
$event = new GenericEvent($indexInfo);
$this->dispatcher->dispatch(IDBConnection::CHECK_MISSING_INDEXES_EVENT, $event);
$event = new AddMissingIndicesEvent();
$this->eventDispatcher->dispatchTyped($event);
$this->dispatcher->dispatchTyped($event);
$missingIndices = $event->getMissingIndices();
if ($missingIndices !== []) {
@ -575,20 +568,46 @@ Raw output
protected function hasMissingPrimaryKeys(): array {
$info = new MissingPrimaryKeyInformation();
// Dispatch event so apps can also hint for pending index updates if needed
$event = new GenericEvent($info);
$this->dispatcher->dispatch(IDBConnection::CHECK_MISSING_PRIMARY_KEYS_EVENT, $event);
// Dispatch event so apps can also hint for pending key updates if needed
$event = new AddMissingPrimaryKeyEvent();
$this->dispatcher->dispatchTyped($event);
$missingKeys = $event->getMissingPrimaryKeys();
if (!empty($missingKeys)) {
$schema = new SchemaWrapper(\OCP\Server::get(Connection::class));
foreach ($missingKeys as $missingKey) {
if ($schema->hasTable($missingKey['tableName'])) {
$table = $schema->getTable($missingKey['tableName']);
if (!$table->hasPrimaryKey()) {
$info->addHintForMissingSubject($missingKey['tableName']);
}
}
}
}
return $info->getListOfMissingPrimaryKeys();
}
protected function hasMissingColumns(): array {
$indexInfo = new MissingColumnInformation();
// Dispatch event so apps can also hint for pending index updates if needed
$event = new GenericEvent($indexInfo);
$this->dispatcher->dispatch(IDBConnection::CHECK_MISSING_COLUMNS_EVENT, $event);
$columnInfo = new MissingColumnInformation();
// Dispatch event so apps can also hint for pending column updates if needed
$event = new AddMissingColumnsEvent();
$this->dispatcher->dispatchTyped($event);
$missingColumns = $event->getMissingColumns();
return $indexInfo->getListOfMissingColumns();
if (!empty($missingColumns)) {
$schema = new SchemaWrapper(\OCP\Server::get(Connection::class));
foreach ($missingColumns as $missingColumn) {
if ($schema->hasTable($missingColumn['tableName'])) {
$table = $schema->getTable($missingColumn['tableName']);
if (!$table->hasColumn($missingColumn['columnName'])) {
$columnInfo->addHintForMissingColumn($missingColumn['tableName'], $missingColumn['columnName']);
}
}
}
}
return $columnInfo->getListOfMissingColumns();
}
protected function isSqliteUsed() {

11
apps/settings/tests/Controller/CheckSetupControllerTest.php
View file

@ -62,7 +62,6 @@ use OCP\Notification\IManager;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Test\TestCase;
/**
@ -89,8 +88,6 @@ class CheckSetupControllerTest extends TestCase {
/** @var Checker|\PHPUnit\Framework\MockObject\MockObject */
private $checker;
/** @var IEventDispatcher|\PHPUnit\Framework\MockObject\MockObject */
private $eventDispatcher;
/** @var EventDispatcherInterface|\PHPUnit\Framework\MockObject\MockObject */
private $dispatcher;
/** @var Connection|\PHPUnit\Framework\MockObject\MockObject */
private $db;
@ -140,9 +137,7 @@ class CheckSetupControllerTest extends TestCase {
->willReturnCallback(function ($message, array $replace) {
return vsprintf($message, $replace);
});
$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
$this->dispatcher = $this->getMockBuilder(EventDispatcherInterface::class)
->disableOriginalConstructor()->getMock();
$this->dispatcher = $this->createMock(IEventDispatcher::class);
$this->checker = $this->getMockBuilder('\OC\IntegrityCheck\Checker')
->disableOriginalConstructor()->getMock();
$this->logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
@ -171,7 +166,6 @@ class CheckSetupControllerTest extends TestCase {
$this->l10n,
$this->checker,
$this->logger,
$this->eventDispatcher,
$this->dispatcher,
$this->db,
$this->lockingProvider,
@ -681,7 +675,6 @@ class CheckSetupControllerTest extends TestCase {
$this->l10n,
$this->checker,
$this->logger,
$this->eventDispatcher,
$this->dispatcher,
$this->db,
$this->lockingProvider,
@ -1409,7 +1402,6 @@ Array
$this->l10n,
$this->checker,
$this->logger,
$this->eventDispatcher,
$this->dispatcher,
$this->db,
$this->lockingProvider,
@ -1464,7 +1456,6 @@ Array
$this->l10n,
$this->checker,
$this->logger,
$this->eventDispatcher,
$this->dispatcher,
$this->db,
$this->lockingProvider,

437
core/Application.php
View file

@ -32,7 +32,6 @@
*/
namespace OC\Core;
use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
use OC\Authentication\Events\RemoteWipeFinished;
use OC\Authentication\Events\RemoteWipeStarted;
use OC\Authentication\Listeners\RemoteWipeActivityListener;
@ -45,25 +44,22 @@ use OC\Authentication\Listeners\UserDeletedWebAuthnCleanupListener;
use OC\Authentication\Notifications\Notifier as AuthenticationNotifier;
use OC\Core\Listener\BeforeTemplateRenderedListener;
use OC\Core\Notification\CoreNotifier;
use OC\DB\Connection;
use OC\DB\MissingColumnInformation;
use OC\DB\MissingIndexInformation;
use OC\DB\MissingPrimaryKeyInformation;
use OC\DB\SchemaWrapper;
use OC\Metadata\FileEventListener;
use OC\TagManager;
use OCP\AppFramework\App;
use OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent;
use OCP\DB\Events\AddMissingColumnsEvent;
use OCP\DB\Events\AddMissingIndicesEvent;
use OCP\DB\Events\AddMissingPrimaryKeyEvent;
use OCP\DB\Types;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Files\Events\Node\NodeDeletedEvent;
use OCP\Files\Events\Node\NodeWrittenEvent;
use OCP\Files\Events\NodeRemovedFromCache;
use OCP\IDBConnection;
use OCP\User\Events\BeforeUserDeletedEvent;
use OCP\User\Events\UserDeletedEvent;
use OCP\Util;
use OCP\IConfig;
use Symfony\Component\EventDispatcher\GenericEvent;
/**
* Class Application
@ -88,244 +84,237 @@ class Application extends App {
$notificationManager->registerNotifierService(CoreNotifier::class);
$notificationManager->registerNotifierService(AuthenticationNotifier::class);
$oldEventDispatcher = $server->getEventDispatcher();
$eventDispatcher->addListener(AddMissingIndicesEvent::class, function (AddMissingIndicesEvent $event) {
$event->addMissingIndex(
'share',
'share_with_index',
['share_with']
);
$event->addMissingIndex(
'share',
'parent_index',
['parent']
);
$event->addMissingIndex(
'share',
'owner_index',
['uid_owner']
);
$event->addMissingIndex(
'share',
'initiator_index',
['uid_initiator']
);
$oldEventDispatcher->addListener(IDBConnection::CHECK_MISSING_INDEXES_EVENT,
function (GenericEvent $event) use ($container) {
/** @var MissingIndexInformation $subject */
$subject = $event->getSubject();
$event->addMissingIndex(
'filecache',
'fs_mtime',
['mtime']
);
$event->addMissingIndex(
'filecache',
'fs_size',
['size']
);
$event->addMissingIndex(
'filecache',
'fs_id_storage_size',
['fileid', 'storage', 'size']
);
$event->addMissingIndex(
'filecache',
'fs_storage_path_prefix',
['storage', 'path'],
['lengths' => [null, 64]]
);
$event->addMissingIndex(
'filecache',
'fs_parent',
['parent']
);
$schema = new SchemaWrapper($container->query(Connection::class));
$event->addMissingIndex(
'twofactor_providers',
'twofactor_providers_uid',
['uid']
);
if ($schema->hasTable('share')) {
$table = $schema->getTable('share');
$event->addMissingUniqueIndex(
'login_flow_v2',
'poll_token',
['poll_token'],
[],
true
);
$event->addMissingUniqueIndex(
'login_flow_v2',
'login_token',
['login_token'],
[],
true
);
$event->addMissingIndex(
'login_flow_v2',
'timestamp',
['timestamp'],
[],
true
);
if (!$table->hasIndex('share_with_index')) {
$subject->addHintForMissingSubject($table->getName(), 'share_with_index');
}
if (!$table->hasIndex('parent_index')) {
$subject->addHintForMissingSubject($table->getName(), 'parent_index');
}
if (!$table->hasIndex('owner_index')) {
$subject->addHintForMissingSubject($table->getName(), 'owner_index');
}
if (!$table->hasIndex('initiator_index')) {
$subject->addHintForMissingSubject($table->getName(), 'initiator_index');
}
}
$event->addMissingIndex(
'whats_new',
'version',
['version'],
[],
true
);
if ($schema->hasTable('filecache')) {
$table = $schema->getTable('filecache');
$event->addMissingIndex(
'cards',
'cards_abiduri',
['addressbookid', 'uri'],
[],
true
);
$event->addMissingIndex(
'cards',
'cards_abid',
['addressbookid'],
[],
true
);
$event->addMissingIndex(
'cards',
'cards_abiduri',
['addressbookid', 'uri'],
[],
true
);
if (!$table->hasIndex('fs_mtime')) {
$subject->addHintForMissingSubject($table->getName(), 'fs_mtime');
}
$event->addMissingIndex(
'cards_properties',
'cards_prop_abid',
['addressbookid'],
[],
true
);
if (!$table->hasIndex('fs_size')) {
$subject->addHintForMissingSubject($table->getName(), 'fs_size');
}
$event->addMissingIndex(
'calendarobjects_props',
'calendarobject_calid_index',
['calendarid', 'calendartype']
);
if (!$table->hasIndex('fs_id_storage_size')) {
$subject->addHintForMissingSubject($table->getName(), 'fs_id_storage_size');
}
$event->addMissingIndex(
'schedulingobjects',
'schedulobj_principuri_index',
['principaluri']
);
if (!$table->hasIndex('fs_storage_path_prefix') && !$schema->getDatabasePlatform() instanceof PostgreSQL94Platform) {
$subject->addHintForMissingSubject($table->getName(), 'fs_storage_path_prefix');
}
$event->addMissingIndex(
'properties',
'properties_path_index',
['userid', 'propertypath']
);
$event->addMissingIndex(
'properties',
'properties_pathonly_index',
['propertypath']
);
if (!$table->hasIndex('fs_parent')) {
$subject->addHintForMissingSubject($table->getName(), 'fs_parent');
}
}
if ($schema->hasTable('twofactor_providers')) {
$table = $schema->getTable('twofactor_providers');
$event->addMissingIndex(
'jobs',
'job_lastcheck_reserved',
['last_checked', 'reserved_at']
);
if (!$table->hasIndex('twofactor_providers_uid')) {
$subject->addHintForMissingSubject($table->getName(), 'twofactor_providers_uid');
}
}
$event->addMissingIndex(
'direct_edit',
'direct_edit_timestamp',
['timestamp']
);
if ($schema->hasTable('login_flow_v2')) {
$table = $schema->getTable('login_flow_v2');
$event->addMissingIndex(
'preferences',
'preferences_app_key',
['appid', 'configkey']
);
if (!$table->hasIndex('poll_token')) {
$subject->addHintForMissingSubject($table->getName(), 'poll_token');
}
if (!$table->hasIndex('login_token')) {
$subject->addHintForMissingSubject($table->getName(), 'login_token');
}
if (!$table->hasIndex('timestamp')) {
$subject->addHintForMissingSubject($table->getName(), 'timestamp');
}
}
$event->addMissingIndex(
'mounts',
'mounts_class_index',
['mount_provider_class']
);
$event->addMissingIndex(
'mounts',
'mounts_user_root_path_index',
['user_id', 'root_id', 'mount_point'],
['lengths' => [null, null, 128]]
);
if ($schema->hasTable('whats_new')) {
$table = $schema->getTable('whats_new');
$event->addMissingIndex(
'systemtag_object_mapping',
'systag_by_tagid',
['systemtagid', 'objecttype']
);
});
if (!$table->hasIndex('version')) {
$subject->addHintForMissingSubject($table->getName(), 'version');
}
}
$eventDispatcher->addListener(AddMissingPrimaryKeyEvent::class, function (AddMissingPrimaryKeyEvent $event) {
$event->addMissingPrimaryKey(
'federated_reshares',
'federated_res_pk',
['share_id'],
'share_id_index'
);
if ($schema->hasTable('cards')) {
$table = $schema->getTable('cards');
$event->addMissingPrimaryKey(
'systemtag_object_mapping',
'som_pk',
['objecttype', 'objectid', 'systemtagid'],
'mapping'
);
if (!$table->hasIndex('cards_abid')) {
$subject->addHintForMissingSubject($table->getName(), 'cards_abid');
}
$event->addMissingPrimaryKey(
'comments_read_markers',
'crm_pk',
['user_id', 'object_type', 'object_id'],
'comments_marker_index'
);
if (!$table->hasIndex('cards_abiduri')) {
$subject->addHintForMissingSubject($table->getName(), 'cards_abiduri');
}
}
$event->addMissingPrimaryKey(
'collres_resources',
'crr_pk',
['collection_id', 'resource_type', 'resource_id'],
'collres_unique_res'
);
if ($schema->hasTable('cards_properties')) {
$table = $schema->getTable('cards_properties');
$event->addMissingPrimaryKey(
'collres_accesscache',
'cra_pk',
['user_id', 'collection_id', 'resource_type', 'resource_id'],
'collres_unique_user'
);
if (!$table->hasIndex('cards_prop_abid')) {
$subject->addHintForMissingSubject($table->getName(), 'cards_prop_abid');
}
}
$event->addMissingPrimaryKey(
'filecache_extended',
'fce_pk',
['fileid'],
'fce_fileid_idx'
);
});
if ($schema->hasTable('calendarobjects_props')) {
$table = $schema->getTable('calendarobjects_props');
if (!$table->hasIndex('calendarobject_calid_index')) {
$subject->addHintForMissingSubject($table->getName(), 'calendarobject_calid_index');
}
}
if ($schema->hasTable('schedulingobjects')) {
$table = $schema->getTable('schedulingobjects');
if (!$table->hasIndex('schedulobj_principuri_index')) {
$subject->addHintForMissingSubject($table->getName(), 'schedulobj_principuri_index');
}
}
if ($schema->hasTable('properties')) {
$table = $schema->getTable('properties');
if (!$table->hasIndex('properties_path_index')) {
$subject->addHintForMissingSubject($table->getName(), 'properties_path_index');
}
if (!$table->hasIndex('properties_pathonly_index')) {
$subject->addHintForMissingSubject($table->getName(), 'properties_pathonly_index');
}
}
if ($schema->hasTable('jobs')) {
$table = $schema->getTable('jobs');
if (!$table->hasIndex('job_lastcheck_reserved')) {
$subject->addHintForMissingSubject($table->getName(), 'job_lastcheck_reserved');
}
}
if ($schema->hasTable('direct_edit')) {
$table = $schema->getTable('direct_edit');
if (!$table->hasIndex('direct_edit_timestamp')) {
$subject->addHintForMissingSubject($table->getName(), 'direct_edit_timestamp');
}
}
if ($schema->hasTable('preferences')) {
$table = $schema->getTable('preferences');
if (!$table->hasIndex('preferences_app_key')) {
$subject->addHintForMissingSubject($table->getName(), 'preferences_app_key');
}
}
if ($schema->hasTable('mounts')) {
$table = $schema->getTable('mounts');
if (!$table->hasIndex('mounts_class_index')) {
$subject->addHintForMissingSubject($table->getName(), 'mounts_class_index');
}
if (!$table->hasIndex('mounts_user_root_path_index')) {
$subject->addHintForMissingSubject($table->getName(), 'mounts_user_root_path_index');
}
}
if ($schema->hasTable('systemtag_object_mapping')) {
$table = $schema->getTable('systemtag_object_mapping');
if (!$table->hasIndex('systag_by_tagid')) {
$subject->addHintForMissingSubject($table->getName(), 'systag_by_tagid');
}
}
}
);
$oldEventDispatcher->addListener(IDBConnection::CHECK_MISSING_PRIMARY_KEYS_EVENT,
function (GenericEvent $event) use ($container) {
/** @var MissingPrimaryKeyInformation $subject */
$subject = $event->getSubject();
$schema = new SchemaWrapper($container->query(Connection::class));
if ($schema->hasTable('federated_reshares')) {
$table = $schema->getTable('federated_reshares');
if (!$table->hasPrimaryKey()) {
$subject->addHintForMissingSubject($table->getName());
}
}
if ($schema->hasTable('systemtag_object_mapping')) {
$table = $schema->getTable('systemtag_object_mapping');
if (!$table->hasPrimaryKey()) {
$subject->addHintForMissingSubject($table->getName());
}
}
if ($schema->hasTable('comments_read_markers')) {
$table = $schema->getTable('comments_read_markers');
if (!$table->hasPrimaryKey()) {
$subject->addHintForMissingSubject($table->getName());
}
}
if ($schema->hasTable('collres_resources')) {
$table = $schema->getTable('collres_resources');
if (!$table->hasPrimaryKey()) {
$subject->addHintForMissingSubject($table->getName());
}
}
if ($schema->hasTable('collres_accesscache')) {
$table = $schema->getTable('collres_accesscache');
if (!$table->hasPrimaryKey()) {
$subject->addHintForMissingSubject($table->getName());
}
}
if ($schema->hasTable('filecache_extended')) {
$table = $schema->getTable('filecache_extended');
if (!$table->hasPrimaryKey()) {
$subject->addHintForMissingSubject($table->getName());
}
}
}
);
$oldEventDispatcher->addListener(IDBConnection::CHECK_MISSING_COLUMNS_EVENT,
function (GenericEvent $event) use ($container) {
/** @var MissingColumnInformation $subject */
$subject = $event->getSubject();
$schema = new SchemaWrapper($container->query(Connection::class));
if ($schema->hasTable('comments')) {
$table = $schema->getTable('comments');
if (!$table->hasColumn('reference_id')) {
$subject->addHintForMissingColumn($table->getName(), 'reference_id');
}
}
}
);
$eventDispatcher->addListener(AddMissingColumnsEvent::class, function (AddMissingColumnsEvent $event) {
$event->addMissingColumn(
'comments',
'reference_id',
Types::STRING,
[
'notnull' => false,
'length' => 64,
]
);
});
$eventDispatcher->addServiceListener(BeforeTemplateRenderedEvent::class, BeforeTemplateRenderedListener::class);
$eventDispatcher->addServiceListener(RemoteWipeStarted::class, RemoteWipeActivityListener::class);

59
core/Command/Db/AddMissingColumns.php
View file

@ -28,13 +28,12 @@ namespace OC\Core\Command\Db;
use OC\DB\Connection;
use OC\DB\SchemaWrapper;
use OCP\IDBConnection;
use OCP\DB\Events\AddMissingColumnsEvent;
use OCP\EventDispatcher\IEventDispatcher;
use Symfony\Component\Console\Command\Command;
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 AddMissingColumns
@ -47,7 +46,7 @@ use Symfony\Component\EventDispatcher\GenericEvent;
class AddMissingColumns extends Command {
public function __construct(
private Connection $connection,
private EventDispatcherInterface $dispatcher,
private IEventDispatcher $dispatcher,
) {
parent::__construct();
}
@ -60,46 +59,38 @@ class AddMissingColumns extends Command {
}
protected function execute(InputInterface $input, OutputInterface $output): int {
$this->addCoreColumns($output, $input->getOption('dry-run'));
$dryRun = $input->getOption('dry-run');
// Dispatch event so apps can also update columns if needed
$event = new GenericEvent($output);
$this->dispatcher->dispatch(IDBConnection::ADD_MISSING_COLUMNS_EVENT, $event);
return 0;
}
/**
* add missing indices to the share table
*
* @param OutputInterface $output
* @param bool $dryRun If true, will return the sql queries instead of running them.
* @throws \Doctrine\DBAL\Schema\SchemaException
*/
private function addCoreColumns(OutputInterface $output, bool $dryRun): void {
$output->writeln('<info>Check columns of the comments table.</info>');
$schema = new SchemaWrapper($this->connection);
$event = new AddMissingColumnsEvent();
$this->dispatcher->dispatchTyped($event);
$missingColumns = $event->getMissingColumns();
$updated = false;
if ($schema->hasTable('comments')) {
$table = $schema->getTable('comments');
if (!$table->hasColumn('reference_id')) {
$output->writeln('<info>Adding additional reference_id column to the comments table, this can take some time...</info>');
$table->addColumn('reference_id', 'string', [
'notnull' => false,
'length' => 64,
]);
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
if (!empty($missingColumns)) {
$schema = new SchemaWrapper($this->connection);
foreach ($missingColumns as $missingColumn) {
if ($schema->hasTable($missingColumn['tableName'])) {
$table = $schema->getTable($missingColumn['tableName']);
if (!$table->hasColumn($missingColumn['columnName'])) {
$output->writeln('<info>Adding additional ' . $missingColumn['columnName'] . ' column to the ' . $missingColumn['tableName'] . ' table, this can take some time...</info>');
$table->addColumn($missingColumn['columnName'], $missingColumn['typeName'], $missingColumn['options']);
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>' . $missingColumn['tableName'] . ' table updated successfully.</info>');
}
}
$updated = true;
$output->writeln('<info>Comments table updated successfully.</info>');
}
}
if (!$updated) {
$output->writeln('<info>Done.</info>');
}
return 0;
}
}

446
core/Command/Db/AddMissingIndices.php
View file

@ -33,18 +33,14 @@ declare(strict_types=1);
*/
namespace OC\Core\Command\Db;
use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
use OC\DB\Connection;
use OC\DB\SchemaWrapper;
use OCP\DB\Events\AddMissingIndicesEvent;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IDBConnection;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
/**
* Class AddMissingIndices
@ -57,8 +53,7 @@ use Symfony\Component\EventDispatcher\GenericEvent;
class AddMissingIndices extends Command {
public function __construct(
private Connection $connection,
private IEventDispatcher $eventDispatcher,
private EventDispatcherInterface $dispatcher,
private IEventDispatcher $dispatcher,
) {
parent::__construct();
}
@ -73,14 +68,9 @@ class AddMissingIndices extends Command {
protected function execute(InputInterface $input, OutputInterface $output): int {
$dryRun = $input->getOption('dry-run');
$this->addCoreIndexes($output, $dryRun);
// Dispatch event so apps can also update indexes if needed
$event = new GenericEvent($output);
$this->dispatcher->dispatch(IDBConnection::ADD_MISSING_INDEXES_EVENT, $event);
$event = new AddMissingIndicesEvent();
$this->eventDispatcher->dispatchTyped($event);
$this->dispatcher->dispatchTyped($event);
$missingIndices = $event->getMissingIndices();
if ($missingIndices !== []) {
@ -91,7 +81,23 @@ class AddMissingIndices extends Command {
$table = $schema->getTable($missingIndex['tableName']);
if (!$table->hasIndex($missingIndex['indexName'])) {
$output->writeln('<info>Adding additional ' . $missingIndex['indexName'] . ' index to the ' . $table->getName() . ' table, this can take some time...</info>');
$table->addIndex($missingIndex['columns'], $missingIndex['indexName']);
if ($missingIndex['dropUnnamedIndex']) {
foreach ($table->getIndexes() as $index) {
$columns = $index->getColumns();
if ($columns === $missingIndex['columns']) {
$table->dropIndex($index->getName());
}
}
}
if ($missingIndex['uniqueIndex']) {
$table->addUniqueIndex($missingIndex['columns'], $missingIndex['indexName'], $missingIndex['options']);
} else {
$table->addIndex($missingIndex['columns'], $missingIndex['indexName'], [], $missingIndex['options']);
}
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
@ -104,418 +110,4 @@ class AddMissingIndices extends Command {
return 0;
}
/**
* add missing indices to the share table
*
* @param OutputInterface $output
* @param bool $dryRun If true, will return the sql queries instead of running them.
* @throws \Doctrine\DBAL\Schema\SchemaException
*/
private function addCoreIndexes(OutputInterface $output, bool $dryRun): void {
$output->writeln('<info>Check indices of the share table.</info>');
$schema = new SchemaWrapper($this->connection);
$updated = false;
if ($schema->hasTable('share')) {
$table = $schema->getTable('share');
if (!$table->hasIndex('share_with_index')) {
$output->writeln('<info>Adding additional share_with index to the share table, this can take some time...</info>');
$table->addIndex(['share_with'], 'share_with_index');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>Share table updated successfully.</info>');
}
if (!$table->hasIndex('parent_index')) {
$output->writeln('<info>Adding additional parent index to the share table, this can take some time...</info>');
$table->addIndex(['parent'], 'parent_index');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>Share table updated successfully.</info>');
}
if (!$table->hasIndex('owner_index')) {
$output->writeln('<info>Adding additional owner index to the share table, this can take some time...</info>');
$table->addIndex(['uid_owner'], 'owner_index');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>Share table updated successfully.</info>');
}
if (!$table->hasIndex('initiator_index')) {
$output->writeln('<info>Adding additional initiator index to the share table, this can take some time...</info>');
$table->addIndex(['uid_initiator'], 'initiator_index');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>Share table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the filecache table.</info>');
if ($schema->hasTable('filecache')) {
$table = $schema->getTable('filecache');
if (!$table->hasIndex('fs_mtime')) {
$output->writeln('<info>Adding additional mtime index to the filecache table, this can take some time...</info>');
$table->addIndex(['mtime'], 'fs_mtime');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>Filecache table updated successfully.</info>');
}
if (!$table->hasIndex('fs_size')) {
$output->writeln('<info>Adding additional size index to the filecache table, this can take some time...</info>');
$table->addIndex(['size'], 'fs_size');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>Filecache table updated successfully.</info>');
}
if (!$table->hasIndex('fs_id_storage_size')) {
$output->writeln('<info>Adding additional size index to the filecache table, this can take some time...</info>');
$table->addIndex(['fileid', 'storage', 'size'], 'fs_id_storage_size');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>Filecache table updated successfully.</info>');
}
if (!$table->hasIndex('fs_storage_path_prefix') && !$schema->getDatabasePlatform() instanceof PostgreSQL94Platform) {
$output->writeln('<info>Adding additional path index to the filecache table, this can take some time...</info>');
$table->addIndex(['storage', 'path'], 'fs_storage_path_prefix', [], ['lengths' => [null, 64]]);
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>Filecache table updated successfully.</info>');
}
if (!$table->hasIndex('fs_parent')) {
$output->writeln('<info>Adding additional parent index to the filecache table, this can take some time...</info>');
$table->addIndex(['parent'], 'fs_parent');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>Filecache table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the twofactor_providers table.</info>');
if ($schema->hasTable('twofactor_providers')) {
$table = $schema->getTable('twofactor_providers');
if (!$table->hasIndex('twofactor_providers_uid')) {
$output->writeln('<info>Adding additional twofactor_providers_uid index to the twofactor_providers table, this can take some time...</info>');
$table->addIndex(['uid'], 'twofactor_providers_uid');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>Twofactor_providers table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the login_flow_v2 table.</info>');
if ($schema->hasTable('login_flow_v2')) {
$table = $schema->getTable('login_flow_v2');
if (!$table->hasIndex('poll_token')) {
$output->writeln('<info>Adding additional indeces to the login_flow_v2 table, this can take some time...</info>');
foreach ($table->getIndexes() as $index) {
$columns = $index->getColumns();
if ($columns === ['poll_token'] ||
$columns === ['login_token'] ||
$columns === ['timestamp']) {
$table->dropIndex($index->getName());
}
}
$table->addUniqueIndex(['poll_token'], 'poll_token');
$table->addUniqueIndex(['login_token'], 'login_token');
$table->addIndex(['timestamp'], 'timestamp');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>login_flow_v2 table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the whats_new table.</info>');
if ($schema->hasTable('whats_new')) {
$table = $schema->getTable('whats_new');
if (!$table->hasIndex('version')) {
$output->writeln('<info>Adding version index to the whats_new table, this can take some time...</info>');
foreach ($table->getIndexes() as $index) {
if ($index->getColumns() === ['version']) {
$table->dropIndex($index->getName());
}
}
$table->addUniqueIndex(['version'], 'version');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>whats_new table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the cards table.</info>');
$cardsUpdated = false;
if ($schema->hasTable('cards')) {
$table = $schema->getTable('cards');
if ($table->hasIndex('addressbookid_uri_index')) {
if ($table->hasIndex('cards_abiduri')) {
$table->dropIndex('addressbookid_uri_index');
} else {
$output->writeln('<info>Renaming addressbookid_uri_index index to cards_abiduri in the cards table, this can take some time...</info>');
foreach ($table->getIndexes() as $index) {
if ($index->getColumns() === ['addressbookid', 'uri']) {
$table->renameIndex('addressbookid_uri_index', 'cards_abiduri');
}
}
}
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$cardsUpdated = true;
}
if (!$table->hasIndex('cards_abid')) {
$output->writeln('<info>Adding cards_abid index to the cards table, this can take some time...</info>');
foreach ($table->getIndexes() as $index) {
if ($index->getColumns() === ['addressbookid']) {
$table->dropIndex($index->getName());
}
}
$table->addIndex(['addressbookid'], 'cards_abid');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$cardsUpdated = true;
}
if (!$table->hasIndex('cards_abiduri')) {
$output->writeln('<info>Adding cards_abiduri index to the cards table, this can take some time...</info>');
foreach ($table->getIndexes() as $index) {
if ($index->getColumns() === ['addressbookid', 'uri']) {
$table->dropIndex($index->getName());
}
}
$table->addIndex(['addressbookid', 'uri'], 'cards_abiduri');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$cardsUpdated = true;
}
if ($cardsUpdated) {
$updated = true;
$output->writeln('<info>cards table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the cards_properties table.</info>');
if ($schema->hasTable('cards_properties')) {
$table = $schema->getTable('cards_properties');
if (!$table->hasIndex('cards_prop_abid')) {
$output->writeln('<info>Adding cards_prop_abid index to the cards_properties table, this can take some time...</info>');
foreach ($table->getIndexes() as $index) {
if ($index->getColumns() === ['addressbookid']) {
$table->dropIndex($index->getName());
}
}
$table->addIndex(['addressbookid'], 'cards_prop_abid');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>cards_properties table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the calendarobjects_props table.</info>');
if ($schema->hasTable('calendarobjects_props')) {
$table = $schema->getTable('calendarobjects_props');
if (!$table->hasIndex('calendarobject_calid_index')) {
$output->writeln('<info>Adding calendarobject_calid_index index to the calendarobjects_props table, this can take some time...</info>');
$table->addIndex(['calendarid', 'calendartype'], 'calendarobject_calid_index');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>calendarobjects_props table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the schedulingobjects table.</info>');
if ($schema->hasTable('schedulingobjects')) {
$table = $schema->getTable('schedulingobjects');
if (!$table->hasIndex('schedulobj_principuri_index')) {
$output->writeln('<info>Adding schedulobj_principuri_index index to the schedulingobjects table, this can take some time...</info>');
$table->addIndex(['principaluri'], 'schedulobj_principuri_index');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>schedulingobjects table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the oc_properties table.</info>');
if ($schema->hasTable('properties')) {
$table = $schema->getTable('properties');
$propertiesUpdated = false;
if (!$table->hasIndex('properties_path_index')) {
$output->writeln('<info>Adding properties_path_index index to the oc_properties table, this can take some time...</info>');
$table->addIndex(['userid', 'propertypath'], 'properties_path_index');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$propertiesUpdated = true;
}
if (!$table->hasIndex('properties_pathonly_index')) {
$output->writeln('<info>Adding properties_pathonly_index index to the oc_properties table, this can take some time...</info>');
$table->addIndex(['propertypath'], 'properties_pathonly_index');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$propertiesUpdated = true;
}
if ($propertiesUpdated) {
$updated = true;
$output->writeln('<info>oc_properties table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the oc_jobs table.</info>');
if ($schema->hasTable('jobs')) {
$table = $schema->getTable('jobs');
if (!$table->hasIndex('job_lastcheck_reserved')) {
$output->writeln('<info>Adding job_lastcheck_reserved index to the oc_jobs table, this can take some time...</info>');
$table->addIndex(['last_checked', 'reserved_at'], 'job_lastcheck_reserved');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>oc_properties table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the oc_direct_edit table.</info>');
if ($schema->hasTable('direct_edit')) {
$table = $schema->getTable('direct_edit');
if (!$table->hasIndex('direct_edit_timestamp')) {
$output->writeln('<info>Adding direct_edit_timestamp index to the oc_direct_edit table, this can take some time...</info>');
$table->addIndex(['timestamp'], 'direct_edit_timestamp');
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>oc_direct_edit table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the oc_preferences table.</info>');
if ($schema->hasTable('preferences')) {
$table = $schema->getTable('preferences');
if (!$table->hasIndex('preferences_app_key')) {
$output->writeln('<info>Adding preferences_app_key index to the oc_preferences table, this can take some time...</info>');
$table->addIndex(['appid', 'configkey'], 'preferences_app_key');
$this->connection->migrateToSchema($schema->getWrappedSchema());
$updated = true;
$output->writeln('<info>oc_properties table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the oc_mounts table.</info>');
if ($schema->hasTable('mounts')) {
$table = $schema->getTable('mounts');
if (!$table->hasIndex('mounts_class_index')) {
$output->writeln('<info>Adding mounts_class_index index to the oc_mounts table, this can take some time...</info>');
$table->addIndex(['mount_provider_class'], 'mounts_class_index');
$this->connection->migrateToSchema($schema->getWrappedSchema());
$updated = true;
$output->writeln('<info>oc_mounts table updated successfully.</info>');
}
if (!$table->hasIndex('mounts_user_root_path_index')) {
$output->writeln('<info>Adding mounts_user_root_path_index index to the oc_mounts table, this can take some time...</info>');
$table->addIndex(['user_id', 'root_id', 'mount_point'], 'mounts_user_root_path_index', [], ['lengths' => [null, null, 128]]);
$this->connection->migrateToSchema($schema->getWrappedSchema());
$updated = true;
$output->writeln('<info>oc_mounts table updated successfully.</info>');
}
}
$output->writeln('<info>Check indices of the oc_systemtag_object_mapping table.</info>');
if ($schema->hasTable('systemtag_object_mapping')) {
$table = $schema->getTable('systemtag_object_mapping');
if (!$table->hasIndex('systag_by_tagid')) {
$output->writeln('<info>Adding systag_by_tagid index to the oc_systemtag_object_mapping table, this can take some time...</info>');
$table->addIndex(['systemtagid', 'objecttype'], 'systag_by_tagid');
$this->connection->migrateToSchema($schema->getWrappedSchema());
$updated = true;
$output->writeln('<info>oc_systemtag_object_mapping table updated successfully.</info>');
}
}
if (!$updated) {
$output->writeln('<info>Done.</info>');
}
}
}

142
core/Command/Db/AddMissingPrimaryKeys.php
View file

@ -28,13 +28,12 @@ namespace OC\Core\Command\Db;
use OC\DB\Connection;
use OC\DB\SchemaWrapper;
use OCP\IDBConnection;
use OCP\DB\Events\AddMissingPrimaryKeyEvent;
use OCP\EventDispatcher\IEventDispatcher;
use Symfony\Component\Console\Command\Command;
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 AddMissingPrimaryKeys
@ -47,7 +46,7 @@ use Symfony\Component\EventDispatcher\GenericEvent;
class AddMissingPrimaryKeys extends Command {
public function __construct(
private Connection $connection,
private EventDispatcherInterface $dispatcher,
private IEventDispatcher $dispatcher,
) {
parent::__construct();
}
@ -60,131 +59,44 @@ class AddMissingPrimaryKeys extends Command {
}
protected function execute(InputInterface $input, OutputInterface $output): int {
$this->addCorePrimaryKeys($output, $input->getOption('dry-run'));
$dryRun = $input->getOption('dry-run');
// Dispatch event so apps can also update indexes if needed
$event = new GenericEvent($output);
$this->dispatcher->dispatch(IDBConnection::ADD_MISSING_PRIMARY_KEYS_EVENT, $event);
return 0;
}
/**
* add missing indices to the share table
*
* @param OutputInterface $output
* @param bool $dryRun If true, will return the sql queries instead of running them.
* @throws \Doctrine\DBAL\Schema\SchemaException
*/
private function addCorePrimaryKeys(OutputInterface $output, bool $dryRun): void {
$output->writeln('<info>Check primary keys.</info>');
$schema = new SchemaWrapper($this->connection);
$event = new AddMissingPrimaryKeyEvent();
$this->dispatcher->dispatchTyped($event);
$missingKeys = $event->getMissingPrimaryKeys();
$updated = false;
if ($schema->hasTable('federated_reshares')) {
$table = $schema->getTable('federated_reshares');
if (!$table->hasPrimaryKey()) {
$output->writeln('<info>Adding primary key to the federated_reshares table, this can take some time...</info>');
$table->setPrimaryKey(['share_id'], 'federated_res_pk');
if ($table->hasIndex('share_id_index')) {
$table->dropIndex('share_id_index');
}
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>federated_reshares table updated successfully.</info>');
}
}
if (!empty($missingKeys)) {
$schema = new SchemaWrapper($this->connection);
if ($schema->hasTable('systemtag_object_mapping')) {
$table = $schema->getTable('systemtag_object_mapping');
if (!$table->hasPrimaryKey()) {
$output->writeln('<info>Adding primary key to the systemtag_object_mapping table, this can take some time...</info>');
$table->setPrimaryKey(['objecttype', 'objectid', 'systemtagid'], 'som_pk');
if ($table->hasIndex('mapping')) {
$table->dropIndex('mapping');
}
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>systemtag_object_mapping table updated successfully.</info>');
}
}
foreach ($missingKeys as $missingKey) {
if ($schema->hasTable($missingKey['tableName'])) {
$table = $schema->getTable($missingKey['tableName']);
if (!$table->hasPrimaryKey()) {
$output->writeln('<info>Adding primary key to the ' . $missingKey['tableName'] . ' table, this can take some time...</info>');
$table->setPrimaryKey($missingKey['columns'], $missingKey['primaryKeyName']);
if ($schema->hasTable('comments_read_markers')) {
$table = $schema->getTable('comments_read_markers');
if (!$table->hasPrimaryKey()) {
$output->writeln('<info>Adding primary key to the comments_read_markers table, this can take some time...</info>');
$table->setPrimaryKey(['user_id', 'object_type', 'object_id'], 'crm_pk');
if ($table->hasIndex('comments_marker_index')) {
$table->dropIndex('comments_marker_index');
}
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>comments_read_markers table updated successfully.</info>');
}
}
if ($missingKey['formerIndex'] && $table->hasIndex($missingKey['formerIndex'])) {
$table->dropIndex($missingKey['formerIndex']);
}
if ($schema->hasTable('collres_resources')) {
$table = $schema->getTable('collres_resources');
if (!$table->hasPrimaryKey()) {
$output->writeln('<info>Adding primary key to the collres_resources table, this can take some time...</info>');
$table->setPrimaryKey(['collection_id', 'resource_type', 'resource_id'], 'crr_pk');
if ($table->hasIndex('collres_unique_res')) {
$table->dropIndex('collres_unique_res');
}
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>collres_resources table updated successfully.</info>');
}
}
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
if ($schema->hasTable('collres_accesscache')) {
$table = $schema->getTable('collres_accesscache');
if (!$table->hasPrimaryKey()) {
$output->writeln('<info>Adding primary key to the collres_accesscache table, this can take some time...</info>');
$table->setPrimaryKey(['user_id', 'collection_id', 'resource_type', 'resource_id'], 'cra_pk');
if ($table->hasIndex('collres_unique_user')) {
$table->dropIndex('collres_unique_user');
$updated = true;
$output->writeln('<info>' . $missingKey['tableName'] . ' table updated successfully.</info>');
}
}
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>collres_accesscache table updated successfully.</info>');
}
}
if ($schema->hasTable('filecache_extended')) {
$table = $schema->getTable('filecache_extended');
if (!$table->hasPrimaryKey()) {
$output->writeln('<info>Adding primary key to the filecache_extended table, this can take some time...</info>');
$table->setPrimaryKey(['fileid'], 'fce_pk');
if ($table->hasIndex('fce_fileid_idx')) {
$table->dropIndex('fce_fileid_idx');
}
$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
if ($dryRun && $sqlQueries !== null) {
$output->writeln($sqlQueries);
}
$updated = true;
$output->writeln('<info>filecache_extended table updated successfully.</info>');
}
}
if (!$updated) {
$output->writeln('<info>Done.</info>');
}
return 0;
}
}

4
core/register_command.php
View file

@ -109,9 +109,9 @@ if (\OC::$server->getConfig()->getSystemValue('installed', false)) {
$application->add(new OC\Core\Command\Db\ConvertType(\OC::$server->getConfig(), new \OC\DB\ConnectionFactory(\OC::$server->getSystemConfig())));
$application->add(new OC\Core\Command\Db\ConvertMysqlToMB4(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection(), \OC::$server->getURLGenerator(), \OC::$server->get(LoggerInterface::class)));
$application->add(new OC\Core\Command\Db\ConvertFilecacheBigInt(\OC::$server->get(\OC\DB\Connection::class)));
$application->add(\OCP\Server::get(\OC\Core\Command\Db\AddMissingColumns::class));
$application->add(\OCP\Server::get(\OC\Core\Command\Db\AddMissingIndices::class));
$application->add(new OC\Core\Command\Db\AddMissingColumns(\OC::$server->get(\OC\DB\Connection::class), \OC::$server->getEventDispatcher()));
$application->add(new OC\Core\Command\Db\AddMissingPrimaryKeys(\OC::$server->get(\OC\DB\Connection::class), \OC::$server->getEventDispatcher()));
$application->add(\OCP\Server::get(\OC\Core\Command\Db\AddMissingPrimaryKeys::class));
if (\OC::$server->getConfig()->getSystemValueBool('debug', false)) {
$application->add(new OC\Core\Command\Db\Migrations\StatusCommand(\OC::$server->get(\OC\DB\Connection::class)));

2
lib/composer/composer/autoload_classmap.php
View file

@ -210,7 +210,9 @@ return array(
'OCP\\Contacts\\ContactsMenu\\IProvider' => $baseDir . '/lib/public/Contacts/ContactsMenu/IProvider.php',
'OCP\\Contacts\\Events\\ContactInteractedWithEvent' => $baseDir . '/lib/public/Contacts/Events/ContactInteractedWithEvent.php',
'OCP\\Contacts\\IManager' => $baseDir . '/lib/public/Contacts/IManager.php',
'OCP\\DB\\Events\\AddMissingColumnsEvent' => $baseDir . '/lib/public/DB/Events/AddMissingColumnsEvent.php',
'OCP\\DB\\Events\\AddMissingIndicesEvent' => $baseDir . '/lib/public/DB/Events/AddMissingIndicesEvent.php',
'OCP\\DB\\Events\\AddMissingPrimaryKeyEvent' => $baseDir . '/lib/public/DB/Events/AddMissingPrimaryKeyEvent.php',
'OCP\\DB\\Exception' => $baseDir . '/lib/public/DB/Exception.php',
'OCP\\DB\\IPreparedStatement' => $baseDir . '/lib/public/DB/IPreparedStatement.php',
'OCP\\DB\\IResult' => $baseDir . '/lib/public/DB/IResult.php',

2
lib/composer/composer/autoload_static.php
View file

@ -243,7 +243,9 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OCP\\Contacts\\ContactsMenu\\IProvider' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IProvider.php',
'OCP\\Contacts\\Events\\ContactInteractedWithEvent' => __DIR__ . '/../../..' . '/lib/public/Contacts/Events/ContactInteractedWithEvent.php',
'OCP\\Contacts\\IManager' => __DIR__ . '/../../..' . '/lib/public/Contacts/IManager.php',
'OCP\\DB\\Events\\AddMissingColumnsEvent' => __DIR__ . '/../../..' . '/lib/public/DB/Events/AddMissingColumnsEvent.php',
'OCP\\DB\\Events\\AddMissingIndicesEvent' => __DIR__ . '/../../..' . '/lib/public/DB/Events/AddMissingIndicesEvent.php',
'OCP\\DB\\Events\\AddMissingPrimaryKeyEvent' => __DIR__ . '/../../..' . '/lib/public/DB/Events/AddMissingPrimaryKeyEvent.php',
'OCP\\DB\\Exception' => __DIR__ . '/../../..' . '/lib/public/DB/Exception.php',
'OCP\\DB\\IPreparedStatement' => __DIR__ . '/../../..' . '/lib/public/DB/IPreparedStatement.php',
'OCP\\DB\\IResult' => __DIR__ . '/../../..' . '/lib/public/DB/IResult.php',

60
lib/public/DB/Events/AddMissingColumnsEvent.php Normal file
View file

@ -0,0 +1,60 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com>
*
* @author Joas Schilling <coding@schilljs.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 OCP\DB\Events;
/**
* Event to allow apps to register information about missing database columns
*
* This event will be dispatched for checking on the admin settings and when running
* occ db:add-missing-columns which will then create those columns
*
* @since 28.0.0
*/
class AddMissingColumnsEvent extends \OCP\EventDispatcher\Event {
/** @var array<array-key, array{tableName: string, columnName: string, typeName: string, options: array{}}> */
private array $missingColumns = [];
/**
* @param mixed[] $options
* @since 28.0.0
*/
public function addMissingColumn(string $tableName, string $columnName, string $typeName, array $options): void {
$this->missingColumns[] = [
'tableName' => $tableName,
'columnName' => $columnName,
'typeName' => $typeName,
'options' => $options,
];
}
/**
* @since 28.0.0
* @return array<array-key, array{tableName: string, columnName: string, typeName: string, options: array{}}>
*/
public function getMissingColumns(): array {
return $this->missingColumns;
}
}

31
lib/public/DB/Events/AddMissingIndicesEvent.php
View file

@ -2,9 +2,11 @@
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Julius Härtl <jus@bitgrid.net
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com>
* @copyright Copyright (c) 2023 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net
* @author Joas Schilling <coding@schilljs.com>
* @author Julius Härtl <jus@bitgrid.net>
*
* @license GNU AGPL version 3 or any later version
*
@ -34,24 +36,41 @@ namespace OCP\DB\Events;
* @since 28.0.0
*/
class AddMissingIndicesEvent extends \OCP\EventDispatcher\Event {
/** @var array<array-key, array{tableName: string, indexName: string, columns: string[]}> */
/** @var array<array-key, array{tableName: string, indexName: string, columns: string[], options: array{}, dropUnnamedIndex: bool, uniqueIndex: bool}> */
private array $missingIndices = [];
/**
* @param string[] $columns
* @since 28.0.0
*/
public function addMissingIndex(string $tableName, string $indexName, array $columns): void {
public function addMissingIndex(string $tableName, string $indexName, array $columns, array $options = [], bool $dropUnnamedIndex = false): void {
$this->missingIndices[] = [
'tableName' => $tableName,
'indexName' => $indexName,
'columns' => $columns
'columns' => $columns,
'options' => $options,
'dropUnnamedIndex' => $dropUnnamedIndex,
'uniqueIndex' => false,
];
}
/**
* @param string[] $columns
* @since 28.0.0
*/
public function addMissingUniqueIndex(string $tableName, string $indexName, array $columns, array $options = [], bool $dropUnnamedIndex = false): void {
$this->missingIndices[] = [
'tableName' => $tableName,
'indexName' => $indexName,
'columns' => $columns,
'options' => $options,
'dropUnnamedIndex' => $dropUnnamedIndex,
'uniqueIndex' => true,
];
}
/**
* @since 28.0.0
* @return array<array-key, array{tableName: string, indexName: string, columns: string[]}>
* @return array<array-key, array{tableName: string, indexName: string, columns: string[], options: array{}, dropUnnamedIndex: bool, uniqueIndex: bool}>
*/
public function getMissingIndices(): array {
return $this->missingIndices;

60
lib/public/DB/Events/AddMissingPrimaryKeyEvent.php Normal file
View file

@ -0,0 +1,60 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
*
* @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 OCP\DB\Events;
/**
* Event to allow apps to register information about missing database primary keys
*
* This event will be dispatched for checking on the admin settings and when running
* occ db:add-missing-primary-keys which will then create those keys
*
* @since 28.0.0
*/
class AddMissingPrimaryKeyEvent extends \OCP\EventDispatcher\Event {
/** @var array<array-key, array{tableName: string, primaryKeyName: string, columns: string[], formerIndex: null|string}> */
private array $missingPrimaryKeys = [];
/**
* @param string[] $columns
* @since 28.0.0
*/
public function addMissingPrimaryKey(string $tableName, string $primaryKeyName, array $columns, ?string $formerIndex = null): void {
$this->missingPrimaryKeys[] = [
'tableName' => $tableName,
'primaryKeyName' => $primaryKeyName,
'columns' => $columns,
'formerIndex' => $formerIndex,
];
}
/**
* @since 28.0.0
* @return array<array-key, array{tableName: string, primaryKeyName: string, columns: string[], formerIndex: null|string}>
*/
public function getMissingPrimaryKeys(): array {
return $this->missingPrimaryKeys;
}
}

31
lib/public/IDBConnection.php
View file

@ -34,7 +34,6 @@
namespace OCP;
use Doctrine\DBAL\Schema\Schema;
use OCP\DB\Events\AddMissingIndicesEvent;
use OCP\DB\Exception;
use OCP\DB\IPreparedStatement;
use OCP\DB\IResult;
@ -46,36 +45,6 @@ use OCP\DB\QueryBuilder\IQueryBuilder;
* @since 6.0.0
*/
interface IDBConnection {
/**
* @deprecated 22.0.0 this is an internal event, use {@see AddMissingIndicesEvent} instead
*/
public const ADD_MISSING_INDEXES_EVENT = self::class . '::ADD_MISSING_INDEXES';
/**
* @deprecated 22.0.0 this is an internal event, use {@see AddMissingIndicesEvent} instead
*/
public const CHECK_MISSING_INDEXES_EVENT = self::class . '::CHECK_MISSING_INDEXES';
/**
* @deprecated 22.0.0 this is an internal event
*/
public const ADD_MISSING_PRIMARY_KEYS_EVENT = self::class . '::ADD_MISSING_PRIMARY_KEYS';
/**
* @deprecated 22.0.0 this is an internal event
*/
public const CHECK_MISSING_PRIMARY_KEYS_EVENT = self::class . '::CHECK_MISSING_PRIMARY_KEYS';
/**
* @deprecated 22.0.0 this is an internal event
*/
public const ADD_MISSING_COLUMNS_EVENT = self::class . '::ADD_MISSING_COLUMNS';
/**
* @deprecated 22.0.0 this is an internal event
*/
public const CHECK_MISSING_COLUMNS_EVENT = self::class . '::CHECK_MISSING_COLUMNS';
/**
* Gets the QueryBuilder for the connection.
*