Repair.php 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Daniel Kesselberg <mail@danielkesselberg.de>
  8. * @author Georg Ehrke <oc.list@georgehrke.com>
  9. * @author Joas Schilling <coding@schilljs.com>
  10. * @author John Molakvoæ <skjnldsv@protonmail.com>
  11. * @author Julius Härtl <jus@bitgrid.net>
  12. * @author Lukas Reschke <lukas@statuscode.ch>
  13. * @author Michael Weimann <mail@michael-weimann.eu>
  14. * @author Morris Jobke <hey@morrisjobke.de>
  15. * @author Robin Appelman <robin@icewind.nl>
  16. * @author Roeland Jago Douma <roeland@famdouma.nl>
  17. * @author Thomas Müller <thomas.mueller@tmit.eu>
  18. * @author Vincent Petry <vincent@nextcloud.com>
  19. *
  20. * @license AGPL-3.0
  21. *
  22. * This code is free software: you can redistribute it and/or modify
  23. * it under the terms of the GNU Affero General Public License, version 3,
  24. * as published by the Free Software Foundation.
  25. *
  26. * This program is distributed in the hope that it will be useful,
  27. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  29. * GNU Affero General Public License for more details.
  30. *
  31. * You should have received a copy of the GNU Affero General Public License, version 3,
  32. * along with this program. If not, see <http://www.gnu.org/licenses/>
  33. *
  34. */
  35. namespace OC;
  36. use OC\Repair\AddRemoveOldTasksBackgroundJob;
  37. use OC\Repair\CleanUpAbandonedApps;
  38. use OCP\AppFramework\QueryException;
  39. use OCP\AppFramework\Utility\ITimeFactory;
  40. use OCP\Collaboration\Resources\IManager;
  41. use OCP\EventDispatcher\IEventDispatcher;
  42. use OCP\Migration\IOutput;
  43. use OCP\Migration\IRepairStep;
  44. use OC\DB\Connection;
  45. use OC\DB\ConnectionAdapter;
  46. use OC\Repair\AddBruteForceCleanupJob;
  47. use OC\Repair\AddCleanupUpdaterBackupsJob;
  48. use OC\Repair\CleanTags;
  49. use OC\Repair\ClearFrontendCaches;
  50. use OC\Repair\ClearGeneratedAvatarCache;
  51. use OC\Repair\Collation;
  52. use OC\Repair\Events\RepairAdvanceEvent;
  53. use OC\Repair\Events\RepairErrorEvent;
  54. use OC\Repair\Events\RepairFinishEvent;
  55. use OC\Repair\Events\RepairInfoEvent;
  56. use OC\Repair\Events\RepairStartEvent;
  57. use OC\Repair\Events\RepairStepEvent;
  58. use OC\Repair\Events\RepairWarningEvent;
  59. use OC\Repair\MoveUpdaterStepFile;
  60. use OC\Repair\NC11\FixMountStorages;
  61. use OC\Repair\NC13\AddLogRotateJob;
  62. use OC\Repair\NC14\AddPreviewBackgroundCleanupJob;
  63. use OC\Repair\NC16\AddClenupLoginFlowV2BackgroundJob;
  64. use OC\Repair\NC16\CleanupCardDAVPhotoCache;
  65. use OC\Repair\NC16\ClearCollectionsAccessCache;
  66. use OC\Repair\NC18\ResetGeneratedAvatarFlag;
  67. use OC\Repair\NC20\EncryptionLegacyCipher;
  68. use OC\Repair\NC20\EncryptionMigration;
  69. use OC\Repair\NC20\ShippedDashboardEnable;
  70. use OC\Repair\NC21\AddCheckForUserCertificatesJob;
  71. use OC\Repair\NC21\ValidatePhoneNumber;
  72. use OC\Repair\NC22\LookupServerSendCheck;
  73. use OC\Repair\NC24\AddTokenCleanupJob;
  74. use OC\Repair\NC25\AddMissingSecretJob;
  75. use OC\Repair\OldGroupMembershipShares;
  76. use OC\Repair\Owncloud\CleanPreviews;
  77. use OC\Repair\Owncloud\DropAccountTermsTable;
  78. use OC\Repair\Owncloud\MigrateOauthTables;
  79. use OC\Repair\Owncloud\MoveAvatars;
  80. use OC\Repair\Owncloud\SaveAccountsTableData;
  81. use OC\Repair\Owncloud\UpdateLanguageCodes;
  82. use OC\Repair\RemoveLinkShares;
  83. use OC\Repair\RepairDavShares;
  84. use OC\Repair\RepairInvalidShares;
  85. use OC\Repair\RepairMimeTypes;
  86. use OC\Repair\SqliteAutoincrement;
  87. use OC\Template\JSCombiner;
  88. use Psr\Log\LoggerInterface;
  89. use Throwable;
  90. class Repair implements IOutput {
  91. /** @var IRepairStep[] */
  92. private array $repairSteps;
  93. private IEventDispatcher $dispatcher;
  94. private string $currentStep;
  95. private LoggerInterface $logger;
  96. /**
  97. * Creates a new repair step runner
  98. *
  99. * @param IRepairStep[] $repairSteps array of RepairStep instances
  100. */
  101. public function __construct(array $repairSteps, IEventDispatcher $dispatcher, LoggerInterface $logger) {
  102. $this->repairSteps = $repairSteps;
  103. $this->dispatcher = $dispatcher;
  104. $this->logger = $logger;
  105. }
  106. /**
  107. * Run a series of repair steps for common problems
  108. */
  109. public function run() {
  110. if (count($this->repairSteps) === 0) {
  111. $this->dispatcher->dispatchTyped(new RepairInfoEvent('No repair steps available'));
  112. return;
  113. }
  114. // run each repair step
  115. foreach ($this->repairSteps as $step) {
  116. $this->currentStep = $step->getName();
  117. $this->dispatcher->dispatchTyped(new RepairStepEvent($this->currentStep));
  118. try {
  119. $step->run($this);
  120. } catch (\Exception $e) {
  121. $this->logger->error("Exception while executing repair step " . $step->getName(), ['exception' => $e]);
  122. $this->dispatcher->dispatchTyped(new RepairErrorEvent($e->getMessage()));
  123. }
  124. }
  125. }
  126. /**
  127. * Add repair step
  128. *
  129. * @param IRepairStep|string $repairStep repair step
  130. * @throws \Exception
  131. */
  132. public function addStep($repairStep) {
  133. if (is_string($repairStep)) {
  134. try {
  135. $s = \OC::$server->get($repairStep);
  136. } catch (QueryException $e) {
  137. if (class_exists($repairStep)) {
  138. try {
  139. // Last resort: hope there are no constructor arguments
  140. $s = new $repairStep();
  141. } catch (Throwable $inner) {
  142. // Well, it was worth a try
  143. throw new \Exception("Repair step '$repairStep' can't be instantiated: " . $e->getMessage(), 0, $e);
  144. }
  145. } else {
  146. throw new \Exception("Repair step '$repairStep' is unknown", 0, $e);
  147. }
  148. }
  149. if ($s instanceof IRepairStep) {
  150. $this->repairSteps[] = $s;
  151. } else {
  152. throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
  153. }
  154. } else {
  155. $this->repairSteps[] = $repairStep;
  156. }
  157. }
  158. /**
  159. * Returns the default repair steps to be run on the
  160. * command line or after an upgrade.
  161. *
  162. * @return IRepairStep[]
  163. */
  164. public static function getRepairSteps(): array {
  165. return [
  166. new Collation(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class), \OC::$server->getDatabaseConnection(), false),
  167. new RepairMimeTypes(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
  168. new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
  169. new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
  170. new MoveUpdaterStepFile(\OC::$server->getConfig()),
  171. new MoveAvatars(
  172. \OC::$server->getJobList(),
  173. \OC::$server->getConfig()
  174. ),
  175. new CleanPreviews(
  176. \OC::$server->getJobList(),
  177. \OC::$server->getUserManager(),
  178. \OC::$server->getConfig()
  179. ),
  180. new MigrateOauthTables(\OC::$server->get(Connection::class)),
  181. new FixMountStorages(\OC::$server->getDatabaseConnection()),
  182. new UpdateLanguageCodes(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
  183. new AddLogRotateJob(\OC::$server->getJobList()),
  184. new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OCP\Server::get(JSCombiner::class)),
  185. \OCP\Server::get(ClearGeneratedAvatarCache::class),
  186. new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()),
  187. new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()),
  188. new CleanupCardDAVPhotoCache(\OC::$server->getConfig(), \OC::$server->getAppDataDir('dav-photocache'), \OC::$server->get(LoggerInterface::class)),
  189. new AddClenupLoginFlowV2BackgroundJob(\OC::$server->getJobList()),
  190. new RemoveLinkShares(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig(), \OC::$server->getGroupManager(), \OC::$server->getNotificationManager(), \OCP\Server::get(ITimeFactory::class)),
  191. new ClearCollectionsAccessCache(\OC::$server->getConfig(), \OCP\Server::get(IManager::class)),
  192. \OCP\Server::get(ResetGeneratedAvatarFlag::class),
  193. \OCP\Server::get(EncryptionLegacyCipher::class),
  194. \OCP\Server::get(EncryptionMigration::class),
  195. \OCP\Server::get(ShippedDashboardEnable::class),
  196. \OCP\Server::get(AddBruteForceCleanupJob::class),
  197. \OCP\Server::get(AddCheckForUserCertificatesJob::class),
  198. \OCP\Server::get(RepairDavShares::class),
  199. \OCP\Server::get(LookupServerSendCheck::class),
  200. \OCP\Server::get(AddTokenCleanupJob::class),
  201. \OCP\Server::get(CleanUpAbandonedApps::class),
  202. \OCP\Server::get(AddMissingSecretJob::class),
  203. \OCP\Server::get(AddRemoveOldTasksBackgroundJob::class),
  204. ];
  205. }
  206. /**
  207. * Returns expensive repair steps to be run on the
  208. * command line with a special option.
  209. *
  210. * @return IRepairStep[]
  211. */
  212. public static function getExpensiveRepairSteps() {
  213. return [
  214. new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()),
  215. \OC::$server->get(ValidatePhoneNumber::class),
  216. ];
  217. }
  218. /**
  219. * Returns the repair steps to be run before an
  220. * upgrade.
  221. *
  222. * @return IRepairStep[]
  223. */
  224. public static function getBeforeUpgradeRepairSteps() {
  225. /** @var Connection $connection */
  226. $connection = \OC::$server->get(Connection::class);
  227. /** @var ConnectionAdapter $connectionAdapter */
  228. $connectionAdapter = \OC::$server->get(ConnectionAdapter::class);
  229. $config = \OC::$server->getConfig();
  230. $steps = [
  231. new Collation(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class), $connectionAdapter, true),
  232. new SqliteAutoincrement($connection),
  233. new SaveAccountsTableData($connectionAdapter, $config),
  234. new DropAccountTermsTable($connectionAdapter),
  235. ];
  236. return $steps;
  237. }
  238. /**
  239. * @param string $message
  240. */
  241. public function info($message) {
  242. // for now just emit as we did in the past
  243. $this->dispatcher->dispatchTyped(new RepairInfoEvent($message));
  244. }
  245. /**
  246. * @param string $message
  247. */
  248. public function warning($message) {
  249. // for now just emit as we did in the past
  250. $this->dispatcher->dispatchTyped(new RepairWarningEvent($message));
  251. }
  252. /**
  253. * @param int $max
  254. */
  255. public function startProgress($max = 0) {
  256. // for now just emit as we did in the past
  257. $this->dispatcher->dispatchTyped(new RepairStartEvent($max, $this->currentStep));
  258. }
  259. /**
  260. * @param int $step number of step to advance
  261. * @param string $description
  262. */
  263. public function advance($step = 1, $description = '') {
  264. // for now just emit as we did in the past
  265. $this->dispatcher->dispatchTyped(new RepairAdvanceEvent($step, $description));
  266. }
  267. /**
  268. * @param int $max
  269. */
  270. public function finishProgress() {
  271. // for now just emit as we did in the past
  272. $this->dispatcher->dispatchTyped(new RepairFinishEvent());
  273. }
  274. }