* * @author Bjoern Schiessle * @author Joas Schilling * @author Julius Härtl * @author Mario Danic * @author Morris Jobke * @author Robin Appelman * @author Roeland Jago Douma * @author Thomas Citharel * * @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 . * */ namespace OC\Core\Command\Db; use OC\AppFramework\Maintenance\OptionalIndexManager; use OC\DB\Connection; use OC\DB\SchemaWrapper; use OCP\IDBConnection; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\EventDispatcher\EventDispatcherInterface; use Symfony\Component\EventDispatcher\GenericEvent; /** * Class AddMissingIndices * * if you added any new indices to the database, this is the right place to add * your update routine for existing instances * * @package OC\Core\Command\Db */ class AddMissingIndices extends Command { /** @var Connection */ private $connection; /** @var EventDispatcherInterface */ private $dispatcher; /** @var OptionalIndexManager */ private $indexManager; public function __construct(Connection $connection, EventDispatcherInterface $dispatcher, OptionalIndexManager $indexManager) { parent::__construct(); $this->connection = $connection; $this->dispatcher = $dispatcher; $this->indexManager = $indexManager; } protected function configure() { $this ->setName('db:add-missing-indices') ->setDescription('Add missing indices to the database tables'); } protected function execute(InputInterface $input, OutputInterface $output): int { $this->addCoreIndexes($output); // Dispatch event so apps can also update indexes if needed $event = new GenericEvent($output); $this->dispatcher->dispatch(IDBConnection::ADD_MISSING_INDEXES_EVENT, $event); $this->addOptionalIndexed($output); return 0; } private function addOptionalIndexed(OutputInterface $output): void { $indexes = $this->indexManager->getPending(); foreach ($indexes as $index) { $output->writeln('Adding additonal ' . $index->getName() . ' index to the ' . $index->getTable() . ' this can take some time..'); $index->add(); } } /** * add missing indices to the share table * * @param OutputInterface $output * @throws \Doctrine\DBAL\Schema\SchemaException */ private function addCoreIndexes(OutputInterface $output) { $output->writeln('Check indices of the share table.'); $schema = new SchemaWrapper($this->connection); $updated = false; if ($schema->hasTable('share')) { $table = $schema->getTable('share'); if (!$table->hasIndex('share_with_index')) { $output->writeln('Adding additional share_with index to the share table, this can take some time...'); $table->addIndex(['share_with'], 'share_with_index'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('Share table updated successfully.'); } if (!$table->hasIndex('parent_index')) { $output->writeln('Adding additional parent index to the share table, this can take some time...'); $table->addIndex(['parent'], 'parent_index'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('Share table updated successfully.'); } if (!$table->hasIndex('owner_index')) { $output->writeln('Adding additional owner index to the share table, this can take some time...'); $table->addIndex(['uid_owner'], 'owner_index'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('Share table updated successfully.'); } if (!$table->hasIndex('initiator_index')) { $output->writeln('Adding additional initiator index to the share table, this can take some time...'); $table->addIndex(['uid_initiator'], 'initiator_index'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('Share table updated successfully.'); } } $output->writeln('Check indices of the filecache table.'); if ($schema->hasTable('filecache')) { $table = $schema->getTable('filecache'); if (!$table->hasIndex('fs_mtime')) { $output->writeln('Adding additional mtime index to the filecache table, this can take some time...'); $table->addIndex(['mtime'], 'fs_mtime'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('Filecache table updated successfully.'); } if (!$table->hasIndex('fs_size')) { $output->writeln('Adding additional size index to the filecache table, this can take some time...'); $table->addIndex(['size'], 'fs_size'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('Filecache table updated successfully.'); } } $output->writeln('Check indices of the twofactor_providers table.'); if ($schema->hasTable('twofactor_providers')) { $table = $schema->getTable('twofactor_providers'); if (!$table->hasIndex('twofactor_providers_uid')) { $output->writeln('Adding additional twofactor_providers_uid index to the twofactor_providers table, this can take some time...'); $table->addIndex(['uid'], 'twofactor_providers_uid'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('Twofactor_providers table updated successfully.'); } } $output->writeln('Check indices of the login_flow_v2 table.'); if ($schema->hasTable('login_flow_v2')) { $table = $schema->getTable('login_flow_v2'); if (!$table->hasIndex('poll_token')) { $output->writeln('Adding additional indeces to the login_flow_v2 table, this can take some time...'); 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'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('login_flow_v2 table updated successfully.'); } } $output->writeln('Check indices of the whats_new table.'); if ($schema->hasTable('whats_new')) { $table = $schema->getTable('whats_new'); if (!$table->hasIndex('version')) { $output->writeln('Adding version index to the whats_new table, this can take some time...'); foreach ($table->getIndexes() as $index) { if ($index->getColumns() === ['version']) { $table->dropIndex($index->getName()); } } $table->addUniqueIndex(['version'], 'version'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('whats_new table updated successfully.'); } } $output->writeln('Check indices of the cards table.'); $cardsUpdated = false; if ($schema->hasTable('cards')) { $table = $schema->getTable('cards'); if ($table->hasIndex('addressbookid_uri_index')) { $output->writeln('Renaming addressbookid_uri_index index to to the cards table, this can take some time...'); foreach ($table->getIndexes() as $index) { if ($index->getColumns() === ['addressbookid', 'uri']) { $table->renameIndex('addressbookid_uri_index', 'cards_abiduri'); } } $this->connection->migrateToSchema($schema->getWrappedSchema()); $cardsUpdated = true; } if (!$table->hasIndex('cards_abid')) { $output->writeln('Adding cards_abid index to the cards table, this can take some time...'); foreach ($table->getIndexes() as $index) { if ($index->getColumns() === ['addressbookid']) { $table->dropIndex($index->getName()); } } $table->addIndex(['addressbookid'], 'cards_abid'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $cardsUpdated = true; } if (!$table->hasIndex('cards_abiduri')) { $output->writeln('Adding cards_abiduri index to the cards table, this can take some time...'); foreach ($table->getIndexes() as $index) { if ($index->getColumns() === ['addressbookid', 'uri']) { $table->dropIndex($index->getName()); } } $table->addIndex(['addressbookid', 'uri'], 'cards_abiduri'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $cardsUpdated = true; } if ($cardsUpdated) { $updated = true; $output->writeln('cards table updated successfully.'); } } $output->writeln('Check indices of the cards_properties table.'); if ($schema->hasTable('cards_properties')) { $table = $schema->getTable('cards_properties'); if (!$table->hasIndex('cards_prop_abid')) { $output->writeln('Adding cards_prop_abid index to the cards_properties table, this can take some time...'); foreach ($table->getIndexes() as $index) { if ($index->getColumns() === ['addressbookid']) { $table->dropIndex($index->getName()); } } $table->addIndex(['addressbookid'], 'cards_prop_abid'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('cards_properties table updated successfully.'); } } $output->writeln('Check indices of the calendarobjects_props table.'); if ($schema->hasTable('calendarobjects_props')) { $table = $schema->getTable('calendarobjects_props'); if (!$table->hasIndex('calendarobject_calid_index')) { $output->writeln('Adding calendarobject_calid_index index to the calendarobjects_props table, this can take some time...'); $table->addIndex(['calendarid', 'calendartype'], 'calendarobject_calid_index'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('calendarobjects_props table updated successfully.'); } } $output->writeln('Check indices of the schedulingobjects table.'); if ($schema->hasTable('schedulingobjects')) { $table = $schema->getTable('schedulingobjects'); if (!$table->hasIndex('schedulobj_principuri_index')) { $output->writeln('Adding schedulobj_principuri_index index to the schedulingobjects table, this can take some time...'); $table->addIndex(['principaluri'], 'schedulobj_principuri_index'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('schedulingobjects table updated successfully.'); } } $output->writeln('Check indices of the oc_properties table.'); if ($schema->hasTable('properties')) { $table = $schema->getTable('properties'); if (!$table->hasIndex('properties_path_index')) { $output->writeln('Adding properties_path_index index to the oc_properties table, this can take some time...'); $table->addIndex(['userid', 'propertypath'], 'properties_path_index'); $this->connection->migrateToSchema($schema->getWrappedSchema()); $updated = true; $output->writeln('oc_properties table updated successfully.'); } } if (!$updated) { $output->writeln('Done.'); } } }