give / src / Framework / Migrations / Controllers / ManualMigration.php

ManualMigration.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/Framework/Migrations/Controllers/ManualMigration.php

155 lines 4.2 KB

Raw Download Zip

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