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