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

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

208 lines 6.8 KB

Raw Download Zip

1	<?php
2
3	namespace Give\API\Endpoints\Migrations;
4
5	use Give\Framework\Migrations\Contracts\BatchMigration;
6	use Give\Framework\Migrations\Contracts\Migration;
7	use Give\Framework\Migrations\Contracts\ReversibleMigration;
8	use Give\Framework\Migrations\MigrationsRegister;
9	use Give\MigrationLog\Helpers\MigrationHelper;
10	use Give\MigrationLog\MigrationLogRepository;
11	use Give\MigrationLog\MigrationLogStatus;
12	use WP_REST_Request;
13	use WP_REST_Response;
14
15	/**
16	* Class GetMigrations
17	* @package Give\API\Endpoints\Logs
18	*
19	* @since 2.10.0
20	*/
21	class GetMigrations extends Endpoint
22	{
23	/**
24	* Enable sorting by these columns
25	*/
26	const SORTABLE_COLUMNS = ['id', 'status', 'last_run', 'run_order', 'title', 'source'];
27
28	/** @var string */
29	protected $endpoint = 'migrations/get-migrations';
30
31	/**
32	* @var MigrationLogRepository
33	*/
34	private $migrationRepository;
35
36	/**
37	* @var MigrationHelper
38	*/
39	private $migrationHelper;
40
41	/**
42	* @var MigrationsRegister
43	*/
44	private $migrationRegister;
45
46	/**
47	* GetLogs constructor.
48	*
49	* @param MigrationLogRepository $repository
50	* @param MigrationHelper $migrationHelper
51	* @param MigrationsRegister $migrationRegister
52	*/
53	public function __construct(
54	MigrationLogRepository $repository,
55	MigrationHelper $migrationHelper,
56	MigrationsRegister $migrationRegister
57	) {
58	$this->migrationRepository = $repository;
59	$this->migrationHelper = $migrationHelper;
60	$this->migrationRegister = $migrationRegister;
61	}
62
63	/**
64	* @inheritDoc
65	*/
66	public function registerRoute()
67	{
68	register_rest_route(
69	'give-api/v2',
70	$this->endpoint,
71	[
72	[
73	'methods' => 'GET',
74	'callback' => [$this, 'handleRequest'],
75	'permission_callback' => [$this, 'permissionsCheck'],
76	'args' => [
77	'page' => [
78	'validate_callback' => function ($param) {
79	return filter_var($param, FILTER_VALIDATE_INT);
80	},
81	'default' => '1',
82	],
83	'sort' => [
84	'validate_callback' => function ($param) {
85	if (empty($param)) {
86	return true;
87	}
88
89	return in_array($param, self::SORTABLE_COLUMNS, true);
90	},
91	'default' => 'run_order',
92	],
93	'direction' => [
94	'validate_callback' => function ($param) {
95	if (empty($param)) {
96	return true;
97	}
98
99	return in_array(strtoupper($param), ['ASC', 'DESC'], true);
100	},
101	'default' => 'ASC',
102	],
103	],
104	],
105	'schema' => [$this, 'getSchema'],
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	'page' => [
121	'type' => 'integer',
122	'description' => esc_html__('Current page', 'give'),
123	],
124	'sort' => [
125	'type' => 'string',
126	'description' => esc_html__('Sort by column', 'give'),
127	],
128	'direction' => [
129	'type' => 'string',
130	'description' => esc_html__('Sort direction', 'give'),
131	],
132	],
133	];
134	}
135
136	/**
137	* @param WP_REST_Request $request
138	*
139	* @return WP_REST_Response
140	*/
141	public function handleRequest(WP_REST_Request $request)
142	{
143	$data = [];
144	$migrationsPerPage = 10;
145	$migrations = $this->migrationRepository->getMigrations();
146	$migrationsCount = count($this->migrationRegister->getRegisteredIds());
147	$pendingMigrations = $this->migrationHelper->getPendingMigrations();
148
149	foreach ($migrations as $migration) {
150	// Get only registered migrations
151	if ( ! $this->migrationRegister->hasMigration($migration->getId())) {
152	continue;
153	}
154
155	/* @var Migration $migrationClass */
156	$migrationClass = $this->migrationRegister->getMigration($migration->getId());
157
158	$data[] = [
159	'id' => $migration->getId(),
160	'status' => $migration->getStatus(),
161	'error' => $migration->getError(),
162	'last_run' => $migration->getLastRunDate(),
163	'run_order' => $this->migrationHelper->getRunOrderForMigration($migration->getId()),
164	'source' => $migrationClass::source(),
165	'title' => $migrationClass::title(),
166	'isBatchMigration' => is_subclass_of($migrationClass, BatchMigration::class),
167	'isReversible' => is_subclass_of($migrationClass, ReversibleMigration::class),
168	];
169	}
170
171	// Check for pending migrations
172	/* @var Migration $migration */
173	foreach ($pendingMigrations as $migration) {
174	$data[] = [
175	'id' => $migration::id(),
176	'status' => MigrationLogStatus::PENDING,
177	'error' => '',
178	'last_run' => '',
179	'run_order' => $this->migrationHelper->getRunOrderForMigration($migration::id()),
180	'source' => $migration::source(),
181	'title' => $migration::title(),
182	'isBatchMigration' => is_subclass_of($migration, BatchMigration::class)
183	];
184	}
185
186	// Sort migrations
187	$sortColumn = array_column($data, $request->get_param('sort'));
188	$sortDirection = ('DESC' === strtoupper($request->get_param('direction'))) ? SORT_DESC : SORT_ASC;
189
190	array_multisort($sortColumn, $sortDirection, $data);
191
192	// Pagination
193	$page = $request->get_param('page');
194	$offset = ($page - 1) * $migrationsPerPage;
195	$data = array_slice($data, $offset, $migrationsPerPage);
196
197	return new WP_REST_Response(
198	[
199	'status' => true,
200	'data' => $data,
201	'pages' => ceil($migrationsCount / $migrationsPerPage),
202	'showOptions' => 'enabled' === give_get_option('enable_database_updates'),
203	]
204	);
205	}
206
207	}
208