Actions
5 years ago
Contracts
5 years ago
Controllers
5 years ago
Exceptions
5 years ago
MigrationsRegister.php
5 years ago
MigrationsRunner.php
5 years ago
MigrationsServiceProvider.php
5 years ago
MigrationsRunner.php
132 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\Migrations; |
| 4 | |
| 5 | use Exception; |
| 6 | use Give\Framework\Migrations\Contracts\Migration; |
| 7 | use Give_Notices; |
| 8 | |
| 9 | /** |
| 10 | * Class MigrationsRunner |
| 11 | * |
| 12 | * @since 2.9.0 |
| 13 | */ |
| 14 | class MigrationsRunner { |
| 15 | /** |
| 16 | * Option name for completed migrations |
| 17 | */ |
| 18 | const MIGRATION_OPTION = 'give_database_migrations'; |
| 19 | |
| 20 | /** |
| 21 | * List of completed migrations. |
| 22 | * |
| 23 | * @since 2.9.0 |
| 24 | * |
| 25 | * @var array |
| 26 | */ |
| 27 | private $completedMigrations; |
| 28 | |
| 29 | /** |
| 30 | * @since 2.9.0 |
| 31 | * |
| 32 | * @var MigrationsRegister |
| 33 | */ |
| 34 | private $migrationRegister; |
| 35 | |
| 36 | /** |
| 37 | * MigrationsRunner constructor. |
| 38 | * |
| 39 | * @param MigrationsRegister $migrationRegister |
| 40 | */ |
| 41 | public function __construct( MigrationsRegister $migrationRegister ) { |
| 42 | $this->migrationRegister = $migrationRegister; |
| 43 | |
| 44 | $this->completedMigrations = get_option( self::MIGRATION_OPTION, [] ); |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Run database migrations. |
| 49 | * |
| 50 | * @since 2.9.0 |
| 51 | */ |
| 52 | public function run() { |
| 53 | global $wpdb; |
| 54 | |
| 55 | if ( ! $this->hasMigrationToRun() ) { |
| 56 | return; |
| 57 | } |
| 58 | |
| 59 | // Store and sort migrations by timestamp |
| 60 | $migrations = []; |
| 61 | |
| 62 | foreach ( $this->migrationRegister->getMigrations() as $migrationClass ) { |
| 63 | /* @var Migration $migrationClass */ |
| 64 | $migrations[ $migrationClass::timestamp() . '_' . $migrationClass::id() ] = $migrationClass; |
| 65 | } |
| 66 | |
| 67 | ksort( $migrations ); |
| 68 | |
| 69 | // Process migrations. |
| 70 | $newMigrations = []; |
| 71 | |
| 72 | foreach ( $migrations as $migrationClass ) { |
| 73 | $migrationId = $migrationClass::id(); |
| 74 | |
| 75 | if ( in_array( $migrationId, $this->completedMigrations, true ) ) { |
| 76 | continue; |
| 77 | } |
| 78 | |
| 79 | // Begin transaction |
| 80 | $wpdb->query( 'START TRANSACTION' ); |
| 81 | |
| 82 | try { |
| 83 | /** @var Migration $migration */ |
| 84 | $migration = give( $migrationClass ); |
| 85 | |
| 86 | $migration->run(); |
| 87 | } catch ( Exception $exception ) { |
| 88 | $wpdb->query( 'ROLLBACK' ); |
| 89 | |
| 90 | give_record_log( 'Migration Failed', print_r( $exception, true ), 0, 'update' ); |
| 91 | give()->notices->register_notice( |
| 92 | [ |
| 93 | 'id' => 'migration-failure', |
| 94 | 'description' => sprintf( |
| 95 | '%1$s <a href="https://givewp.com/support/">https://givewp.com/support</a>', |
| 96 | esc_html__( 'There was a problem running the migrations. Please reach out to GiveWP support for assistance:', 'give' ) |
| 97 | ), |
| 98 | ] |
| 99 | ); |
| 100 | |
| 101 | break; |
| 102 | } |
| 103 | |
| 104 | // Commit transaction if successful |
| 105 | $wpdb->query( 'COMMIT' ); |
| 106 | |
| 107 | $newMigrations[] = $migrationId; |
| 108 | } |
| 109 | |
| 110 | // Save processed migrations. |
| 111 | $this->completedMigrations = array_unique( array_merge( $this->completedMigrations, $newMigrations ) ); |
| 112 | |
| 113 | if ( $newMigrations ) { |
| 114 | update_option( |
| 115 | self::MIGRATION_OPTION, |
| 116 | $this->completedMigrations |
| 117 | ); |
| 118 | } |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * Return whether or not all migrations completed. |
| 123 | * |
| 124 | * @since 2.9.0 |
| 125 | * |
| 126 | * @return bool |
| 127 | */ |
| 128 | public function hasMigrationToRun() { |
| 129 | return (bool) array_diff( $this->migrationRegister->getRegisteredIds(), $this->completedMigrations ); |
| 130 | } |
| 131 | } |
| 132 |