nextcloud / server

lib/private/Repair/NC15/SetVcardDatabaseUID.php

Indentation +119 added lines, -119 removed lines

@@ -32,123 +32,123 @@
 use Sabre\VObject\ParseException;
 
 class SetVcardDatabaseUID implements IRepairStep {
-	const MAX_ROWS = 1000;
-
-	/** @var IDBConnection */
-	private $connection;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var ILogger */
-	private $logger;
-
-	private $updateQuery;
-
-	public function __construct(IDBConnection $connection, IConfig $config, ILogger $logger) {
-		$this->connection = $connection;
-		$this->config     = $config;
-		$this->logger     = $logger;
-	}
-
-	public function getName() {
-		return 'Extract the vcard uid and store it in the db';
-	}
-
-	/**
-	 * @return \Generator
-	 * @suppress SqlInjectionChecker
-	 */
-	private function getInvalidEntries() {
-		$builder = $this->connection->getQueryBuilder();
-
-		$builder->select('id', 'carddata')
-		        ->from('cards')
-		        ->where($builder->expr()->isNull('uid'))
-		        ->setMaxResults(self::MAX_ROWS);
-
-		do {
-			$result = $builder->execute();
-			$rows   = $result->fetchAll();
-			foreach ($rows as $row) {
-				yield $row;
-			}
-			$result->closeCursor();
-		} while (count($rows) > 0);
-	}
-
-	/**
-	 * Extract UID from vcard
-	 *
-	 * @param string $cardData the vcard raw data
-	 * @param IOutput $output the output logger
-	 * @return string the uid or empty if none
-	 */
-	private function getUID(string $cardData, IOutput $output): string {
-		try {
-			$vCard = Reader::read($cardData);
-			if ($vCard->UID) {
-				$uid = $vCard->UID->getValue();
-
-				return $uid;
-			}
-		} catch (ParseException $e) {
-			$output->warning('One vCard is broken. We logged the exception and will continue the repair.');
-			$this->logger->logException($e);
-		}
-
-		return '';
-	}
-
-	/**
-	 * @param int $id
-	 * @param string $uid
-	 */
-	private function update(int $id, string $uid) {
-		if (!$this->updateQuery) {
-			$builder = $this->connection->getQueryBuilder();
-
-			$this->updateQuery = $builder->update('cards')
-			                             ->set('uid', $builder->createParameter('uid'))
-			                             ->where($builder->expr()->eq('id', $builder->createParameter('id')));
-		}
-
-		$this->updateQuery->setParameter('id', $id);
-		$this->updateQuery->setParameter('uid', $uid);
-
-		$this->updateQuery->execute();
-	}
-
-	private function repair(IOutput $output): int {
-		$this->connection->beginTransaction();
-		$entries = $this->getInvalidEntries();
-		$count   = 0;
-		foreach ($entries as $entry) {
-			$count++;
-			$cardData = $entry['carddata'];
-			if (is_resource($cardData)) {
-				$cardData = stream_get_contents($cardData);
-			}
-			$uid = $this->getUID($cardData, $output);
-			$this->update($entry['id'], $uid);
-		}
-		$this->connection->commit();
-
-		return $count;
-	}
-
-	private function shouldRun() {
-		$versionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0.0');
-
-		// was added to 15.0.0.2
-		return version_compare($versionFromBeforeUpdate, '15.0.0.2', '<=');
-	}
-
-	public function run(IOutput $output) {
-		if ($this->shouldRun()) {
-			$count = $this->repair($output);
-
-			$output->info('Fixed ' . $count . ' vcards');
-		}
-	}
+    const MAX_ROWS = 1000;
+
+    /** @var IDBConnection */
+    private $connection;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var ILogger */
+    private $logger;
+
+    private $updateQuery;
+
+    public function __construct(IDBConnection $connection, IConfig $config, ILogger $logger) {
+        $this->connection = $connection;
+        $this->config     = $config;
+        $this->logger     = $logger;
+    }
+
+    public function getName() {
+        return 'Extract the vcard uid and store it in the db';
+    }
+
+    /**
+     * @return \Generator
+     * @suppress SqlInjectionChecker
+     */
+    private function getInvalidEntries() {
+        $builder = $this->connection->getQueryBuilder();
+
+        $builder->select('id', 'carddata')
+                ->from('cards')
+                ->where($builder->expr()->isNull('uid'))
+                ->setMaxResults(self::MAX_ROWS);
+
+        do {
+            $result = $builder->execute();
+            $rows   = $result->fetchAll();
+            foreach ($rows as $row) {
+                yield $row;
+            }
+            $result->closeCursor();
+        } while (count($rows) > 0);
+    }
+
+    /**
+     * Extract UID from vcard
+     *
+     * @param string $cardData the vcard raw data
+     * @param IOutput $output the output logger
+     * @return string the uid or empty if none
+     */
+    private function getUID(string $cardData, IOutput $output): string {
+        try {
+            $vCard = Reader::read($cardData);
+            if ($vCard->UID) {
+                $uid = $vCard->UID->getValue();
+
+                return $uid;
+            }
+        } catch (ParseException $e) {
+            $output->warning('One vCard is broken. We logged the exception and will continue the repair.');
+            $this->logger->logException($e);
+        }
+
+        return '';
+    }
+
+    /**
+     * @param int $id
+     * @param string $uid
+     */
+    private function update(int $id, string $uid) {
+        if (!$this->updateQuery) {
+            $builder = $this->connection->getQueryBuilder();
+
+            $this->updateQuery = $builder->update('cards')
+                                            ->set('uid', $builder->createParameter('uid'))
+                                            ->where($builder->expr()->eq('id', $builder->createParameter('id')));
+        }
+
+        $this->updateQuery->setParameter('id', $id);
+        $this->updateQuery->setParameter('uid', $uid);
+
+        $this->updateQuery->execute();
+    }
+
+    private function repair(IOutput $output): int {
+        $this->connection->beginTransaction();
+        $entries = $this->getInvalidEntries();
+        $count   = 0;
+        foreach ($entries as $entry) {
+            $count++;
+            $cardData = $entry['carddata'];
+            if (is_resource($cardData)) {
+                $cardData = stream_get_contents($cardData);
+            }
+            $uid = $this->getUID($cardData, $output);
+            $this->update($entry['id'], $uid);
+        }
+        $this->connection->commit();
+
+        return $count;
+    }
+
+    private function shouldRun() {
+        $versionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0.0');
+
+        // was added to 15.0.0.2
+        return version_compare($versionFromBeforeUpdate, '15.0.0.2', '<=');
+    }
+
+    public function run(IOutput $output) {
+        if ($this->shouldRun()) {
+            $count = $this->repair($output);
+
+            $output->info('Fixed ' . $count . ' vcards');
+        }
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -148,7 +148,7 @@
 		if ($this->shouldRun()) {
 			$count = $this->repair($output);
 
-			$output->info('Fixed ' . $count . ' vcards');
+			$output->info('Fixed '.$count.' vcards');
 		}
 	}
 }

lib/private/Repair.php

Indentation +171 added lines, -171 removed lines

@@ -60,175 +60,175 @@
 
 class Repair implements IOutput {
 
-	/** @var IRepairStep[] */
-	private $repairSteps;
-
-	/** @var EventDispatcher */
-	private $dispatcher;
-
-	/** @var string */
-	private $currentStep;
-
-	/**
-	 * Creates a new repair step runner
-	 *
-	 * @param IRepairStep[] $repairSteps array of RepairStep instances
-	 * @param EventDispatcher $dispatcher
-	 */
-	public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) {
-		$this->repairSteps = $repairSteps;
-		$this->dispatcher  = $dispatcher;
-	}
-
-	/**
-	 * Run a series of repair steps for common problems
-	 */
-	public function run() {
-		if (count($this->repairSteps) === 0) {
-			$this->emit('\OC\Repair', 'info', array('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]);
-			$step->run($this);
-		}
-	}
-
-	/**
-	 * Add repair step
-	 *
-	 * @param IRepairStep|string $repairStep repair step
-	 * @throws \Exception
-	 */
-	public function addStep($repairStep) {
-		if (is_string($repairStep)) {
-			try {
-				$s = \OC::$server->query($repairStep);
-			} catch (QueryException $e) {
-				if (class_exists($repairStep)) {
-					$s = new $repairStep();
-				} else {
-					throw new \Exception("Repair step '$repairStep' is unknown");
-				}
-			}
-
-			if ($s instanceof IRepairStep) {
-				$this->repairSteps[] = $s;
-			} else {
-				throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
-			}
-		} else {
-			$this->repairSteps[] = $repairStep;
-		}
-	}
-
-	/**
-	 * Returns the default repair steps to be run on the
-	 * command line or after an upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getRepairSteps() {
-		return [
-			new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false),
-			new RepairMimeTypes(\OC::$server->getConfig()),
-			new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
-			new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
-			new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()),
-			new MoveUpdaterStepFile(\OC::$server->getConfig()),
-			new FixMountStorages(\OC::$server->getDatabaseConnection()),
-			new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
-			new AddLogRotateJob(\OC::$server->getJobList()),
-			new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class)),
-			new ClearGeneratedAvatarCache(\OC::$server->getConfig(), \OC::$server->query(AvatarManager::class)),
-			new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()),
-			new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()),
-			new RepairPendingCronJobs(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
-			new SetVcardDatabaseUID(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig(), \OC::$server->getLogger())
-		];
-	}
-
-	/**
-	 * Returns expensive repair steps to be run on the
-	 * command line with a special option.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getExpensiveRepairSteps() {
-		return [
-			new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager())
-		];
-	}
-
-	/**
-	 * Returns the repair steps to be run before an
-	 * upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getBeforeUpgradeRepairSteps() {
-		$connection = \OC::$server->getDatabaseConnection();
-		$config     = \OC::$server->getConfig();
-		$steps      = [
-			new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true),
-			new SqliteAutoincrement($connection),
-			new SaveAccountsTableData($connection, $config),
-			new DropAccountTermsTable($connection)
-		];
-
-		return $steps;
-	}
-
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param array $arguments
-	 */
-	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) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'info', array($string));
-	}
-
-	/**
-	 * @param string $message
-	 */
-	public function warning($message) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'warning', [$message]);
-	}
-
-	/**
-	 * @param int $max
-	 */
-	public function startProgress($max = 0) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
-	}
-
-	/**
-	 * @param int $step
-	 * @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]);
-	}
-
-	/**
-	 * @param int $max
-	 */
-	public function finishProgress() {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'finishProgress', []);
-	}
+    /** @var IRepairStep[] */
+    private $repairSteps;
+
+    /** @var EventDispatcher */
+    private $dispatcher;
+
+    /** @var string */
+    private $currentStep;
+
+    /**
+     * Creates a new repair step runner
+     *
+     * @param IRepairStep[] $repairSteps array of RepairStep instances
+     * @param EventDispatcher $dispatcher
+     */
+    public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) {
+        $this->repairSteps = $repairSteps;
+        $this->dispatcher  = $dispatcher;
+    }
+
+    /**
+     * Run a series of repair steps for common problems
+     */
+    public function run() {
+        if (count($this->repairSteps) === 0) {
+            $this->emit('\OC\Repair', 'info', array('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]);
+            $step->run($this);
+        }
+    }
+
+    /**
+     * Add repair step
+     *
+     * @param IRepairStep|string $repairStep repair step
+     * @throws \Exception
+     */
+    public function addStep($repairStep) {
+        if (is_string($repairStep)) {
+            try {
+                $s = \OC::$server->query($repairStep);
+            } catch (QueryException $e) {
+                if (class_exists($repairStep)) {
+                    $s = new $repairStep();
+                } else {
+                    throw new \Exception("Repair step '$repairStep' is unknown");
+                }
+            }
+
+            if ($s instanceof IRepairStep) {
+                $this->repairSteps[] = $s;
+            } else {
+                throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
+            }
+        } else {
+            $this->repairSteps[] = $repairStep;
+        }
+    }
+
+    /**
+     * Returns the default repair steps to be run on the
+     * command line or after an upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getRepairSteps() {
+        return [
+            new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false),
+            new RepairMimeTypes(\OC::$server->getConfig()),
+            new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
+            new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
+            new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()),
+            new MoveUpdaterStepFile(\OC::$server->getConfig()),
+            new FixMountStorages(\OC::$server->getDatabaseConnection()),
+            new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
+            new AddLogRotateJob(\OC::$server->getJobList()),
+            new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class)),
+            new ClearGeneratedAvatarCache(\OC::$server->getConfig(), \OC::$server->query(AvatarManager::class)),
+            new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()),
+            new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()),
+            new RepairPendingCronJobs(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
+            new SetVcardDatabaseUID(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig(), \OC::$server->getLogger())
+        ];
+    }
+
+    /**
+     * Returns expensive repair steps to be run on the
+     * command line with a special option.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getExpensiveRepairSteps() {
+        return [
+            new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager())
+        ];
+    }
+
+    /**
+     * Returns the repair steps to be run before an
+     * upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getBeforeUpgradeRepairSteps() {
+        $connection = \OC::$server->getDatabaseConnection();
+        $config     = \OC::$server->getConfig();
+        $steps      = [
+            new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true),
+            new SqliteAutoincrement($connection),
+            new SaveAccountsTableData($connection, $config),
+            new DropAccountTermsTable($connection)
+        ];
+
+        return $steps;
+    }
+
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param array $arguments
+     */
+    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) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'info', array($string));
+    }
+
+    /**
+     * @param string $message
+     */
+    public function warning($message) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'warning', [$message]);
+    }
+
+    /**
+     * @param int $max
+     */
+    public function startProgress($max = 0) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
+    }
+
+    /**
+     * @param int $step
+     * @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]);
+    }
+
+    /**
+     * @param int $max
+     */
+    public function finishProgress() {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'finishProgress', []);
+    }
 }