1
0

Repair.php 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. <?php
  2. /**
  3. * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
  4. * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
  5. * SPDX-License-Identifier: AGPL-3.0-only
  6. */
  7. namespace OC;
  8. use OC\DB\Connection;
  9. use OC\DB\ConnectionAdapter;
  10. use OC\Repair\AddAppConfigLazyMigration;
  11. use OC\Repair\AddBruteForceCleanupJob;
  12. use OC\Repair\AddCleanupUpdaterBackupsJob;
  13. use OC\Repair\AddMetadataGenerationJob;
  14. use OC\Repair\AddRemoveOldTasksBackgroundJob;
  15. use OC\Repair\CleanTags;
  16. use OC\Repair\CleanUpAbandonedApps;
  17. use OC\Repair\ClearFrontendCaches;
  18. use OC\Repair\ClearGeneratedAvatarCache;
  19. use OC\Repair\Collation;
  20. use OC\Repair\Events\RepairAdvanceEvent;
  21. use OC\Repair\Events\RepairErrorEvent;
  22. use OC\Repair\Events\RepairFinishEvent;
  23. use OC\Repair\Events\RepairInfoEvent;
  24. use OC\Repair\Events\RepairStartEvent;
  25. use OC\Repair\Events\RepairStepEvent;
  26. use OC\Repair\Events\RepairWarningEvent;
  27. use OC\Repair\MoveUpdaterStepFile;
  28. use OC\Repair\NC11\FixMountStorages;
  29. use OC\Repair\NC13\AddLogRotateJob;
  30. use OC\Repair\NC14\AddPreviewBackgroundCleanupJob;
  31. use OC\Repair\NC16\AddClenupLoginFlowV2BackgroundJob;
  32. use OC\Repair\NC16\CleanupCardDAVPhotoCache;
  33. use OC\Repair\NC16\ClearCollectionsAccessCache;
  34. use OC\Repair\NC18\ResetGeneratedAvatarFlag;
  35. use OC\Repair\NC20\EncryptionLegacyCipher;
  36. use OC\Repair\NC20\EncryptionMigration;
  37. use OC\Repair\NC20\ShippedDashboardEnable;
  38. use OC\Repair\NC21\AddCheckForUserCertificatesJob;
  39. use OC\Repair\NC21\ValidatePhoneNumber;
  40. use OC\Repair\NC22\LookupServerSendCheck;
  41. use OC\Repair\NC24\AddTokenCleanupJob;
  42. use OC\Repair\NC25\AddMissingSecretJob;
  43. use OC\Repair\OldGroupMembershipShares;
  44. use OC\Repair\Owncloud\CleanPreviews;
  45. use OC\Repair\Owncloud\DropAccountTermsTable;
  46. use OC\Repair\Owncloud\MigrateOauthTables;
  47. use OC\Repair\Owncloud\MoveAvatars;
  48. use OC\Repair\Owncloud\SaveAccountsTableData;
  49. use OC\Repair\Owncloud\UpdateLanguageCodes;
  50. use OC\Repair\RemoveLinkShares;
  51. use OC\Repair\RepairDavShares;
  52. use OC\Repair\RepairInvalidShares;
  53. use OC\Repair\RepairMimeTypes;
  54. use OC\Template\JSCombiner;
  55. use OCA\DAV\Migration\DeleteSchedulingObjects;
  56. use OCP\AppFramework\QueryException;
  57. use OCP\AppFramework\Utility\ITimeFactory;
  58. use OCP\Collaboration\Resources\IManager;
  59. use OCP\EventDispatcher\IEventDispatcher;
  60. use OCP\Migration\IOutput;
  61. use OCP\Migration\IRepairStep;
  62. use OCP\Notification\IManager as INotificationManager;
  63. use Psr\Log\LoggerInterface;
  64. use Throwable;
  65. class Repair implements IOutput {
  66. /** @var IRepairStep[] */
  67. private array $repairSteps = [];
  68. private string $currentStep;
  69. public function __construct(
  70. private IEventDispatcher $dispatcher,
  71. private LoggerInterface $logger
  72. ) {
  73. }
  74. /** @param IRepairStep[] $repairSteps */
  75. public function setRepairSteps(array $repairSteps): void {
  76. $this->repairSteps = $repairSteps;
  77. }
  78. /**
  79. * Run a series of repair steps for common problems
  80. */
  81. public function run() {
  82. if (count($this->repairSteps) === 0) {
  83. $this->dispatcher->dispatchTyped(new RepairInfoEvent('No repair steps available'));
  84. return;
  85. }
  86. // run each repair step
  87. foreach ($this->repairSteps as $step) {
  88. $this->currentStep = $step->getName();
  89. $this->dispatcher->dispatchTyped(new RepairStepEvent($this->currentStep));
  90. try {
  91. $step->run($this);
  92. } catch (\Exception $e) {
  93. $this->logger->error("Exception while executing repair step " . $step->getName(), ['exception' => $e]);
  94. $this->dispatcher->dispatchTyped(new RepairErrorEvent($e->getMessage()));
  95. }
  96. }
  97. $this->repairSteps = [];
  98. }
  99. /**
  100. * Add repair step
  101. *
  102. * @param IRepairStep|string $repairStep repair step
  103. * @throws \Exception
  104. */
  105. public function addStep($repairStep) {
  106. if (is_string($repairStep)) {
  107. try {
  108. $s = \OC::$server->get($repairStep);
  109. } catch (QueryException $e) {
  110. if (class_exists($repairStep)) {
  111. try {
  112. // Last resort: hope there are no constructor arguments
  113. $s = new $repairStep();
  114. } catch (Throwable $inner) {
  115. // Well, it was worth a try
  116. throw new \Exception("Repair step '$repairStep' can't be instantiated: " . $e->getMessage(), 0, $e);
  117. }
  118. } else {
  119. throw new \Exception("Repair step '$repairStep' is unknown", 0, $e);
  120. }
  121. }
  122. if ($s instanceof IRepairStep) {
  123. $this->repairSteps[] = $s;
  124. } else {
  125. throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
  126. }
  127. } else {
  128. $this->repairSteps[] = $repairStep;
  129. }
  130. }
  131. /**
  132. * Returns the default repair steps to be run on the
  133. * command line or after an upgrade.
  134. *
  135. * @return IRepairStep[]
  136. */
  137. public static function getRepairSteps(): array {
  138. return [
  139. new Collation(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class), \OC::$server->getDatabaseConnection(), false),
  140. new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
  141. new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
  142. new MoveUpdaterStepFile(\OC::$server->getConfig()),
  143. new MoveAvatars(
  144. \OC::$server->getJobList(),
  145. \OC::$server->getConfig()
  146. ),
  147. new CleanPreviews(
  148. \OC::$server->getJobList(),
  149. \OC::$server->getUserManager(),
  150. \OC::$server->getConfig()
  151. ),
  152. new MigrateOauthTables(\OC::$server->get(Connection::class)),
  153. new FixMountStorages(\OC::$server->getDatabaseConnection()),
  154. new UpdateLanguageCodes(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
  155. new AddLogRotateJob(\OC::$server->getJobList()),
  156. new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OCP\Server::get(JSCombiner::class)),
  157. \OCP\Server::get(ClearGeneratedAvatarCache::class),
  158. new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()),
  159. new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()),
  160. new CleanupCardDAVPhotoCache(\OC::$server->getConfig(), \OC::$server->getAppDataDir('dav-photocache'), \OC::$server->get(LoggerInterface::class)),
  161. new AddClenupLoginFlowV2BackgroundJob(\OC::$server->getJobList()),
  162. new RemoveLinkShares(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig(), \OC::$server->getGroupManager(), \OC::$server->get(INotificationManager::class), \OCP\Server::get(ITimeFactory::class)),
  163. new ClearCollectionsAccessCache(\OC::$server->getConfig(), \OCP\Server::get(IManager::class)),
  164. \OCP\Server::get(ResetGeneratedAvatarFlag::class),
  165. \OCP\Server::get(EncryptionLegacyCipher::class),
  166. \OCP\Server::get(EncryptionMigration::class),
  167. \OCP\Server::get(ShippedDashboardEnable::class),
  168. \OCP\Server::get(AddBruteForceCleanupJob::class),
  169. \OCP\Server::get(AddCheckForUserCertificatesJob::class),
  170. \OCP\Server::get(RepairDavShares::class),
  171. \OCP\Server::get(LookupServerSendCheck::class),
  172. \OCP\Server::get(AddTokenCleanupJob::class),
  173. \OCP\Server::get(CleanUpAbandonedApps::class),
  174. \OCP\Server::get(AddMissingSecretJob::class),
  175. \OCP\Server::get(AddRemoveOldTasksBackgroundJob::class),
  176. \OCP\Server::get(AddMetadataGenerationJob::class),
  177. \OCP\Server::get(AddAppConfigLazyMigration::class),
  178. ];
  179. }
  180. /**
  181. * Returns expensive repair steps to be run on the
  182. * command line with a special option.
  183. *
  184. * @return IRepairStep[]
  185. */
  186. public static function getExpensiveRepairSteps() {
  187. return [
  188. new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()),
  189. new RepairMimeTypes(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
  190. \OC::$server->get(ValidatePhoneNumber::class),
  191. \OC::$server->get(DeleteSchedulingObjects::class),
  192. ];
  193. }
  194. /**
  195. * Returns the repair steps to be run before an
  196. * upgrade.
  197. *
  198. * @return IRepairStep[]
  199. */
  200. public static function getBeforeUpgradeRepairSteps() {
  201. /** @var ConnectionAdapter $connectionAdapter */
  202. $connectionAdapter = \OC::$server->get(ConnectionAdapter::class);
  203. $config = \OC::$server->getConfig();
  204. $steps = [
  205. new Collation(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class), $connectionAdapter, true),
  206. new SaveAccountsTableData($connectionAdapter, $config),
  207. new DropAccountTermsTable($connectionAdapter),
  208. ];
  209. return $steps;
  210. }
  211. public function debug(string $message): void {
  212. }
  213. /**
  214. * @param string $message
  215. */
  216. public function info($message) {
  217. // for now just emit as we did in the past
  218. $this->dispatcher->dispatchTyped(new RepairInfoEvent($message));
  219. }
  220. /**
  221. * @param string $message
  222. */
  223. public function warning($message) {
  224. // for now just emit as we did in the past
  225. $this->dispatcher->dispatchTyped(new RepairWarningEvent($message));
  226. }
  227. /**
  228. * @param int $max
  229. */
  230. public function startProgress($max = 0) {
  231. // for now just emit as we did in the past
  232. $this->dispatcher->dispatchTyped(new RepairStartEvent($max, $this->currentStep));
  233. }
  234. /**
  235. * @param int $step number of step to advance
  236. * @param string $description
  237. */
  238. public function advance($step = 1, $description = '') {
  239. // for now just emit as we did in the past
  240. $this->dispatcher->dispatchTyped(new RepairAdvanceEvent($step, $description));
  241. }
  242. /**
  243. * @param int $max
  244. */
  245. public function finishProgress() {
  246. // for now just emit as we did in the past
  247. $this->dispatcher->dispatchTyped(new RepairFinishEvent());
  248. }
  249. }