<?php

[0] Fix | Delete

namespace Elementor\Data\Base;

[1] Fix | Delete

[2] Fix | Delete

use Elementor\Data\Manager;

[3] Fix | Delete

use Elementor\Plugin;

[4] Fix | Delete

use WP_REST_Controller;

[5] Fix | Delete

use WP_REST_Server;

[6] Fix | Delete

[7] Fix | Delete

abstract class Controller extends WP_REST_Controller {

[8] Fix | Delete

/**

[9] Fix | Delete

* Loaded endpoint(s).

[10] Fix | Delete

*

[11] Fix | Delete

* @var \Elementor\Data\Base\Endpoint[]

[12] Fix | Delete

*/

[13] Fix | Delete

public $endpoints = [];

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Loaded processor(s).

[17] Fix | Delete

*

[18] Fix | Delete

* @var \Elementor\Data\Base\Processor[][]

[19] Fix | Delete

*/

[20] Fix | Delete

public $processors = [];

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Controller constructor.

[24] Fix | Delete

*

[25] Fix | Delete

* Register endpoints on 'rest_api_init'.

[26] Fix | Delete

*/

[27] Fix | Delete

public function __construct() {

[28] Fix | Delete

// TODO: Controllers and endpoints can have common interface.

[29] Fix | Delete

[30] Fix | Delete

// TODO: Uncomment when native 3rd plugins uses V2.

[31] Fix | Delete

// $this->deprecated();

[32] Fix | Delete

[33] Fix | Delete

$this->namespace = Manager::ROOT_NAMESPACE . '/v' . Manager::VERSION;

[34] Fix | Delete

$this->rest_base = Manager::REST_BASE . $this->get_name();

[35] Fix | Delete

[36] Fix | Delete

add_action( 'rest_api_init', function () {

[37] Fix | Delete

$this->register(); // Because 'register' is protected.

[38] Fix | Delete

} );

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Since all actions were removed for custom internal REST server.

[42] Fix | Delete

* Re-add the actions.

[43] Fix | Delete

*/

[44] Fix | Delete

add_action( 'elementor_rest_api_before_init', function () {

[45] Fix | Delete

add_action( 'rest_api_init', function() {

[46] Fix | Delete

$this->register();

[47] Fix | Delete

} );

[48] Fix | Delete

} );

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Get controller name.

[53] Fix | Delete

*

[54] Fix | Delete

* @return string

[55] Fix | Delete

*/

[56] Fix | Delete

abstract public function get_name();

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Get controller namespace.

[60] Fix | Delete

*

[61] Fix | Delete

* @return string

[62] Fix | Delete

*/

[63] Fix | Delete

public function get_namespace() {

[64] Fix | Delete

return $this->namespace;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Get controller reset base.

[69] Fix | Delete

*

[70] Fix | Delete

* @return string

[71] Fix | Delete

*/

[72] Fix | Delete

public function get_rest_base() {

[73] Fix | Delete

return $this->rest_base;

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Get controller route.

[78] Fix | Delete

*

[79] Fix | Delete

* @return string

[80] Fix | Delete

*/

[81] Fix | Delete

public function get_controller_route() {

[82] Fix | Delete

return $this->get_namespace() . '/' . $this->get_rest_base();

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Retrieves the index for a controller.

[87] Fix | Delete

*

[88] Fix | Delete

* @return \WP_REST_Response|\WP_Error

[89] Fix | Delete

*/

[90] Fix | Delete

public function get_controller_index() {

[91] Fix | Delete

$server = rest_get_server();

[92] Fix | Delete

$routes = $server->get_routes();

[93] Fix | Delete

[94] Fix | Delete

$endpoints = array_intersect_key( $server->get_routes(), $routes );

[95] Fix | Delete

[96] Fix | Delete

$controller_route = $this->get_controller_route();

[97] Fix | Delete

[98] Fix | Delete

array_walk( $endpoints, function ( &$item, $endpoint ) use ( &$endpoints, $controller_route ) {

[99] Fix | Delete

if ( ! strstr( $endpoint, $controller_route ) ) {

[100] Fix | Delete

unset( $endpoints[ $endpoint ] );

[101] Fix | Delete

}

[102] Fix | Delete

} );

[103] Fix | Delete

[104] Fix | Delete

$data = [

[105] Fix | Delete

'namespace' => $this->get_namespace(),

[106] Fix | Delete

'controller' => $controller_route,

[107] Fix | Delete

'routes' => $server->get_data_for_routes( $endpoints ),

[108] Fix | Delete

];

[109] Fix | Delete

[110] Fix | Delete

$response = rest_ensure_response( $data );

[111] Fix | Delete

[112] Fix | Delete

// Link to the root index.

[113] Fix | Delete

$response->add_link( 'up', rest_url( '/' ) );

[114] Fix | Delete

[115] Fix | Delete

return $response;

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

/**

[119] Fix | Delete

* Get processors.

[120] Fix | Delete

*

[121] Fix | Delete

* @param string $command

[122] Fix | Delete

*

[123] Fix | Delete

* @return \Elementor\Data\Base\Processor[]

[124] Fix | Delete

*/

[125] Fix | Delete

public function get_processors( $command ) {

[126] Fix | Delete

$result = [];

[127] Fix | Delete

[128] Fix | Delete

if ( isset( $this->processors[ $command ] ) ) {

[129] Fix | Delete

$result = $this->processors[ $command ];

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

return $result;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

public function get_items( $request ) {

[136] Fix | Delete

return $this->get_controller_index();

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Creates multiple items.

[141] Fix | Delete

*

[142] Fix | Delete

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

[143] Fix | Delete

*

[144] Fix | Delete

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

[145] Fix | Delete

*/

[146] Fix | Delete

public function create_items( $request ) {

[147] Fix | Delete

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

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Updates multiple items.

[152] Fix | Delete

*

[153] Fix | Delete

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

[154] Fix | Delete

*

[155] Fix | Delete

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

[156] Fix | Delete

*/

[157] Fix | Delete

public function update_items( $request ) {

[158] Fix | Delete

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

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* Delete multiple items.

[163] Fix | Delete

*

[164] Fix | Delete

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

[165] Fix | Delete

*

[166] Fix | Delete

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

[167] Fix | Delete

*/

[168] Fix | Delete

public function delete_items( $request ) {

[169] Fix | Delete

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

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

/**

[173] Fix | Delete

* Register endpoints.

[174] Fix | Delete

*/

[175] Fix | Delete

abstract public function register_endpoints();

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Register processors.

[179] Fix | Delete

*/

[180] Fix | Delete

public function register_processors() {

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

/**

[184] Fix | Delete

* Register internal endpoints.

[185] Fix | Delete

*/

[186] Fix | Delete

protected function register_internal_endpoints() {

[187] Fix | Delete

register_rest_route( $this->get_namespace(), '/' . $this->get_rest_base(), [

[188] Fix | Delete

[

[189] Fix | Delete

'methods' => WP_REST_Server::READABLE,

[190] Fix | Delete

'callback' => [ $this, 'get_items' ],

[191] Fix | Delete

'args' => [],

[192] Fix | Delete

'permission_callback' => function ( $request ) {

[193] Fix | Delete

return $this->get_permission_callback( $request );

[194] Fix | Delete

},

[195] Fix | Delete

],

[196] Fix | Delete

] );

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Register endpoint.

[201] Fix | Delete

*

[202] Fix | Delete

* @param string $endpoint_class

[203] Fix | Delete

*

[204] Fix | Delete

* @return \Elementor\Data\Base\Endpoint

[205] Fix | Delete

*/

[206] Fix | Delete

protected function register_endpoint( $endpoint_class ) {

[207] Fix | Delete

$endpoint_instance = new $endpoint_class( $this );

[208] Fix | Delete

[209] Fix | Delete

// TODO: Validate instance like in register_sub_endpoint().

[210] Fix | Delete

[211] Fix | Delete

$endpoint_route = $this->get_name() . '/' . $endpoint_instance->get_name();

[212] Fix | Delete

[213] Fix | Delete

$this->endpoints[ $endpoint_route ] = $endpoint_instance;

[214] Fix | Delete

[215] Fix | Delete

$command = $endpoint_route;

[216] Fix | Delete

$format = $endpoint_instance::get_format();

[217] Fix | Delete

[218] Fix | Delete

if ( $command ) {

[219] Fix | Delete

$format = $command . '/' . $format;

[220] Fix | Delete

} else {

[221] Fix | Delete

$format = $format . $command;

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

// `$e.data.registerFormat()`.

[225] Fix | Delete

Manager::instance()->register_endpoint_format( $command, $format );

[226] Fix | Delete

[227] Fix | Delete

return $endpoint_instance;

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

/**

[231] Fix | Delete

* Register a processor.

[232] Fix | Delete

*

[233] Fix | Delete

* That will be later attached to the endpoint class.

[234] Fix | Delete

*

[235] Fix | Delete

* @param string $processor_class

[236] Fix | Delete

*

[237] Fix | Delete

* @return \Elementor\Data\Base\Processor $processor_instance

[238] Fix | Delete

*/

[239] Fix | Delete

protected function register_processor( $processor_class ) {

[240] Fix | Delete

$processor_instance = new $processor_class( $this );

[241] Fix | Delete

[242] Fix | Delete

// TODO: Validate processor instance.

[243] Fix | Delete

[244] Fix | Delete

$command = $processor_instance->get_command();

[245] Fix | Delete

[246] Fix | Delete

if ( ! isset( $this->processors[ $command ] ) ) {

[247] Fix | Delete

$this->processors[ $command ] = [];

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

$this->processors[ $command ] [] = $processor_instance;

[251] Fix | Delete

[252] Fix | Delete

return $processor_instance;

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Register.

[257] Fix | Delete

*

[258] Fix | Delete

* Endpoints & processors.

[259] Fix | Delete

*/

[260] Fix | Delete

protected function register() {

[261] Fix | Delete

$this->register_internal_endpoints();

[262] Fix | Delete

$this->register_endpoints();

[263] Fix | Delete

[264] Fix | Delete

// Aka hooks.

[265] Fix | Delete

$this->register_processors();

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

/**

[269] Fix | Delete

* Retrieves a recursive collection of all endpoint(s), items.

[270] Fix | Delete

*

[271] Fix | Delete

* Get items recursive, will run overall endpoints of the current controller.

[272] Fix | Delete

* For each endpoint it will run `$endpoint->getItems( $request ) // the $request passed in get_items_recursive`.

[273] Fix | Delete

* Will skip $skip_endpoints endpoint(s).

[274] Fix | Delete

*

[275] Fix | Delete

* Example, scenario:

[276] Fix | Delete

* Controller 'test-controller'.

[277] Fix | Delete

* Controller endpoints: 'endpoint1', 'endpoint2'.

[278] Fix | Delete

* Endpoint2 get_items method: `get_items() { return 'test' }`.

[279] Fix | Delete

* Call `Controller.get_items_recursive( ['endpoint1'] )`, result: [ 'endpoint2' => 'test' ];

[280] Fix | Delete

*

[281] Fix | Delete

* @param array $skip_endpoints

[282] Fix | Delete

*

[283] Fix | Delete

* @return array

[284] Fix | Delete

*/

[285] Fix | Delete

public function get_items_recursive( $skip_endpoints = [] ) {

[286] Fix | Delete

$response = [];

[287] Fix | Delete

[288] Fix | Delete

foreach ( $this->endpoints as $endpoint ) {

[289] Fix | Delete

// Skip self.

[290] Fix | Delete

if ( in_array( $endpoint, $skip_endpoints, true ) ) {

[291] Fix | Delete

continue;

[292] Fix | Delete

}

[293] Fix | Delete

[294] Fix | Delete

$response[ $endpoint->get_name() ] = $endpoint->get_items( null );

[295] Fix | Delete

}

[296] Fix | Delete

[297] Fix | Delete

return $response;

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete

/**

[301] Fix | Delete

* Get permission callback.

[302] Fix | Delete

*

[303] Fix | Delete

* Default controller permission callback.

[304] Fix | Delete

* By default endpoint will inherit the permission callback from the controller.

[305] Fix | Delete

* By default permission is `current_user_can( 'manage_options' );`.

[306] Fix | Delete

*

[307] Fix | Delete

* @param \WP_REST_Request $request

[308] Fix | Delete

*

[309] Fix | Delete

* @return bool

[310] Fix | Delete

*/

[311] Fix | Delete

public function get_permission_callback( $request ) {

[312] Fix | Delete

// The function is public since endpoint need to access it.

[313] Fix | Delete

switch ( $request->get_method() ) {

[314] Fix | Delete

case 'GET':

[315] Fix | Delete

case 'POST':

[316] Fix | Delete

case 'UPDATE':

[317] Fix | Delete

case 'PUT':

[318] Fix | Delete

case 'DELETE':

[319] Fix | Delete

case 'PATCH':

[320] Fix | Delete

return current_user_can( 'manage_options' );

[321] Fix | Delete

}

[322] Fix | Delete

[323] Fix | Delete

return false;

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete

private static $notify_deprecated = true;

[327] Fix | Delete

[328] Fix | Delete

private function deprecated() {

[329] Fix | Delete

add_action( 'elementor/init', function () {

[330] Fix | Delete

if ( ! self::$notify_deprecated ) {

[331] Fix | Delete

return;

[332] Fix | Delete

}

[333] Fix | Delete

[334] Fix | Delete

Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function(

[335] Fix | Delete

'Elementor\Data\Manager',

[336] Fix | Delete

'3.5.0',

[337] Fix | Delete

'Elementor\Data\V2\Manager'

[338] Fix | Delete

);

[339] Fix | Delete

[340] Fix | Delete

self::$notify_deprecated = false;

[341] Fix | Delete

} );

[342] Fix | Delete

}

[343] Fix | Delete

}

[344] Fix | Delete

[345] Fix | Delete