ManualMigration.php
154 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\Migrations\Controllers; |
| 4 | |
| 5 | use Exception; |
| 6 | use Give\Framework\Migrations\Actions\ClearCompletedUpgrade; |
| 7 | use Give\Framework\Migrations\Actions\ManuallyRunMigration; |
| 8 | use Give\Framework\Migrations\Contracts\Migration; |
| 9 | use Give\Framework\Migrations\MigrationsRegister; |
| 10 | |
| 11 | /** |
| 12 | * Class ManualMigration |
| 13 | * |
| 14 | * Handles and admin request to manually trigger migrations |
| 15 | * |
| 16 | * @since 2.9.2 |
| 17 | */ |
| 18 | class ManualMigration |
| 19 | { |
| 20 | /** |
| 21 | * @var MigrationsRegister |
| 22 | */ |
| 23 | private $migrationsRegister; |
| 24 | |
| 25 | /** |
| 26 | * ManualMigration constructor. |
| 27 | * |
| 28 | * @since 2.9.2 |
| 29 | * |
| 30 | * @param MigrationsRegister $migrationsRegister |
| 31 | * |
| 32 | */ |
| 33 | public function __construct(MigrationsRegister $migrationsRegister) |
| 34 | { |
| 35 | $this->migrationsRegister = $migrationsRegister; |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * @since 3.19.0 sanitize params |
| 40 | * @since 2.9.2 |
| 41 | */ |
| 42 | public function __invoke() |
| 43 | { |
| 44 | if ( ! empty($_GET['give-run-migration'])) { |
| 45 | $migrationToRun = give_clean($_GET['give-run-migration']); |
| 46 | } |
| 47 | |
| 48 | if ( ! empty($_GET['give-clear-update'])) { |
| 49 | $migrationToClear = give_clean($_GET['give-clear-update']); |
| 50 | } |
| 51 | |
| 52 | $hasMigration = isset($migrationToRun) || isset($migrationToClear); |
| 53 | |
| 54 | if ($hasMigration && ! current_user_can('manage_options')) { |
| 55 | give()->notices->register_notice( |
| 56 | [ |
| 57 | 'id' => 'invalid-migration-permissions', |
| 58 | 'description' => 'You do not have the permissions to manually run or clear migrations', |
| 59 | ] |
| 60 | ); |
| 61 | |
| 62 | return; |
| 63 | } |
| 64 | |
| 65 | if (isset($migrationToRun)) { |
| 66 | $this->runMigration($migrationToRun); |
| 67 | } |
| 68 | |
| 69 | if (isset($migrationToClear)) { |
| 70 | $this->clearMigration($migrationToClear); |
| 71 | } |
| 72 | } |
| 73 | |
| 74 | /** |
| 75 | * Runs the given automatic migration |
| 76 | * |
| 77 | * @since 2.9.2 |
| 78 | * |
| 79 | * @param string $migrationId |
| 80 | */ |
| 81 | private function runMigration($migrationId) |
| 82 | { |
| 83 | if ( ! $this->migrationsRegister->hasMigration($migrationId)) { |
| 84 | give()->notices->register_notice( |
| 85 | [ |
| 86 | 'id' => 'invalid-migration-id', |
| 87 | 'description' => "There is no migration with the ID: {$migrationId}", |
| 88 | ] |
| 89 | ); |
| 90 | |
| 91 | return; |
| 92 | } |
| 93 | |
| 94 | /** @var Migration $migration */ |
| 95 | $migration = give($this->migrationsRegister->getMigration($migrationId)); |
| 96 | |
| 97 | /** @var ManuallyRunMigration $manualRunner */ |
| 98 | $manualRunner = give(ManuallyRunMigration::class); |
| 99 | |
| 100 | try { |
| 101 | $manualRunner($migration); |
| 102 | |
| 103 | give()->notices->register_notice( |
| 104 | [ |
| 105 | 'id' => 'automatic-migration-run', |
| 106 | 'type' => 'success', |
| 107 | 'description' => "The {$migrationId} migration was manually triggered", |
| 108 | ] |
| 109 | ); |
| 110 | } catch (Exception $exception) { |
| 111 | give()->notices->register_notice( |
| 112 | [ |
| 113 | 'id' => 'automatic-migration-run-failure', |
| 114 | 'description' => "The manually triggered {$migrationId} migration ran but failed", |
| 115 | ] |
| 116 | ); |
| 117 | } |
| 118 | } |
| 119 | |
| 120 | /** |
| 121 | * Clears the manual migration so it may be run again |
| 122 | * |
| 123 | * @since 2.9.2 |
| 124 | * |
| 125 | * @param string $migrationToClear |
| 126 | */ |
| 127 | private function clearMigration($migrationToClear) |
| 128 | { |
| 129 | /** @var ClearCompletedUpgrade $clearUpgrade */ |
| 130 | $clearUpgrade = give(ClearCompletedUpgrade::class); |
| 131 | |
| 132 | try { |
| 133 | $clearUpgrade($migrationToClear); |
| 134 | } catch (Exception $exception) { |
| 135 | give()->notices->register_notice( |
| 136 | [ |
| 137 | 'id' => 'clear-migration-failed', |
| 138 | 'description' => "Unable to reset migration. Error: {$exception->getMessage()}", |
| 139 | ] |
| 140 | ); |
| 141 | |
| 142 | return; |
| 143 | } |
| 144 | |
| 145 | give()->notices->register_notice( |
| 146 | [ |
| 147 | 'id' => 'automatic-migration-cleared', |
| 148 | 'type' => 'success', |
| 149 | 'description' => "The {$migrationToClear} update was cleared and may be run again.", |
| 150 | ] |
| 151 | ); |
| 152 | } |
| 153 | } |
| 154 |