← All changes
|
modules/global-classes/global-classes-rest-api.php
+242
-64
4.0.9
→
4.1.0-beta1
View file →
| @@ -1,12 +1,14 @@ | ||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | namespace Elementor\Modules\GlobalClasses; |
| 4 | 4 | |
| 5 | -use Elementor\Modules\GlobalClasses\Usage\Applied_Global_Classes_Usage; | |
| 5 | +use Elementor\Core\Kits\Documents\Kit; | |
| 6 | 6 | use Elementor\Core\Utils\Api\Error_Builder; |
| 7 | 7 | use Elementor\Core\Utils\Api\Response_Builder; |
| 8 | 8 | use Elementor\Modules\GlobalClasses\Database\Migrations\Add_Capabilities; |
| 9 | +use Elementor\Modules\GlobalClasses\Usage\Applied_Global_Classes_Usage; | |
| 10 | +use Elementor\Plugin; | |
| 9 | 11 | |
| 10 | 12 | if ( ! defined( 'ABSPATH' ) ) { |
| 11 | 13 | exit; // Exit if accessed directly. |
| 12 | 14 | } |
| @@ -14,26 +16,55 @@ | ||
| 14 | 16 | class Global_Classes_REST_API { |
| 15 | 17 | const API_NAMESPACE = 'elementor/v1'; |
| 16 | 18 | const API_BASE = 'global-classes'; |
| 17 | 19 | const API_BASE_USAGE = self::API_BASE . '/usage'; |
| 18 | - const MAX_ITEMS = 100; | |
| 20 | + const API_BASE_POST = self::API_BASE . '/post'; | |
| 21 | + const API_BASE_STYLES = self::API_BASE . '/styles'; | |
| 22 | + const MAX_ITEMS = 1000; | |
| 19 | 23 | const LABEL_PREFIX = 'DUP_'; |
| 20 | 24 | const MAX_LABEL_LENGTH = 50; |
| 21 | - private $repository = null; | |
| 25 | + private ?Global_Classes_Repository $repository = null; | |
| 26 | + private ?Global_Classes_Relations $relations = null; | |
| 27 | + private ?Kit $kit = null; | |
| 22 | 28 | |
| 23 | 29 | public function register_hooks() { |
| 24 | 30 | add_action( 'rest_api_init', fn() => $this->register_routes() ); |
| 25 | 31 | } |
| 26 | 32 | |
| 33 | + public function invalidate_cache() { | |
| 34 | + $this->kit = null; | |
| 35 | + $this->repository = null; | |
| 36 | + $this->relations = null; | |
| 37 | + } | |
| 38 | + | |
| 39 | + private function get_kit(): ?Kit { | |
| 40 | + if ( ! $this->kit ) { | |
| 41 | + $this->kit = Plugin::$instance->kits_manager->get_active_kit(); | |
| 42 | + } | |
| 43 | + | |
| 44 | + return $this->kit; | |
| 45 | + } | |
| 46 | + | |
| 27 | 47 | private function get_repository() { |
| 28 | 48 | if ( ! $this->repository ) { |
| 29 | - $this->repository = new Global_Classes_Repository(); | |
| 49 | + $this->repository = new Global_Classes_Repository( $this->get_kit() ); | |
| 30 | 50 | } |
| 31 | 51 | |
| 32 | 52 | return $this->repository; |
| 33 | 53 | } |
| 34 | 54 | |
| 55 | + private function get_classes_relations(): Global_Classes_Relations { | |
| 56 | + if ( ! $this->relations ) { | |
| 57 | + $this->relations = new Global_Classes_Relations(); | |
| 58 | + } | |
| 59 | + | |
| 60 | + return $this->relations; | |
| 61 | + } | |
| 62 | + | |
| 35 | 63 | private function register_routes() { |
| 64 | + // cache invalidation at this point is solely for tests, in particular - Test_Global_Classes_Rest_Api | |
| 65 | + $this->invalidate_cache(); | |
| 66 | + | |
| 36 | 67 | register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE, [ |
| 37 | 68 | [ |
| 38 | 69 | 'methods' => 'GET', |
| 39 | 70 | 'callback' => fn( $request ) => $this->route_wrapper( fn() => $this->all( $request ) ), |
| @@ -51,10 +82,58 @@ | ||
| 51 | 82 | ], |
| 52 | 83 | ], |
| 53 | 84 | ] ); |
| 54 | 85 | |
| 86 | + register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE_POST, [ | |
| 87 | + [ | |
| 88 | + 'methods' => 'GET', | |
| 89 | + 'callback' => fn( $request ) => $this->route_wrapper( fn() => $this->styles_for_post( $request ) ), | |
| 90 | + 'permission_callback' => fn() => is_user_logged_in(), | |
| 91 | + 'args' => [ | |
| 92 | + 'context' => [ | |
| 93 | + 'type' => 'string', | |
| 94 | + 'required' => false, | |
| 95 | + 'default' => Global_Classes_Repository::CONTEXT_FRONTEND, | |
| 96 | + 'enum' => [ | |
| 97 | + Global_Classes_Repository::CONTEXT_FRONTEND, | |
| 98 | + Global_Classes_Repository::CONTEXT_PREVIEW, | |
| 99 | + ], | |
| 100 | + ], | |
| 101 | + 'post_id' => [ | |
| 102 | + 'type' => 'integer', | |
| 103 | + 'required' => true, | |
| 104 | + ], | |
| 105 | + ], | |
| 106 | + ], | |
| 107 | + ] ); | |
| 108 | + | |
| 109 | + register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE_STYLES, [ | |
| 110 | + [ | |
| 111 | + 'methods' => 'GET', | |
| 112 | + 'callback' => fn( $request ) => $this->route_wrapper( fn() => $this->styles_by_ids( $request ) ), | |
| 113 | + 'permission_callback' => fn() => is_user_logged_in(), | |
| 114 | + 'args' => [ | |
| 115 | + 'context' => [ | |
| 116 | + 'type' => 'string', | |
| 117 | + 'required' => false, | |
| 118 | + 'default' => Global_Classes_Repository::CONTEXT_FRONTEND, | |
| 119 | + 'enum' => [ | |
| 120 | + Global_Classes_Repository::CONTEXT_FRONTEND, | |
| 121 | + Global_Classes_Repository::CONTEXT_PREVIEW, | |
| 122 | + ], | |
| 123 | + ], | |
| 124 | + 'ids' => [ | |
| 125 | + 'type' => 'string', | |
| 126 | + 'required' => true, | |
| 127 | + 'description' => 'Comma-separated list of global class IDs', | |
| 128 | + ], | |
| 129 | + ], | |
| 130 | + ], | |
| 131 | + ] ); | |
| 132 | + | |
| 55 | 133 | register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE_USAGE, [ |
| 56 | 134 | [ |
| 135 | + 'methods' => 'GET', | |
| 57 | 136 | 'callback' => fn() => $this->route_wrapper( fn() => $this->get_usage() ), |
| 58 | 137 | 'permission_callback' => fn() => current_user_can( 'manage_options' ), |
| 59 | 138 | 'args' => [ |
| 60 | 139 | 'context' => [ |
| @@ -104,8 +183,12 @@ | ||
| 104 | 183 | 'type' => 'array', |
| 105 | 184 | 'required' => true, |
| 106 | 185 | 'items' => [ 'type' => 'string' ], |
| 107 | 186 | ], |
| 187 | + 'order' => [ | |
| 188 | + 'type' => 'boolean', | |
| 189 | + 'required' => false, | |
| 190 | + ], | |
| 108 | 191 | ], |
| 109 | 192 | ], |
| 110 | 193 | 'items' => [ |
| 111 | 194 | 'required' => true, |
| @@ -146,16 +229,77 @@ | ||
| 146 | 229 | } |
| 147 | 230 | |
| 148 | 231 | private function all( \WP_REST_Request $request ) { |
| 149 | 232 | $context = $request->get_param( 'context' ); |
| 233 | + $is_preview = Global_Classes_Repository::CONTEXT_PREVIEW === $context; | |
| 234 | + $label_by_id = $this->get_repository()->set_preview( $is_preview )->all_labels(); | |
| 235 | + $list = []; | |
| 150 | 236 | |
| 151 | - $classes = $this->get_repository()->context( $context )->all(); | |
| 237 | + foreach ( $label_by_id as $id => $label ) { | |
| 238 | + $list[] = [ | |
| 239 | + 'id' => $id, | |
| 240 | + 'label' => $label, | |
| 241 | + ]; | |
| 242 | + } | |
| 152 | 243 | |
| 153 | - return Response_Builder::make( (object) $classes->get_items()->all() ) | |
| 154 | - ->set_meta( [ 'order' => $classes->get_order()->all() ] ) | |
| 244 | + return Response_Builder::make( $list )->build(); | |
| 245 | + } | |
| 246 | + | |
| 247 | + private function styles_for_post( \WP_REST_Request $request ) { | |
| 248 | + $context = $request->get_param( 'context' ); | |
| 249 | + $is_preview = Global_Classes_Repository::CONTEXT_PREVIEW === $context; | |
| 250 | + $post_id = (int) $request->get_param( 'post_id' ); | |
| 251 | + | |
| 252 | + $document_class_ids = $this->get_classes_relations()->set_preview( $is_preview )->get_styles_by_post( $post_id ); | |
| 253 | + | |
| 254 | + if ( empty( $document_class_ids ) ) { | |
| 255 | + return Response_Builder::make( (object) [] )->set_meta( [ 'order' => [] ] )->build(); | |
| 256 | + } | |
| 257 | + | |
| 258 | + $repository = $this->get_repository()->set_preview( $is_preview ); | |
| 259 | + $global_order = array_keys( $repository->all_labels() ); | |
| 260 | + $filtered_order = array_values( array_intersect( $global_order, $document_class_ids ) ); | |
| 261 | + $items = $repository->get_by_ids( $document_class_ids ); | |
| 262 | + | |
| 263 | + $result = []; | |
| 264 | + | |
| 265 | + foreach ( $document_class_ids as $id ) { | |
| 266 | + $result[ $id ] = $items[ $id ] ?? null; | |
| 267 | + } | |
| 268 | + | |
| 269 | + return Response_Builder::make( (object) $result ) | |
| 270 | + ->set_meta( [ 'order' => $filtered_order ] ) | |
| 155 | 271 | ->build(); |
| 156 | 272 | } |
| 157 | 273 | |
| 274 | + private function styles_by_ids( \WP_REST_Request $request ) { | |
| 275 | + $context = $request->get_param( 'context' ); | |
| 276 | + $is_preview = Global_Classes_Repository::CONTEXT_PREVIEW === $context; | |
| 277 | + $ids_param = $request->get_param( 'ids' ); | |
| 278 | + | |
| 279 | + $requested_ids = array_map( 'trim', explode( ',', $ids_param ) ); | |
| 280 | + $requested_ids = array_filter( $requested_ids ); | |
| 281 | + | |
| 282 | + if ( empty( $requested_ids ) ) { | |
| 283 | + return Response_Builder::make( (object) [] )->set_meta( [ 'order' => [] ] )->build(); | |
| 284 | + } | |
| 285 | + | |
| 286 | + $repository = $this->get_repository()->set_preview( $is_preview ); | |
| 287 | + $global_order = array_keys( $repository->all_labels() ); | |
| 288 | + $filtered_order = array_values( array_intersect( $global_order, $requested_ids ) ); | |
| 289 | + $items = $repository->get_by_ids( $requested_ids ); | |
| 290 | + | |
| 291 | + $result = []; | |
| 292 | + | |
| 293 | + foreach ( $requested_ids as $id ) { | |
| 294 | + $result[ $id ] = $items[ $id ] ?? null; | |
| 295 | + } | |
| 296 | + | |
| 297 | + return Response_Builder::make( (object) $result ) | |
| 298 | + ->set_meta( [ 'order' => $filtered_order ] ) | |
| 299 | + ->build(); | |
| 300 | + } | |
| 301 | + | |
| 158 | 302 | private function get_usage() { |
| 159 | 303 | $classes_usage = ( new Applied_Global_Classes_Usage() )->get_detailed_usage(); |
| 160 | 304 | |
| 161 | 305 | return Response_Builder::make( (object) $classes_usage )->build(); |
| @@ -162,53 +306,68 @@ | ||
| 162 | 306 | } |
| 163 | 307 | |
| 164 | 308 | private function put( \WP_REST_Request $request ) { |
| 165 | 309 | $context = $request->get_param( 'context' ); |
| 310 | + $is_preview = Global_Classes_Repository::CONTEXT_PREVIEW === $context; | |
| 166 | 311 | $changes = $request->get_param( 'changes' ) ?? []; |
| 167 | - $new_added_items_ids = $changes['added'] ?? []; | |
| 312 | + $added_ids = $changes['added'] ?? []; | |
| 313 | + $deleted_ids = $changes['deleted'] ?? []; | |
| 314 | + $order = $request->get_param( 'order' ) ?? []; | |
| 315 | + | |
| 316 | + $repository = $this->get_repository()->set_preview( $is_preview ); | |
| 317 | + $all_label_by_id = $repository->all_labels(); | |
| 318 | + $existing_label_list = $this->global_classes_existing_label_list( $all_label_by_id, $deleted_ids ); | |
| 319 | + $total_count = count( $all_label_by_id ) - count( $deleted_ids ) + count( $added_ids ); | |
| 320 | + | |
| 168 | 321 | $parser = Global_Classes_Parser::make(); |
| 169 | - $existing_labels = Global_Classes_Repository::make() | |
| 170 | - ->context( $context ) | |
| 171 | - ->all() | |
| 172 | - ->get_items() | |
| 173 | - ->map( function ( $item ) { | |
| 174 | - return $item['label']; | |
| 175 | - } ) | |
| 176 | - ->all(); | |
| 322 | + $items_result = $parser->parse_items( $request->get_param( 'items' ) ?? [] ); | |
| 177 | 323 | |
| 178 | - $items_result = $parser->parse_items( | |
| 179 | - $request->get_param( 'items' ) | |
| 180 | - ); | |
| 324 | + if ( ! $items_result->is_valid() ) { | |
| 325 | + return Error_Builder::make( 'invalid_items' ) | |
| 326 | + ->set_status( 400 ) | |
| 327 | + ->set_message( 'Invalid items: ' . $items_result->errors()->to_string() ) | |
| 328 | + ->build(); | |
| 329 | + } | |
| 181 | 330 | |
| 182 | - $items_count = count( $items_result->unwrap() ); | |
| 331 | + $touched_items = $items_result->unwrap(); | |
| 183 | 332 | |
| 184 | - if ( $items_count > self::MAX_ITEMS ) { | |
| 333 | + if ( $total_count > self::MAX_ITEMS ) { | |
| 185 | 334 | return Error_Builder::make( 'global_classes_limit_exceeded' ) |
| 186 | 335 | ->set_status( 400 ) |
| 187 | - ->set_meta([ | |
| 188 | - 'current_count' => $items_count, | |
| 336 | + ->set_meta( [ | |
| 337 | + 'current_count' => $total_count, | |
| 189 | 338 | 'max_allowed' => self::MAX_ITEMS, |
| 190 | - ]) | |
| 191 | - ->set_message(sprintf( | |
| 339 | + ] ) | |
| 340 | + ->set_message( sprintf( | |
| 192 | 341 | /* translators: %d: Maximum allowed items. */ |
| 193 | 342 | __( 'Global classes limit exceeded. Maximum allowed: %d', 'elementor' ), |
| 194 | 343 | self::MAX_ITEMS |
| 195 | - )) | |
| 344 | + ) ) | |
| 196 | 345 | ->build(); |
| 197 | 346 | } |
| 198 | 347 | |
| 199 | - if ( ! $items_result->is_valid() ) { | |
| 200 | - return Error_Builder::make( 'invalid_items' ) | |
| 201 | - ->set_status( 400 ) | |
| 202 | - ->set_message( 'Invalid items: ' . $items_result->errors()->to_string() ) | |
| 203 | - ->build(); | |
| 348 | + $duplicated_labels = Global_Classes_Parser::check_for_duplicate_labels( | |
| 349 | + $all_label_by_id, | |
| 350 | + $deleted_ids, | |
| 351 | + $touched_items, | |
| 352 | + $added_ids | |
| 353 | + ); | |
| 354 | + | |
| 355 | + $duplicate_validation_result = null; | |
| 356 | + | |
| 357 | + if ( ! empty( $duplicated_labels ) ) { | |
| 358 | + $modified_labels = $this->handle_duplicates( $duplicated_labels, $existing_label_list ); | |
| 359 | + $duplicate_validation_result = $modified_labels; | |
| 360 | + | |
| 361 | + foreach ( $modified_labels as $item_id => $labels ) { | |
| 362 | + $touched_items[ $item_id ]['label'] = $labels['modified']; | |
| 363 | + } | |
| 204 | 364 | } |
| 205 | 365 | |
| 206 | - $order_result = $parser->parse_order( | |
| 207 | - $request->get_param( 'order' ), | |
| 208 | - $items_result->unwrap() | |
| 209 | - ); | |
| 366 | + $final_item_ids = array_keys( $this->merge_touched_with_existing_labels( $all_label_by_id, $touched_items, $deleted_ids ) ); | |
| 210 | 367 | |
| 368 | + $order_result = $parser->parse_order( $order, $final_item_ids ); | |
| 369 | + | |
| 211 | 370 | if ( ! $order_result->is_valid() ) { |
| 212 | 371 | return Error_Builder::make( 'invalid_order' ) |
| 213 | 372 | ->set_status( 400 ) |
| 214 | 373 | ->set_message( 'Invalid order: ' . $order_result->errors()->to_string() ) |
| @@ -214,47 +373,66 @@ | ||
| 214 | 373 | ->set_message( 'Invalid order: ' . $order_result->errors()->to_string() ) |
| 215 | 374 | ->build(); |
| 216 | 375 | } |
| 217 | 376 | |
| 218 | - $repository = $this->get_repository() | |
| 219 | - ->context( $request->get_param( 'context' ) ); | |
| 377 | + $repository->apply_changes( $touched_items, [ | |
| 378 | + 'added' => $added_ids, | |
| 379 | + 'deleted' => $changes['deleted'] ?? [], | |
| 380 | + 'modified' => $changes['modified'] ?? [], | |
| 381 | + 'order' => isset( $changes['order'] ) && $changes['order'], // boolean indicating if the order has changed | |
| 382 | + ], $order_result->unwrap() ); | |
| 220 | 383 | |
| 221 | - $changes_resolver = Global_Classes_Changes_Resolver::make( | |
| 222 | - $repository, | |
| 223 | - $changes, | |
| 224 | - ); | |
| 384 | + if ( $duplicate_validation_result ) { | |
| 385 | + return Response_Builder::make( [ | |
| 386 | + 'code' => 'DUPLICATED_LABEL', | |
| 387 | + 'modifiedLabels' => $duplicate_validation_result, | |
| 388 | + ] )->build(); | |
| 389 | + } | |
| 225 | 390 | |
| 226 | - $duplicated_labels = Global_Classes_Parser::check_for_duplicate_labels( | |
| 227 | - $existing_labels, | |
| 228 | - $items_result->unwrap(), | |
| 229 | - $new_added_items_ids | |
| 230 | - ); | |
| 391 | + return Response_Builder::make()->no_content()->build(); | |
| 392 | + } | |
| 231 | 393 | |
| 232 | - $final_items = $items_result->unwrap(); | |
| 233 | - $duplicate_validation_result = null; | |
| 394 | + private function global_classes_existing_label_list( array $label_by_id, array $deleted_ids ): array { | |
| 395 | + $labels = []; | |
| 234 | 396 | |
| 235 | - if ( ! empty( $duplicated_labels ) ) { | |
| 236 | - $modified_labels = $this->handle_duplicates( $duplicated_labels, $existing_labels ); | |
| 237 | - $duplicate_validation_result = $modified_labels; | |
| 238 | - foreach ( $modified_labels as $item_id => $labels ) { | |
| 239 | - $final_items[ $item_id ]['label'] = $labels['modified']; | |
| 397 | + foreach ( $label_by_id as $id => $label ) { | |
| 398 | + if ( in_array( $id, $deleted_ids, true ) ) { | |
| 399 | + continue; | |
| 240 | 400 | } |
| 401 | + | |
| 402 | + $labels[] = $label; | |
| 241 | 403 | } |
| 242 | 404 | |
| 243 | - $repository->put( | |
| 244 | - $changes_resolver->resolve_items( $final_items ), | |
| 245 | - $changes_resolver->resolve_order( $order_result->unwrap() ), | |
| 246 | - ); | |
| 405 | + return $labels; | |
| 406 | + } | |
| 247 | 407 | |
| 248 | - if ( $duplicate_validation_result ) { | |
| 249 | - $response_data = [ | |
| 250 | - 'code' => 'DUPLICATED_LABEL', | |
| 251 | - 'modifiedLabels' => $duplicate_validation_result, | |
| 252 | - ]; | |
| 253 | - return Response_Builder::make( $response_data )->build(); | |
| 408 | + private function merge_touched_with_existing_labels( array $label_by_id, array $touched_items, array $deleted_ids ): array { | |
| 409 | + $final = []; | |
| 410 | + | |
| 411 | + foreach ( $label_by_id as $id => $label ) { | |
| 412 | + if ( in_array( $id, $deleted_ids, true ) ) { | |
| 413 | + continue; | |
| 414 | + } | |
| 415 | + | |
| 416 | + if ( isset( $touched_items[ $id ] ) ) { | |
| 417 | + $final[ $id ] = $touched_items[ $id ]; | |
| 418 | + } else { | |
| 419 | + $final[ $id ] = [ | |
| 420 | + 'id' => $id, | |
| 421 | + 'label' => $label, | |
| 422 | + 'type' => 'class', | |
| 423 | + 'variants' => [], | |
| 424 | + ]; | |
| 425 | + } | |
| 254 | 426 | } |
| 255 | 427 | |
| 256 | - return Response_Builder::make()->no_content()->build(); | |
| 428 | + foreach ( $touched_items as $id => $item ) { | |
| 429 | + if ( ! isset( $final[ $id ] ) ) { | |
| 430 | + $final[ $id ] = $item; | |
| 431 | + } | |
| 432 | + } | |
| 433 | + | |
| 434 | + return $final; | |
| 257 | 435 | } |
| 258 | 436 | |
| 259 | 437 | private function route_wrapper( callable $cb ) { |
| 260 | 438 | try { |