Replace possibly incorrect migrations by dummy migration to avoid execution

appinfo/info.xml

@@ -32,6 +32,11 @@
     <job>OCA\Polls\Cron\JanitorCron</job>
     <job>OCA\Polls\Cron\AutoReminderCron</job>
   </background-jobs>
+  <repair-steps>
+      <post-migration>
+          <step>OCA\Polls\Migration\RepairSteps\UpdateHashes</step>
+      </post-migration>
+  </repair-steps>
   <commands>
     <command>OCA\Polls\Command\Db\CleanMigrations</command>
     <command>OCA\Polls\Command\Db\CreateIndices</command>

lib/Command/Db/CleanMigrations.php

@@ -10,7 +10,7 @@
 
 use Doctrine\DBAL\Schema\Schema;
 use OCA\Polls\Command\Command;
-use OCA\Polls\Db\V3\TableManager;
+use OCA\Polls\Db\V4\TableManager;
 use OCP\IDBConnection;
 
 /**

lib/Command/Db/CreateIndices.php

@@ -10,7 +10,7 @@
 
 use Doctrine\DBAL\Schema\Schema;
 use OCA\Polls\Command\Command;
-use OCA\Polls\Db\V3\IndexManager;
+use OCA\Polls\Db\V4\IndexManager;
 use OCP\IDBConnection;
 
 /**

lib/Command/Db/FixDB.php

@@ -10,7 +10,7 @@
 
 use Doctrine\DBAL\Schema\Schema;
 use OCA\Polls\Command\Command;
-use OCA\Polls\Db\V3\TableManager;
+use OCA\Polls\Db\V4\TableManager;
 use OCP\IDBConnection;
 
 /**

lib/Command/Db/Purge.php

@@ -9,7 +9,7 @@
 namespace OCA\Polls\Command\Db;
 
 use OCA\Polls\Command\Command;
-use OCA\Polls\Db\V3\TableManager;
+use OCA\Polls\Db\V4\TableManager;
 use OCP\IDBConnection;
 
 /**

lib/Command/Db/Rebuild.php

@@ -9,8 +9,8 @@
 namespace OCA\Polls\Command\Db;
 
 use Doctrine\DBAL\Schema\Schema;
-use OCA\Polls\Db\V3\TableManager;
-use OCA\Polls\Db\V3\IndexManager;
+use OCA\Polls\Db\V4\TableManager;
+use OCA\Polls\Db\V4\IndexManager;
 use OCA\Polls\Command\Command;
 use OCP\IDBConnection;
 
@@ -68,7 +68,7 @@ protected function runCommands(): int {
 
 		$this->printComment('Step 5. Validate and fix records');
 		$this->removeOrphaned();
-		$this->migrateOptionsToHash();
+		$this->updateHashes();
 		$this->deleteAllDuplicates();
 		$this->setLastInteraction();
 
@@ -123,9 +123,9 @@ private function createOrUpdateSchema(): void {
 	/**
 	 * Add or update hash for votes and options
 	 */
-	private function migrateOptionsToHash(): void {
+	private function updateHashes(): void {
 		$this->printComment(' - Add or update hashes');
-		$messages = $this->tableManager->migrateOptionsToHash();
+		$messages = $this->tableManager->updateHashes();
 		$this->printInfo($messages, '   ');
 	}
 

lib/Command/Db/RemoveFKConstraints.php

@@ -10,7 +10,7 @@
 
 use Doctrine\DBAL\Schema\Schema;
 use OCA\Polls\Command\Command;
-use OCA\Polls\Db\V3\IndexManager;
+use OCA\Polls\Db\V4\IndexManager;
 use OCP\IDBConnection;
 
 /**

lib/Command/Db/RemoveOptionalIndices.php

@@ -10,7 +10,7 @@
 
 use Doctrine\DBAL\Schema\Schema;
 use OCA\Polls\Command\Command;
-use OCA\Polls\Db\V3\IndexManager;
+use OCA\Polls\Db\V4\IndexManager;
 use OCP\IDBConnection;
 
 /**

lib/Command/Db/RemoveUniqueIndices.php

@@ -10,7 +10,7 @@
 
 use Doctrine\DBAL\Schema\Schema;
 use OCA\Polls\Command\Command;
-use OCA\Polls\Db\V3\IndexManager;
+use OCA\Polls\Db\V4\IndexManager;
 use OCP\IDBConnection;
 
 /**

lib/Command/Db/ResetWatch.php

@@ -10,10 +10,10 @@
 
 use Doctrine\DBAL\Schema\Schema;
 use OCA\Polls\Command\Command;
-use OCA\Polls\Db\V3\IndexManager;
-use OCA\Polls\Db\V3\TableManager;
+use OCA\Polls\Db\V4\IndexManager;
+use OCA\Polls\Db\V4\TableManager;
 use OCA\Polls\Db\Watch;
-use OCA\Polls\Migration\V3\TableSchema;
+use OCA\Polls\Migration\V4\TableSchema;
 use OCP\IDBConnection;
 
 /**

lib/Cron/JanitorCron.php

@@ -15,7 +15,7 @@
 use OCA\Polls\Db\OptionMapper;
 use OCA\Polls\Db\PollMapper;
 use OCA\Polls\Db\ShareMapper;
-use OCA\Polls\Db\V3\TableManager;
+use OCA\Polls\Db\V4\TableManager;
 use OCA\Polls\Db\VoteMapper;
 use OCA\Polls\Helper\Container;
 use OCA\Polls\Model\Settings\AppSettings;
@@ -65,6 +65,9 @@ protected function run($argument) {
 			// delete entries older than 1 day
 			$this->tableManager->tidyWatchTable(time() - 86400);
 
+			// first make sure all options and votes have a correct hash
+			$this->tableManager->updateHashes();
+
 			// purge entries virtually deleted more than 12 hours ago
 			$deleted['comments'] = $this->commentMapper->purgeDeletedComments(time() - 4320);
 			$deleted['options'] = $this->optionMapper->purgeDeletedOptions(time() - 4320);

lib/Db/Option.php

@@ -200,8 +200,8 @@ public function shiftOption(DateTimeZone $timeZone, int $step, string $unit): vo
 	}
 
 	/**
-	 * Syncs pollOptionText and order according to timestamp and duration if timestamp > 0
-	 * Updates hash
+	 * Syncs pollOptionText and order according to timestamp and duration if timestamp > 0 and
+	 * updates hash based on synced pollId and pollOptionText
 	 */
 	public function syncOption(): void {
 		// make sure, pollOptionText matches timestamp and duration

lib/Db/V3/DbManager.php → lib/Db/V4/DbManager.php

@@ -6,7 +6,7 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-namespace OCA\Polls\Db\V3;
+namespace OCA\Polls\Db\V4;
 
 use Doctrine\DBAL\Schema\Schema;
 use Exception;

lib/Db/V3/IndexManager.php → lib/Db/V4/IndexManager.php

@@ -6,12 +6,12 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-namespace OCA\Polls\Db\V3;
+namespace OCA\Polls\Db\V4;
 
 use Doctrine\DBAL\Schema\Exception\IndexDoesNotExist;
 use Doctrine\DBAL\Schema\Schema;
 use Exception;
-use OCA\Polls\Migration\V3\TableSchema;
+use OCA\Polls\Migration\V4\TableSchema;
 use OCP\DB\ISchemaWrapper;
 use OCP\IConfig;
 use OCP\IDBConnection;
@@ -104,7 +104,12 @@ public function createForeignKeyConstraint(string $parentTableName, string $chil
 		return 'Added ' . $parentTableName . '[' . $constraintColumn . '] <- ' . $childTableName . '[id]';
 	}
 
-	public function listExistingIndices() {
+	/**
+	 * @return string[]
+	 *
+	 * @psalm-return list{0?: string,...}
+	 */
+	public function listExistingIndices(): array {
 		$this->needsSchema();
 		$messages = [];
 

lib/Db/V3/TableManager.php → lib/Db/V4/TableManager.php

@@ -6,8 +6,9 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-namespace OCA\Polls\Db\V3;
+namespace OCA\Polls\Db\V4;
 
+use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Types\Type;
 use Exception;
 use OCA\Polls\AppConstants;
@@ -19,7 +20,7 @@
 use OCA\Polls\Db\VoteMapper;
 use OCA\Polls\Db\Watch;
 use OCA\Polls\Helper\Hash;
-use OCA\Polls\Migration\V3\TableSchema;
+use OCA\Polls\Migration\V4\TableSchema;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IConfig;
 use OCP\IDBConnection;
@@ -540,59 +541,130 @@ public function setLastInteraction(?int $timestamp = null): string {
 
 	}
 
-	public function migrateOptionsToHash(): array {
-		$schema = $this->connection->createSchema();
+	/**
+	 * @return string[]
+	 *
+	 * @psalm-return list{0?: string,...}
+	 */
+	private function updateVoteHashes(Schema &$schema): array {
 		$messages = [];
-
-		if ($schema->hasTable($this->dbPrefix . OptionMapper::TABLE)) {
-			$table = $schema->getTable($this->dbPrefix . OptionMapper::TABLE);
+		if ($schema->hasTable($this->dbPrefix . VoteMapper::TABLE)) {
+			$table = $schema->getTable($this->dbPrefix . VoteMapper::TABLE);
 			$count = 0;
-			if ($table->hasColumn('poll_option_hash')) {
-				foreach ($this->optionMapper->getAll(includeNull: true) as $option) {
+			$updated = 0;
+			if ($table->hasColumn('vote_option_hash')) {
+				foreach ($this->voteMapper->getAll(includeNull: true) as $vote) {
 					try {
-						$option->syncOption();
-						$this->optionMapper->update($option);
+						// if the hash of the vote differs from calculated hash update the vote hash
+						if ($vote->getVoteOptionHash() !== Hash::getOptionHash($vote->getPollId(), $vote->getVoteOptionText())) {
+							$vote->setVoteOptionHash(Hash::getOptionHash($vote->getPollId(), $vote->getVoteOptionText()));
+							$vote = $this->voteMapper->update($vote);
+							$updated++;
+						}
+
 						$count++;
+
 					} catch (Exception $e) {
-						$messages[] = 'Skip hash update - Error updating option hash for optionId ' . $option->getId();
-						$this->logger->error('Error updating option hash for optionId {id}', ['id' => $option->getId(), 'message' => $e->getMessage()]);
+						$messages[] = 'Skip hash update - Error updating option hash for voteId ' . $vote->getId();
+						$this->logger->error('Error updating option hash for voteId {id}', [
+							'id' => $vote->getId(),
+							'message' => $e->getMessage()
+						]);
 					}
 				}
 
-				$this->logger->info('Updated {number} hashes in {db}', ['number' => $count,'db' => $this->dbPrefix . OptionMapper::TABLE]);
-				$messages[] = 'Updated ' . $count . ' option hashes';
+				if ($updated === 0) {
+					$this->logger->info('Verified {count} vote hashes in {db}', [
+						'count' => $count,
+						'db' => $this->dbPrefix . VoteMapper::TABLE
+					]);
+					$messages[] = 'No vote hashes to update';
+
+				} else {
+					$this->logger->info('Updated {updated} hashes of {count} votes in {db}', [
+						'updated' => $updated,
+						'count' => $count,
+						'db' => $this->dbPrefix . VoteMapper::TABLE
+					]);
+					$messages[] = 'Updated ' . $updated . ' vote hashes';
+
+				}
 
 			} else {
-				$this->logger->error('{db} is missing column \'poll_option_hash\' - aborted recalculating hashes', [ 'db' => $this->dbPrefix . OptionMapper::TABLE]);
+				$this->logger->error('{db} is missing column \'poll_option_hash\' - aborted recalculating hashes', [
+					'db' => $this->dbPrefix . VoteMapper::TABLE
+				]);
 			}
 		} else {
-			$this->logger->error('{db} is missing - aborted recalculating hashes', [ 'db' => $this->dbPrefix . OptionMapper::TABLE]);
+			$this->logger->error('{db} is missing- aborted recalculating hashes', [
+				'db' => $this->dbPrefix . VoteMapper::TABLE
+			]);
 		}
+		return $messages;
+	}
 
-		if ($schema->hasTable($this->dbPrefix . VoteMapper::TABLE)) {
-			$table = $schema->getTable($this->dbPrefix . VoteMapper::TABLE);
+	/**
+	 * @return string[]
+	 *
+	 * @psalm-return list{0?: string,...}
+	 */
+	private function updateOptionHashes(Schema &$schema): array {
+		$messages = [];
+
+		if ($schema->hasTable($this->dbPrefix . OptionMapper::TABLE)) {
+			$table = $schema->getTable($this->dbPrefix . OptionMapper::TABLE);
 			$count = 0;
-			if ($table->hasColumn('vote_option_hash')) {
-				foreach ($this->voteMapper->getAll(includeNull: true) as $vote) {
+			$updated = 0;
+
+			if ($table->hasColumn('poll_option_hash')) {
+				foreach ($this->optionMapper->getAll(includeNull: true) as $option) {
 					try {
-						$vote->setVoteOptionHash(Hash::getOptionHash($vote->getPollId(), $vote->getVoteOptionText()));
-						$this->voteMapper->update($vote);
+						// if the option's hash differs from $actualHash update the option
+						if ($option->getPollOptionHash() !== Hash::getOptionHash($option->getPollId(), $option->getPollOptionText())) {
+							$option->setPollOptionHash(Hash::getOptionHash($option->getPollId(), $option->getPollOptionText()));
+							$option = $this->optionMapper->update($option);
+							$updated++;
+						}
+
 						$count++;
+
 					} catch (Exception $e) {
-						$messages[] = 'Skip hash update - Error updating option hash for voteId ' . $vote->getId();
-						$this->logger->error('Error updating option hash for voteId {id}', ['id' => $vote->getId(), 'message' => $e->getMessage()]);
+						$messages[] = 'Skip hash update - Error updating option hash for optionId ' . $option->getId();
+						$this->logger->error('Error updating option hash for optionId {id}', ['id' => $option->getId(), 'message' => $e->getMessage()]);
 					}
 				}
 
-				$this->logger->info('Updated {number} hashes in {db}', ['number' => $count, 'db' => $this->dbPrefix . VoteMapper::TABLE]);
-				$messages[] = 'Updated ' . $count . ' vote hashes';
+				if ($updated === 0) {
+					$this->logger->info('Verified {count} option hashes in {db}', [
+						'count' => $count,
+						'db' => $this->dbPrefix . OptionMapper::TABLE
+					]);
+					$messages[] = 'No option hashes to update';
+
+				} else {
+					$this->logger->info('Updated {updated} hashes of {count} options in {db}', [
+						'updated' => $updated,
+						'count' => $count,
+						'db' => $this->dbPrefix . OptionMapper::TABLE
+					]);
+					$messages[] = 'Updated ' . $updated . ' option hashes';
+
+				}
 
 			} else {
-				$this->logger->error('{db} is missing column \'poll_option_hash\' - aborted recalculating hashes', ['db' => $this->dbPrefix . VoteMapper::TABLE]);
+				$this->logger->error('{db} is missing column \'poll_option_hash\' - aborted recalculating hashes', [ 'db' => $this->dbPrefix . OptionMapper::TABLE]);
 			}
+
 		} else {
-			$this->logger->error('{db} is missing- aborted recalculating hashes', ['db' => $this->dbPrefix . VoteMapper::TABLE]);
+			$this->logger->error('{db} is missing - aborted recalculating hashes', [ 'db' => $this->dbPrefix . OptionMapper::TABLE]);
 		}
 		return $messages;
 	}
+
+	public function updateHashes(): array {
+		$schema = $this->connection->createSchema();
+		$messages = $this->updateOptionHashes($schema);
+		$messages = array_merge($messages, $this->updateVoteHashes($schema));
+		return $messages;
+	}
 }

lib/Listener/AddMissingIndicesListener.php

@@ -8,7 +8,7 @@
 
 namespace OCA\Polls\Listener;
 
-use OCA\Polls\Migration\V3\TableSchema;
+use OCA\Polls\Migration\V4\TableSchema;
 use OCP\DB\Events\AddMissingIndicesEvent;
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;

lib/Migration/FixVotes.php

@@ -10,7 +10,7 @@
 namespace OCA\Polls\Migration;
 
 use Doctrine\DBAL\Schema\Schema;
-use OCA\Polls\Db\V3\TableManager;
+use OCA\Polls\Db\V4\TableManager;
 use OCP\IDBConnection;
 use OCP\Migration\IOutput;
 use OCP\Migration\IRepairStep;