give / src / API / Endpoints / Migrations / RunMigration.php

RunMigration.php in GiveWP – Donation Plugin and Fundraising Platform 4.1.0, at src/API/Endpoints/Migrations/RunMigration.php

237 lines 6.7 KB

Raw Download Zip

1	<?php
2
3	namespace Give\API\Endpoints\Migrations;
4
5	use Exception;
6	use Give\Framework\Database\DB;
7	use Give\Framework\Migrations\Contracts\BatchMigration;
8	use Give\Framework\Migrations\Contracts\Migration;
9	use Give\Framework\Migrations\Controllers\BatchMigrationRunner;
10	use Give\Framework\Migrations\MigrationsRegister;
11	use Give\MigrationLog\MigrationLogFactory;
12	use Give\MigrationLog\MigrationLogStatus;
13	use WP_REST_Request;
14	use WP_REST_Response;
15
16	/**
17	* Class RunMigration
18	* @package Give\API\Endpoints\Migrations
19	*
20	* @since 4.0.0 run batch migrations
21	* @since 2.10.0
22	*/
23	class RunMigration extends Endpoint
24	{
25	/**
26	* @var MigrationsRegister
27	*/
28	private $migrationRegister;
29
30	/**
31	* @var MigrationLogFactory
32	*/
33	private $migrationLogFactory;
34
35	/**
36	* RunMigration constructor.
37	*
38	* @param MigrationsRegister $migrationsRegister
39	* @param MigrationLogFactory $migrationLogFactory
40	*/
41	public function __construct(
42	MigrationsRegister $migrationsRegister,
43	MigrationLogFactory $migrationLogFactory
44	) {
45	$this->migrationRegister = $migrationsRegister;
46	$this->migrationLogFactory = $migrationLogFactory;
47	}
48
49	/**
50	* @inheritDoc
51	*/
52	public function registerRoute()
53	{
54	register_rest_route(
55	'give-api/v2',
56	'migrations/run-migration',
57	[
58	[
59	'methods' => 'POST',
60	'callback' => [$this, 'runMigration'],
61	'permission_callback' => [$this, 'permissionsCheck'],
62	'args' => [
63	'id' => [
64	'type' => 'string',
65	'required' => true,
66	],
67	],
68	],
69	'schema' => [$this, 'getSchema'],
70	]
71	);
72
73	register_rest_route(
74	'give-api/v2',
75	'migrations/run-batch-migration',
76	[
77	[
78	'methods' => 'POST',
79	'callback' => [$this, 'runBatchMigration'],
80	'permission_callback' => [$this, 'permissionsCheck'],
81	'args' => [
82	'id' => [
83	'type' => 'string',
84	'required' => true,
85	],
86	],
87	],
88	]
89	);
90
91	register_rest_route(
92	'give-api/v2',
93	'migrations/reschedule-failed-actions',
94	[
95	[
96	'methods' => 'POST',
97	'callback' => [$this, 'rescheduleFailedActions'],
98	'permission_callback' => [$this, 'permissionsCheck'],
99	'args' => [
100	'id' => [
101	'type' => 'string',
102	'required' => true,
103	],
104	],
105	],
106	]
107	);
108	}
109
110	/**
111	* @return array
112	*/
113	public function getSchema()
114	{
115	return [
116	'$schema' => 'http://json-schema.org/draft-04/schema#',
117	'title' => 'logs',
118	'type' => 'object',
119	'properties' => [
120	'id' => [
121	'type' => 'string',
122	'description' => esc_html__('Migration ID', 'give'),
123	],
124	],
125	];
126	}
127
128	/**
129	* @param WP_REST_Request $request
130	*
131	* @return WP_REST_Response
132	*/
133	public function runMigration(WP_REST_Request $request): WP_REST_Response
134	{
135	$migrationId = $request->get_param('id');
136	$migrationLog = $this->migrationLogFactory->make($migrationId);
137
138	// Begin transaction
139	DB::beginTransaction();
140
141	try {
142	$migrationClass = $this->migrationRegister->getMigration($migrationId);
143	/**
144	* @var Migration $migration
145	*/
146	$migration = give($migrationClass);
147	$migration->run();
148	// Save migration status
149	$migrationLog->setStatus(MigrationLogStatus::SUCCESS);
150	$migrationLog->setError(null);
151	$migrationLog->save();
152
153	DB::commit();
154
155	return new WP_REST_Response(['status' => true]);
156	} catch (Exception $exception) {
157	DB::rollback();
158
159	$migrationLog->setStatus(MigrationLogStatus::FAILED);
160	$migrationLog->setError($exception);
161	$migrationLog->save();
162	}
163
164	return new WP_REST_Response(
165	[
166	'status' => false,
167	'message' => $exception->getMessage(),
168	]
169	);
170	}
171
172
173	/**
174	* Run batch migration
175	*
176	* @since 4.0.0
177	*/
178	public function runBatchMigration(WP_REST_Request $request): WP_REST_Response
179	{
180	$migrationId = $request->get_param('id');
181	$migrationClass = $this->migrationRegister->getMigration($migrationId);
182
183	if ( ! is_subclass_of($migrationClass, BatchMigration::class)) {
184	return new WP_REST_Response([
185	'status' => false,
186	'message' => 'Migration is not an instance of ' . BatchMigration::class,
187	]);
188	}
189
190	try {
191	// We are not running migration directly,
192	// we just have to set migration status to PENDING and Migration Runner will handle it
193	$migrationLog = $this->migrationLogFactory->make($migrationId);
194	$migrationLog->setStatus(MigrationLogStatus::PENDING);
195	$migrationLog->save();
196	} catch (Exception $e) {
197	return new WP_REST_Response([
198	'status' => false,
199	'message' => $e->getMessage(),
200	]);
201	}
202
203	return new WP_REST_Response(['status' => true]);
204	}
205
206	/**
207	* Reschedule failed actions
208	*
209	* @since 4.0.0
210	*/
211	public function rescheduleFailedActions(WP_REST_Request $request): WP_REST_Response
212	{
213	$migrationId = $request->get_param('id');
214	$migrationClass = $this->migrationRegister->getMigration($migrationId);
215	$migration = give($migrationClass);
216
217	if ( ! is_subclass_of($migration, BatchMigration::class)) {
218	return new WP_REST_Response([
219	'status' => false,
220	'message' => 'Migration is not an instance of ' . BatchMigration::class,
221	]);
222	}
223
224	try {
225	(new BatchMigrationRunner($migration))->rescheduleFailedActions();
226	} catch (Exception $e) {
227	return new WP_REST_Response([
228	'status' => false,
229	'message' => $e->getMessage(),
230	]);
231	}
232
233	return new WP_REST_Response(['status' => true]);
234	}
235
236	}
237