<?php

[0] Fix | Delete

namespace Elementor\Data\V2\Base;

[1] Fix | Delete

[2] Fix | Delete

use Elementor\Data\V2\Base\Exceptions\Data_Exception;

[3] Fix | Delete

use Elementor\Data\V2\Base\Exceptions\Error_500;

[4] Fix | Delete

use WP_REST_Server;

[5] Fix | Delete

[6] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[7] Fix | Delete

exit; // Exit if accessed directly.

[8] Fix | Delete

}

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Class purpose is to separate routing logic into one file.

[12] Fix | Delete

*/

[13] Fix | Delete

abstract class Base_Route {

[14] Fix | Delete

const AVAILABLE_METHODS = [

[15] Fix | Delete

WP_REST_Server::READABLE,

[16] Fix | Delete

WP_REST_Server::CREATABLE,

[17] Fix | Delete

WP_REST_Server::EDITABLE,

[18] Fix | Delete

WP_REST_Server::DELETABLE,

[19] Fix | Delete

WP_REST_Server::ALLMETHODS,

[20] Fix | Delete

];

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Controller of current endpoint.

[24] Fix | Delete

*

[25] Fix | Delete

* @var \Elementor\Data\V2\Base\Controller

[26] Fix | Delete

*/

[27] Fix | Delete

protected $controller;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Current route, effect only in case the endpoint behave like sub-endpoint.

[31] Fix | Delete

*

[32] Fix | Delete

* @var string

[33] Fix | Delete

*/

[34] Fix | Delete

protected $route;

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* All register routes.

[38] Fix | Delete

*

[39] Fix | Delete

* @var array

[40] Fix | Delete

*/

[41] Fix | Delete

protected $routes = [];

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Registered item route.

[45] Fix | Delete

*

[46] Fix | Delete

* @var array|null

[47] Fix | Delete

*/

[48] Fix | Delete

protected $item_route = null;

[49] Fix | Delete

[50] Fix | Delete

protected $id_arg_name = 'id';

[51] Fix | Delete

protected $id_arg_type_regex = '[\d]+';

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Ensure start-with and end-with slashes.

[55] Fix | Delete

*

[56] Fix | Delete

* '/' => '/'

[57] Fix | Delete

* 'abc' => '/abc/'

[58] Fix | Delete

* '/abc' => '/abc/'

[59] Fix | Delete

* 'abc/' => '/abc/'

[60] Fix | Delete

* '/abc/' => '/abc/'

[61] Fix | Delete

*

[62] Fix | Delete

* @param string $route

[63] Fix | Delete

*

[64] Fix | Delete

* @return string

[65] Fix | Delete

*/

[66] Fix | Delete

private function ensure_slashes( $route ) {

[67] Fix | Delete

if ( '/' !== $route[0] ) {

[68] Fix | Delete

$route = '/' . $route;

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

return trailingslashit( $route );

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Get base route.

[76] Fix | Delete

* This method should always return the base route starts with '/' and ends without '/'.

[77] Fix | Delete

*

[78] Fix | Delete

* @return string

[79] Fix | Delete

*/

[80] Fix | Delete

public function get_base_route() {

[81] Fix | Delete

$name = $this->get_public_name();

[82] Fix | Delete

$parent = $this->get_parent();

[83] Fix | Delete

$parent_base = $parent->get_base_route();

[84] Fix | Delete

$route = '/';

[85] Fix | Delete

[86] Fix | Delete

if ( ! ( $parent instanceof Controller ) ) {

[87] Fix | Delete

$route = $parent->item_route ? $parent->item_route['route'] . '/' : $this->route;

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

return untrailingslashit( '/' . trim( $parent_base . $route . $name, '/' ) );

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Get permission callback.

[95] Fix | Delete

*

[96] Fix | Delete

* By default get permission callback from the controller.

[97] Fix | Delete

*

[98] Fix | Delete

* @param \WP_REST_Request $request Full data about the request.

[99] Fix | Delete

*

[100] Fix | Delete

* @return boolean

[101] Fix | Delete

*/

[102] Fix | Delete

public function get_permission_callback( $request ) {

[103] Fix | Delete

return $this->controller->get_permission_callback( $request );

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Retrieves a collection of items.

[108] Fix | Delete

*

[109] Fix | Delete

* @param \WP_REST_Request $request Full data about the request.

[110] Fix | Delete

*

[111] Fix | Delete

* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.

[112] Fix | Delete

*/

[113] Fix | Delete

protected function get_items( $request ) {

[114] Fix | Delete

return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Retrieves one item from the collection.

[119] Fix | Delete

*

[120] Fix | Delete

* @param string $id

[121] Fix | Delete

* @param \WP_REST_Request $request Full data about the request.

[122] Fix | Delete

*

[123] Fix | Delete

* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.

[124] Fix | Delete

*/

[125] Fix | Delete

protected function get_item( $id, $request ) {

[126] Fix | Delete

return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Creates multiple items.

[131] Fix | Delete

*

[132] Fix | Delete

* @param \WP_REST_Request $request Full data about the request.

[133] Fix | Delete

*

[134] Fix | Delete

* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.

[135] Fix | Delete

*/

[136] Fix | Delete

protected function create_items( $request ) {

[137] Fix | Delete

return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Creates one item.

[142] Fix | Delete

*

[143] Fix | Delete

* @param string $id id of request item.

[144] Fix | Delete

* @param \WP_REST_Request $request Full data about the request.

[145] Fix | Delete

*

[146] Fix | Delete

* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.

[147] Fix | Delete

*/

[148] Fix | Delete

protected function create_item( $id, $request ) {

[149] Fix | Delete

return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Updates multiple items.

[154] Fix | Delete

*

[155] Fix | Delete

* @param \WP_REST_Request $request Full data about the request.

[156] Fix | Delete

*

[157] Fix | Delete

* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.

[158] Fix | Delete

*/

[159] Fix | Delete

protected function update_items( $request ) {

[160] Fix | Delete

return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

/**

[164] Fix | Delete

* Updates one item.

[165] Fix | Delete

*

[166] Fix | Delete

* @param string $id id of request item.

[167] Fix | Delete

* @param \WP_REST_Request $request Full data about the request.

[168] Fix | Delete

*

[169] Fix | Delete

* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.

[170] Fix | Delete

*/

[171] Fix | Delete

protected function update_item( $id, $request ) {

[172] Fix | Delete

return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

/**

[176] Fix | Delete

* Delete multiple items.

[177] Fix | Delete

*

[178] Fix | Delete

* @param \WP_REST_Request $request Full data about the request.

[179] Fix | Delete

*

[180] Fix | Delete

* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.

[181] Fix | Delete

*/

[182] Fix | Delete

protected function delete_items( $request ) {

[183] Fix | Delete

return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

/**

[187] Fix | Delete

* Delete one item.

[188] Fix | Delete

*

[189] Fix | Delete

* @param string $id id of request item.

[190] Fix | Delete

* @param \WP_REST_Request $request Full data about the request.

[191] Fix | Delete

*

[192] Fix | Delete

* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.

[193] Fix | Delete

*/

[194] Fix | Delete

protected function delete_item( $id, $request ) {

[195] Fix | Delete

return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

/**

[199] Fix | Delete

* Register the endpoint.

[200] Fix | Delete

*

[201] Fix | Delete

* By default: register get items route.

[202] Fix | Delete

*/

[203] Fix | Delete

protected function register() {

[204] Fix | Delete

$this->register_items_route();

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

protected function register_route( $route = '', $methods = WP_REST_Server::READABLE, $args = [] ) {

[208] Fix | Delete

if ( ! in_array( $methods, self::AVAILABLE_METHODS, true ) ) {

[209] Fix | Delete

trigger_error( "Invalid method: '$methods'.", E_USER_ERROR ); // phpcs:ignore

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

$route = $this->get_base_route() . $route;

[213] Fix | Delete

[214] Fix | Delete

$this->routes [] = [

[215] Fix | Delete

'args' => $args,

[216] Fix | Delete

'route' => $route,

[217] Fix | Delete

];

[218] Fix | Delete

[219] Fix | Delete

/**

[220] Fix | Delete

* Determine behaviour of `base_callback()` and `get_permission_callback()`:

[221] Fix | Delete

* For `base_callback()` which applying the action.

[222] Fix | Delete

* Whether it's a one item request and should call `get_item_permission_callback()` or it's mutil items request and should call `get_items_permission_callback()`.

[223] Fix | Delete

*/

[224] Fix | Delete

$is_multi = ! empty( $args['is_multi'] );

[225] Fix | Delete

[226] Fix | Delete

if ( $is_multi ) {

[227] Fix | Delete

unset( $args['is_multi'] );

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

$callback = function ( $request ) use ( $methods, $args, $is_multi ) {

[231] Fix | Delete

return $this->base_callback( $methods, $request, $is_multi );

[232] Fix | Delete

};

[233] Fix | Delete

[234] Fix | Delete

return register_rest_route( $this->controller->get_namespace(), $route, [

[235] Fix | Delete

[

[236] Fix | Delete

'args' => $args,

[237] Fix | Delete

'methods' => $methods,

[238] Fix | Delete

'callback' => $callback,

[239] Fix | Delete

'permission_callback' => function ( $request ) {

[240] Fix | Delete

return $this->get_permission_callback( $request );

[241] Fix | Delete

},

[242] Fix | Delete

],

[243] Fix | Delete

] );

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Register items route.

[248] Fix | Delete

*

[249] Fix | Delete

* @param string $methods

[250] Fix | Delete

* @param array $args

[251] Fix | Delete

*/

[252] Fix | Delete

public function register_items_route( $methods = WP_REST_Server::READABLE, $args = [] ) {

[253] Fix | Delete

$args['is_multi'] = true;

[254] Fix | Delete

[255] Fix | Delete

$this->register_route( '', $methods, $args );

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

public function register_item_route( $methods = WP_REST_Server::READABLE, $args = [], $route = '/' ) {

[259] Fix | Delete

if ( ! empty( $args['id_arg_name'] ) ) {

[260] Fix | Delete

$this->id_arg_name = $args['id_arg_name'];

[261] Fix | Delete

[262] Fix | Delete

unset( $args['id_arg_name'] );

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

if ( ! empty( $args['id_arg_type_regex'] ) ) {

[266] Fix | Delete

$this->id_arg_type_regex = $args['id_arg_type_regex'];

[267] Fix | Delete

[268] Fix | Delete

unset( $args['id_arg_type_regex'] );

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

$args = array_merge( [

[272] Fix | Delete

$this->id_arg_name => [

[273] Fix | Delete

'description' => 'Unique identifier for the object.',

[274] Fix | Delete

'type' => 'string',

[275] Fix | Delete

'required' => true,

[276] Fix | Delete

],

[277] Fix | Delete

], $args );

[278] Fix | Delete

[279] Fix | Delete

$route .= '(?P<' . $this->id_arg_name . '>' . $this->id_arg_type_regex . ')';

[280] Fix | Delete

[281] Fix | Delete

$this->item_route = [

[282] Fix | Delete

'args' => $args,

[283] Fix | Delete

'route' => $route,

[284] Fix | Delete

];

[285] Fix | Delete

[286] Fix | Delete

$this->register_route( $route, $methods, $args );

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

/**

[290] Fix | Delete

* Base callback.

[291] Fix | Delete

* All reset requests from the client should pass this function.

[292] Fix | Delete

*

[293] Fix | Delete

* @param string $methods

[294] Fix | Delete

* @param \WP_REST_Request $request

[295] Fix | Delete

* @param bool $is_multi

[296] Fix | Delete

* @param array $args

[297] Fix | Delete

*

[298] Fix | Delete

* @return mixed|\WP_Error|\WP_HTTP_Response|\WP_REST_Response

[299] Fix | Delete

*/

[300] Fix | Delete

public function base_callback( $methods, $request, $is_multi = false, $args = [] ) {

[301] Fix | Delete

if ( $request ) {

[302] Fix | Delete

$json_params = $request->get_json_params();

[303] Fix | Delete

[304] Fix | Delete

if ( $json_params ) {

[305] Fix | Delete

$request->set_body_params( $json_params );

[306] Fix | Delete

}

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

$args = wp_parse_args( $args, [

[310] Fix | Delete

'is_debug' => ( defined( 'WP_DEBUG' ) && WP_DEBUG ),

[311] Fix | Delete

] );

[312] Fix | Delete

[313] Fix | Delete

$result = new \WP_Error( 'invalid_methods', 'route not supported.' );

[314] Fix | Delete

[315] Fix | Delete

$request->set_param( 'is_multi', $is_multi );

[316] Fix | Delete

[317] Fix | Delete

try {

[318] Fix | Delete

switch ( $methods ) {

[319] Fix | Delete

case WP_REST_Server::READABLE:

[320] Fix | Delete

$result = $is_multi ? $this->get_items( $request ) : $this->get_item( $request->get_param( 'id' ), $request );

[321] Fix | Delete

break;

[322] Fix | Delete

[323] Fix | Delete

case WP_REST_Server::CREATABLE:

[324] Fix | Delete

$result = $is_multi ? $this->create_items( $request ) : $this->create_item( $request->get_param( 'id' ), $request );

[325] Fix | Delete

break;

[326] Fix | Delete

[327] Fix | Delete

case WP_REST_Server::EDITABLE:

[328] Fix | Delete

$result = $is_multi ? $this->update_items( $request ) : $this->update_item( $request->get_param( 'id' ), $request );

[329] Fix | Delete

break;

[330] Fix | Delete

[331] Fix | Delete

case WP_REST_Server::DELETABLE:

[332] Fix | Delete

$result = $is_multi ? $this->delete_items( $request ) : $this->delete_item( $request->get_param( 'id' ), $request );

[333] Fix | Delete

break;

[334] Fix | Delete

}

[335] Fix | Delete

} catch ( Data_Exception $e ) {

[336] Fix | Delete

$result = $e->to_wp_error();

[337] Fix | Delete

} catch ( \Exception $e ) {

[338] Fix | Delete

if ( empty( $args['is_debug'] ) ) {

[339] Fix | Delete

$result = ( new Error_500() )->to_wp_error();

[340] Fix | Delete

} else {

[341] Fix | Delete

// For frontend.

[342] Fix | Delete

$exception_mapping = [

[343] Fix | Delete

'trace' => $e->getTrace(),

[344] Fix | Delete

'file' => $e->getFile(),

[345] Fix | Delete

'line' => $e->getLine(),

[346] Fix | Delete

];

[347] Fix | Delete

[348] Fix | Delete

$e->debug = $exception_mapping;

[349] Fix | Delete

[350] Fix | Delete

$result = ( new Data_Exception( $e->getMessage(), $e->getCode(), $e ) )->to_wp_error();

[351] Fix | Delete

}

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

return rest_ensure_response( $result );

[355] Fix | Delete

}

[356] Fix | Delete

[357] Fix | Delete

/**

[358] Fix | Delete

* Constructor.

[359] Fix | Delete

*

[360] Fix | Delete

* Run `$this->register()`.

[361] Fix | Delete

*

[362] Fix | Delete

* @param \Elementor\Data\V2\Base\Controller $controller

[363] Fix | Delete

* @param string $route

[364] Fix | Delete

*/

[365] Fix | Delete

protected function __construct( Controller $controller, $route ) {

[366] Fix | Delete

$this->controller = $controller;

[367] Fix | Delete

$this->route = $this->ensure_slashes( $route );

[368] Fix | Delete

[369] Fix | Delete

$this->register();

[370] Fix | Delete

}

[371] Fix | Delete

}

[372] Fix | Delete

[373] Fix | Delete