1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
<?php
namespace Yoast\WP\SEO\Initializers;
use Exception;
use Yoast\WP\Lib\Migrations\Adapter;
use Yoast\WP\Lib\Migrations\Migration;
use Yoast\WP\SEO\Conditionals\No_Conditionals;
use Yoast\WP\SEO\Config\Migration_Status;
use Yoast\WP\SEO\Loader;
/**
* Triggers database migrations and handles results.
*/
class Migration_Runner implements Initializer_Interface {
use No_Conditionals;
/**
* The migrations adapter.
*
* @var Adapter
*/
protected $adapter;
/**
* The loader.
*
* @var Loader
*/
protected $loader;
/**
* The migration status.
*
* @var Migration_Status
*/
protected $migration_status;
/**
* Retrieves the conditionals for the migrations.
*
* @return array The conditionals.
*/
public static function get_conditionals() {
return [];
}
/**
* Migrations constructor.
*
* @param Migration_Status $migration_status The migration status.
* @param Loader $loader The loader.
* @param Adapter $adapter The migrations adapter.
*/
public function __construct(
Migration_Status $migration_status,
Loader $loader,
Adapter $adapter
) {
$this->migration_status = $migration_status;
$this->loader = $loader;
$this->adapter = $adapter;
}
/**
* Runs this initializer.
*
* @throws Exception When a migration errored.
*
* @return void
*/
public function initialize() {
$this->run_free_migrations();
// The below actions is used for when queries fail, this may happen in a multisite environment when switch_to_blog is used.
\add_action( '_yoast_run_migrations', [ $this, 'run_free_migrations' ] );
}
/**
* Runs the free migrations.
*
* @throws Exception When a migration errored.
*
* @return void
*/
public function run_free_migrations() {
$this->run_migrations( 'free' );
}
/**
* Initializes the migrations.
*
* @param string $name The name of the migration.
*
* @return bool True on success, false on failure.
*
* @throws Exception If the migration fails and YOAST_ENVIRONMENT is not production.
*/
public function run_migrations( $name ) {
if ( ! $this->migration_status->should_run_migration( $name ) ) {
return true;
}
if ( ! $this->migration_status->lock_migration( $name ) ) {
return false;
}
$migrations = $this->loader->get_migrations( $name );
if ( $migrations === false ) {
$this->migration_status->set_error( $name, "Could not perform $name migrations. No migrations found." );
return false;
}
try {
$this->adapter->create_schema_version_table();
$all_versions = \array_keys( $migrations );
$migrated_versions = $this->adapter->get_migrated_versions();
$to_do_versions = \array_diff( $all_versions, $migrated_versions );
\sort( $to_do_versions, \SORT_STRING );
foreach ( $to_do_versions as $version ) {
$class = $migrations[ $version ];
$this->run_migration( $version, $class );
}
} catch ( Exception $exception ) {
// Something went wrong...
$this->migration_status->set_error( $name, $exception->getMessage() );
if ( \defined( 'YOAST_ENVIRONMENT' ) && \YOAST_ENVIRONMENT !== 'production' ) {
throw $exception;
}
return false;
}
$this->migration_status->set_success( $name );
return true;
}
/**
* Runs a single migration.
*
* @param string $version The version.
* @param string $class The migration class.
*
* @return void
*
* @throws Exception If the migration failed. Caught by the run_migrations function.
*/
protected function run_migration( $version, $class ) {
/**
* The migration to run.
*
* @var Migration
*/
$migration = new $class( $this->adapter );
try {
$this->adapter->start_transaction();
$migration->up();
$this->adapter->add_version( $version );
$this->adapter->commit_transaction();
} catch ( Exception $e ) {
$this->adapter->rollback_transaction();
throw new Exception( \sprintf( '%s - %s', $class, $e->getMessage() ), 0, $e );
}
}
}
|