first commit
This commit is contained in:
DESKTOP-GBA0BK8\Admin
@@ -0,0 +1,291 @@
|
||||
<?php
|
||||
namespace Elementor\Data\Base;
|
||||
|
||||
use Elementor\Data\Manager;
|
||||
use WP_REST_Controller;
|
||||
use WP_REST_Server;
|
||||
|
||||
abstract class Controller extends WP_REST_Controller {
|
||||
/**
|
||||
* Loaded endpoint(s).
|
||||
*
|
||||
* @var \Elementor\Data\Base\Endpoint[]
|
||||
*/
|
||||
public $endpoints = [];
|
||||
|
||||
/**
|
||||
* Loaded processor(s).
|
||||
*
|
||||
* @var \Elementor\Data\Base\Processor[][]
|
||||
*/
|
||||
public $processors = [];
|
||||
|
||||
/**
|
||||
* Controller constructor.
|
||||
*
|
||||
* Register endpoints on 'rest_api_init'.
|
||||
*
|
||||
*/
|
||||
public function __construct() {
|
||||
// TODO: Controllers and endpoints can have common interface.
|
||||
|
||||
$this->namespace = Manager::ROOT_NAMESPACE . '/v' . Manager::VERSION;
|
||||
$this->rest_base = Manager::REST_BASE . $this->get_name();
|
||||
|
||||
add_action( 'rest_api_init', function () {
|
||||
$this->register(); // Because 'register' is protected.
|
||||
} );
|
||||
|
||||
/**
|
||||
* Since all actions were removed for custom internal REST server.
|
||||
* Re-add the actions.
|
||||
*/
|
||||
add_action( 'elementor_rest_api_before_init', function () {
|
||||
add_action( 'rest_api_init', function() {
|
||||
$this->register();
|
||||
} );
|
||||
} );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get controller name.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
abstract public function get_name();
|
||||
|
||||
/**
|
||||
* Get controller namespace.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_namespace() {
|
||||
return $this->namespace;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get controller reset base.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_rest_base() {
|
||||
return $this->rest_base;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get controller route.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_controller_route() {
|
||||
return $this->get_namespace() . '/' . $this->get_rest_base();
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the index for a controller.
|
||||
*
|
||||
* @return \WP_REST_Response|\WP_Error
|
||||
*/
|
||||
public function get_controller_index() {
|
||||
$server = rest_get_server();
|
||||
$routes = $server->get_routes();
|
||||
|
||||
$endpoints = array_intersect_key( $server->get_routes(), $routes );
|
||||
|
||||
$controller_route = $this->get_controller_route();
|
||||
|
||||
array_walk( $endpoints, function ( &$item, $endpoint ) use ( &$endpoints, $controller_route ) {
|
||||
if ( ! strstr( $endpoint, $controller_route ) ) {
|
||||
unset( $endpoints[ $endpoint ] );
|
||||
}
|
||||
} );
|
||||
|
||||
$data = [
|
||||
'namespace' => $this->get_namespace(),
|
||||
'controller' => $controller_route,
|
||||
'routes' => $server->get_data_for_routes( $endpoints ),
|
||||
];
|
||||
|
||||
$response = rest_ensure_response( $data );
|
||||
|
||||
// Link to the root index.
|
||||
$response->add_link( 'up', rest_url( '/' ) );
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get processors.
|
||||
*
|
||||
* @param string $command
|
||||
*
|
||||
* @return \Elementor\Data\Base\Processor[]
|
||||
*/
|
||||
public function get_processors( $command ) {
|
||||
$result = [];
|
||||
|
||||
if ( isset( $this->processors[ $command ] ) ) {
|
||||
$result = $this->processors[ $command ];
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function get_items( $request ) {
|
||||
return $this->get_controller_index();
|
||||
}
|
||||
|
||||
/**
|
||||
* Register endpoints.
|
||||
*/
|
||||
abstract public function register_endpoints();
|
||||
|
||||
/**
|
||||
* Register processors.
|
||||
*/
|
||||
public function register_processors() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Register internal endpoints.
|
||||
*/
|
||||
protected function register_internal_endpoints() {
|
||||
register_rest_route( $this->get_namespace(), '/' . $this->get_rest_base(), [
|
||||
[
|
||||
'methods' => WP_REST_Server::READABLE,
|
||||
'callback' => array( $this, 'get_items' ),
|
||||
'args' => [],
|
||||
'permission_callback' => function ( $request ) {
|
||||
return $this->get_permission_callback( $request );
|
||||
},
|
||||
],
|
||||
] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register endpoint.
|
||||
*
|
||||
* @param string $endpoint_class
|
||||
*
|
||||
* @return \Elementor\Data\Base\Endpoint
|
||||
*/
|
||||
protected function register_endpoint( $endpoint_class ) {
|
||||
$endpoint_instance = new $endpoint_class( $this );
|
||||
|
||||
// TODO: Validate instance like in register_sub_endpoint().
|
||||
|
||||
$endpoint_route = $this->get_name() . '/' . $endpoint_instance->get_name();
|
||||
|
||||
$this->endpoints[ $endpoint_route ] = $endpoint_instance;
|
||||
|
||||
$command = $endpoint_route;
|
||||
$format = $endpoint_instance::get_format();
|
||||
|
||||
if ( $command ) {
|
||||
$format = $command . '/' . $format;
|
||||
} else {
|
||||
$format = $format . $command;
|
||||
}
|
||||
|
||||
// `$e.data.registerFormat()`.
|
||||
Manager::instance()->register_endpoint_format( $command, $format );
|
||||
|
||||
return $endpoint_instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Register a processor.
|
||||
*
|
||||
* That will be later attached to the endpoint class.
|
||||
*
|
||||
* @param string $processor_class
|
||||
*
|
||||
* @return \Elementor\Data\Base\Processor $processor_instance
|
||||
*/
|
||||
protected function register_processor( $processor_class ) {
|
||||
$processor_instance = new $processor_class( $this );
|
||||
|
||||
// TODO: Validate processor instance.
|
||||
|
||||
$command = $processor_instance->get_command();
|
||||
|
||||
if ( ! isset( $this->processors[ $command ] ) ) {
|
||||
$this->processors[ $command ] = [];
|
||||
}
|
||||
|
||||
$this->processors[ $command ] [] = $processor_instance;
|
||||
|
||||
return $processor_instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Register.
|
||||
*
|
||||
* Endpoints & processors.
|
||||
*/
|
||||
protected function register() {
|
||||
$this->register_internal_endpoints();
|
||||
$this->register_endpoints();
|
||||
|
||||
// Aka hooks.
|
||||
$this->register_processors();
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a recursive collection of all endpoint(s), items.
|
||||
*
|
||||
* Get items recursive, will run overall endpoints of the current controller.
|
||||
* For each endpoint it will run `$endpoint->getItems( $request ) // the $request passed in get_items_recursive`.
|
||||
* Will skip $skip_endpoints endpoint(s).
|
||||
*
|
||||
* Example, scenario:
|
||||
* Controller 'test-controller'.
|
||||
* Controller endpoints: 'endpoint1', 'endpoint2'.
|
||||
* Endpoint2 get_items method: `get_items() { return 'test' }`.
|
||||
* Call `Controller.get_items_recursive( ['endpoint1'] )`, result: [ 'endpoint2' => 'test' ];
|
||||
*
|
||||
* @param array $skip_endpoints
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get_items_recursive( $skip_endpoints = [] ) {
|
||||
$response = [];
|
||||
|
||||
foreach ( $this->endpoints as $endpoint ) {
|
||||
// Skip self.
|
||||
if ( in_array( $endpoint, $skip_endpoints, true ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$response[ $endpoint->get_name() ] = $endpoint->get_items( null );
|
||||
}
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get permission callback.
|
||||
*
|
||||
* Default controller permission callback.
|
||||
* By default endpoint will inherit the permission callback from the controller.
|
||||
* By default permission is `current_user_can( 'administrator' );`.
|
||||
*
|
||||
* @param \WP_REST_Request $request
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function get_permission_callback( $request ) {
|
||||
// The function is public since endpoint need to access it.
|
||||
switch ( $request->get_method() ) {
|
||||
case 'GET':
|
||||
case 'POST':
|
||||
case 'UPDATE':
|
||||
case 'PUT':
|
||||
case 'DELETE':
|
||||
case 'PATCH':
|
||||
return current_user_can( 'administrator' );
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,353 @@
|
||||
<?php
|
||||
|
||||
namespace Elementor\Data\Base;
|
||||
|
||||
use Elementor\Data\Manager;
|
||||
use WP_REST_Server;
|
||||
|
||||
abstract class Endpoint {
|
||||
|
||||
const AVAILABLE_METHODS = [
|
||||
WP_REST_Server::READABLE,
|
||||
WP_REST_Server::CREATABLE,
|
||||
WP_REST_Server::EDITABLE,
|
||||
WP_REST_Server::DELETABLE,
|
||||
WP_REST_Server::ALLMETHODS,
|
||||
];
|
||||
|
||||
/**
|
||||
* Controller of current endpoint.
|
||||
*
|
||||
* @var \Elementor\Data\Base\Controller
|
||||
*/
|
||||
protected $controller;
|
||||
|
||||
/**
|
||||
* Loaded sub endpoint(s).
|
||||
*
|
||||
* @var \Elementor\Data\Base\SubEndpoint[]
|
||||
*/
|
||||
private $sub_endpoints = [];
|
||||
|
||||
/**
|
||||
* Get format suffix.
|
||||
*
|
||||
* Examples:
|
||||
* '{one_parameter_name}'.
|
||||
* '{one_parameter_name}/{two_parameter_name}/'.
|
||||
* '{one_parameter_name}/whatever/anything/{two_parameter_name}/' and so on for each endpoint or sub-endpoint.
|
||||
*
|
||||
* @return string current location will later be added automatically.
|
||||
*/
|
||||
public static function get_format() {
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Endpoint constructor.
|
||||
*
|
||||
* run `$this->>register()`.
|
||||
*
|
||||
* @param \Elementor\Data\Base\Controller $controller
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function __construct( $controller ) {
|
||||
if ( ! ( $controller instanceof Controller ) ) {
|
||||
throw new \Exception( 'Invalid controller' );
|
||||
}
|
||||
|
||||
$this->controller = $controller;
|
||||
$this->register();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get endpoint name.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
abstract public function get_name();
|
||||
|
||||
/**
|
||||
* Get base route.
|
||||
*
|
||||
* Removing 'index' from endpoint.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_base_route() {
|
||||
$endpoint_name = $this->get_name();
|
||||
|
||||
// TODO: Allow this only for internal routes.
|
||||
// TODO: Make difference between internal and external endpoints.
|
||||
if ( 'index' === $endpoint_name ) {
|
||||
$endpoint_name = '';
|
||||
}
|
||||
|
||||
return '/' . $this->controller->get_rest_base() . '/' . $endpoint_name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Register the endpoint.
|
||||
*
|
||||
* By default: register get items route.
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
protected function register() {
|
||||
$this->register_items_route();
|
||||
}
|
||||
|
||||
/**
|
||||
* Register sub endpoint.
|
||||
*
|
||||
* @param string $route
|
||||
* @param string $endpoint_class
|
||||
*
|
||||
* @return \Elementor\Data\Base\SubEndpoint
|
||||
* @throws \Exception
|
||||
*/
|
||||
protected function register_sub_endpoint( $route, $endpoint_class ) {
|
||||
$endpoint_instance = new $endpoint_class( $route, $this );
|
||||
|
||||
if ( ! ( $endpoint_instance instanceof SubEndpoint ) ) {
|
||||
throw new \Exception( 'Invalid endpoint instance.' );
|
||||
}
|
||||
|
||||
$endpoint_route = $route . '/' . $endpoint_instance->get_name();
|
||||
|
||||
$this->sub_endpoints[ $endpoint_route ] = $endpoint_instance;
|
||||
|
||||
$component_name = $endpoint_instance->controller->get_rest_base();
|
||||
$parent_instance = $endpoint_instance->get_parent();
|
||||
$parent_name = $endpoint_instance->get_name();
|
||||
$parent_format_suffix = $parent_instance::get_format();
|
||||
$current_format_suffix = $endpoint_instance::get_format();
|
||||
|
||||
$command = $component_name . '/' . $parent_name;
|
||||
$format = $component_name . '/' . $parent_format_suffix . '/' . $parent_name . '/' . $current_format_suffix;
|
||||
|
||||
Manager::instance()->register_endpoint_format( $command, $format );
|
||||
|
||||
return $endpoint_instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Base callback.
|
||||
*
|
||||
* All reset requests from the client should pass this function.
|
||||
*
|
||||
* @param string $methods
|
||||
* @param \WP_REST_Request $request
|
||||
* @param bool $is_multi
|
||||
*
|
||||
* @return mixed|\WP_Error|\WP_HTTP_Response|\WP_REST_Response
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function base_callback( $methods, $request, $is_multi = false ) {
|
||||
// TODO: Find better solution.
|
||||
$json_params = $request->get_json_params();
|
||||
|
||||
if ( $json_params ) {
|
||||
$request->set_body_params( $json_params );
|
||||
}
|
||||
|
||||
// TODO: Handle permission callback.
|
||||
switch ( $methods ) {
|
||||
case WP_REST_Server::READABLE:
|
||||
$result = $is_multi ? $this->get_items( $request ) : $this->get_item( $request->get_param( 'id' ), $request );
|
||||
break;
|
||||
|
||||
case WP_REST_Server::CREATABLE:
|
||||
$result = $is_multi ? $this->create_items( $request ) : $this->create_item( $request->get_param( 'id' ), $request );
|
||||
break;
|
||||
|
||||
case WP_REST_Server::EDITABLE:
|
||||
$result = $is_multi ? $this->update_items( $request ) : $this->update_item( $request->get_param( 'id' ), $request );
|
||||
break;
|
||||
|
||||
case WP_REST_Server::DELETABLE:
|
||||
$result = $is_multi ? $this->delete_items( $request ) : $this->delete_item( $request->get_param( 'id' ), $request );
|
||||
break;
|
||||
|
||||
default:
|
||||
throw new \Exception( 'Invalid method.' );
|
||||
}
|
||||
|
||||
return rest_ensure_response( $result );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a collection of items.
|
||||
*
|
||||
* @param \WP_REST_Request $request Full data about the request.
|
||||
*
|
||||
* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.
|
||||
*/
|
||||
public function get_items( $request ) {
|
||||
return $this->controller->get_items( $request );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves one item from the collection.
|
||||
*
|
||||
* @param string $id
|
||||
* @param \WP_REST_Request $request Full data about the request.
|
||||
*
|
||||
* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.
|
||||
*/
|
||||
public function get_item( $id, $request ) {
|
||||
return $this->controller->get_item( $request );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get permission callback.
|
||||
*
|
||||
* By default get permission callback from the controller.
|
||||
*
|
||||
* @param \WP_REST_Request $request Full data about the request.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public function get_permission_callback( $request ) {
|
||||
return $this->controller->get_permission_callback( $request );
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates one item.
|
||||
*
|
||||
* @param string $id id of request item.
|
||||
* @param \WP_REST_Request $request Full data about the request.
|
||||
*
|
||||
* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.
|
||||
*/
|
||||
public function create_item( $id, $request ) {
|
||||
return $this->controller->create_item( $request );
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates multiple items.
|
||||
*
|
||||
* @param \WP_REST_Request $request Full data about the request.
|
||||
*
|
||||
* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.
|
||||
*/
|
||||
public function create_items( $request ) {
|
||||
return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), array( 'status' => 405 ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates one item.
|
||||
*
|
||||
* @param string $id id of request item.
|
||||
* @param \WP_REST_Request $request Full data about the request.
|
||||
*
|
||||
* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.
|
||||
*/
|
||||
public function update_item( $id, $request ) {
|
||||
return $this->controller->update_item( $request );
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates multiple items.
|
||||
*
|
||||
* @param \WP_REST_Request $request Full data about the request.
|
||||
*
|
||||
* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.
|
||||
*/
|
||||
public function update_items( $request ) {
|
||||
return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), array( 'status' => 405 ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete one item.
|
||||
*
|
||||
* @param string $id id of request item.
|
||||
* @param \WP_REST_Request $request Full data about the request.
|
||||
*
|
||||
* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.
|
||||
*/
|
||||
public function delete_item( $id, $request ) {
|
||||
return $this->controller->update_item( $request );
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete multiple items.
|
||||
*
|
||||
* @param \WP_REST_Request $request Full data about the request.
|
||||
*
|
||||
* @return \WP_Error|\WP_REST_Response Response object on success, or WP_Error object on failure.
|
||||
*/
|
||||
public function delete_items( $request ) {
|
||||
return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), array( 'status' => 405 ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register item route.
|
||||
*
|
||||
* @param array $args
|
||||
* @param string $route
|
||||
* @param string $methods
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function register_item_route( $methods = WP_REST_Server::READABLE, $args = [], $route = '/' ) {
|
||||
$args = array_merge( [
|
||||
'id' => [
|
||||
'description' => 'Unique identifier for the object.',
|
||||
'type' => 'string',
|
||||
],
|
||||
], $args );
|
||||
|
||||
if ( isset( $args['id'] ) && $args['id'] ) {
|
||||
$route .= '(?P<id>[\w]+)/';
|
||||
}
|
||||
|
||||
$this->register_route( $route, $methods, function ( $request ) use ( $methods ) {
|
||||
return $this->base_callback( $methods, $request );
|
||||
}, $args );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register items route.
|
||||
*
|
||||
* @param string $methods
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function register_items_route( $methods = WP_REST_Server::READABLE ) {
|
||||
$this->register_route( '', $methods, function ( $request ) use ( $methods ) {
|
||||
return $this->base_callback( $methods, $request, true );
|
||||
} );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register route.
|
||||
*
|
||||
* @param string $route
|
||||
* @param string $methods
|
||||
* @param null $callback
|
||||
* @param array $args
|
||||
*
|
||||
* @return bool
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function register_route( $route = '', $methods = WP_REST_Server::READABLE, $callback = null, $args = [] ) {
|
||||
if ( ! in_array( $methods, self::AVAILABLE_METHODS, true ) ) {
|
||||
throw new \Exception( 'Invalid method.' );
|
||||
}
|
||||
|
||||
$route = $this->get_base_route() . $route;
|
||||
|
||||
return register_rest_route( $this->controller->get_namespace(), $route, [
|
||||
[
|
||||
'args' => $args,
|
||||
'methods' => $methods,
|
||||
'callback' => $callback,
|
||||
'permission_callback' => function ( $request ) {
|
||||
return $this->get_permission_callback( $request );
|
||||
},
|
||||
],
|
||||
] );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
namespace Elementor\Data\Base;
|
||||
|
||||
abstract class Processor {
|
||||
|
||||
/**
|
||||
* Controller.
|
||||
*
|
||||
* @var \Elementor\Data\Base\Controller
|
||||
*/
|
||||
private $controller;
|
||||
|
||||
/**
|
||||
* Processor constructor.
|
||||
*
|
||||
* @param \Elementor\Data\Base\Controller $controller
|
||||
*/
|
||||
public function __construct( $controller ) {
|
||||
$this->controller = $controller;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get processor command.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
abstract public function get_command();
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
namespace Elementor\Data\Base\Processor;
|
||||
|
||||
use Elementor\Data\Base\Processor;
|
||||
|
||||
abstract class After extends Processor {
|
||||
|
||||
/**
|
||||
* Get conditions for running processor.
|
||||
*
|
||||
* @param array $args
|
||||
* @param mixed $result
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function get_conditions( $args, $result ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply processor.
|
||||
*
|
||||
* @param $args
|
||||
* @param $result
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
abstract public function apply( $args, $result );
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
<?php
|
||||
namespace Elementor\Data\Base\Processor;
|
||||
|
||||
use Elementor\Data\Base\Processor;
|
||||
|
||||
abstract class Before extends Processor {
|
||||
|
||||
/**
|
||||
* Get conditions for running processor.
|
||||
* @param array $args
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function get_conditions( $args ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply processor.
|
||||
*
|
||||
* @param array $args
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
abstract public function apply( $args );
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
<?php
|
||||
namespace Elementor\Data\Base;
|
||||
|
||||
// TODO: Add test.
|
||||
|
||||
abstract class SubEndpoint extends Endpoint {
|
||||
|
||||
/**
|
||||
* @var Endpoint
|
||||
*/
|
||||
protected $parent_endpoint;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $parent_route = '';
|
||||
|
||||
public function __construct( $parent_route, $parent_endpoint ) {
|
||||
$this->parent_endpoint = $parent_endpoint;
|
||||
$this->parent_route = $parent_route;
|
||||
|
||||
parent::__construct( $this->parent_endpoint->controller );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get parent route.
|
||||
*
|
||||
* @return \Elementor\Data\Base\Endpoint
|
||||
*/
|
||||
public function get_parent() {
|
||||
return $this->parent_endpoint;
|
||||
}
|
||||
|
||||
public function get_base_route() {
|
||||
$controller_name = $this->controller->get_name();
|
||||
|
||||
return $controller_name . '/' . $this->parent_route . $this->get_name();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,423 @@
|
||||
<?php
|
||||
|
||||
namespace Elementor\Data;
|
||||
|
||||
use Elementor\Core\Base\Module as BaseModule;
|
||||
use Elementor\Data\Base\Processor;
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit; // Exit if accessed directly
|
||||
}
|
||||
|
||||
class Manager extends BaseModule {
|
||||
|
||||
const ROOT_NAMESPACE = 'elementor';
|
||||
|
||||
const REST_BASE = '';
|
||||
|
||||
const VERSION = '1';
|
||||
|
||||
/**
|
||||
* @var \WP_REST_Server
|
||||
*/
|
||||
private $server;
|
||||
|
||||
/**
|
||||
* @var boolean
|
||||
*/
|
||||
private $is_internal = false;
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
private $cache = [];
|
||||
|
||||
/**
|
||||
* Loaded controllers.
|
||||
*
|
||||
* @var \Elementor\Data\Base\Controller[]
|
||||
*/
|
||||
public $controllers = [];
|
||||
|
||||
/**
|
||||
* Loaded command(s) format.
|
||||
*
|
||||
* @var string[]
|
||||
*/
|
||||
public $command_formats = [];
|
||||
|
||||
/**
|
||||
* Fix issue with 'Potentially polymorphic call. The code may be inoperable depending on the actual class instance passed as the argument.'.
|
||||
*
|
||||
* @return \Elementor\Core\Base\Module|\Elementor\Data\Manager
|
||||
*/
|
||||
public static function instance() {
|
||||
return ( parent::instance() );
|
||||
}
|
||||
|
||||
public function __construct() {
|
||||
add_action( 'rest_api_init', [ $this, 'register_rest_error_handler' ] );
|
||||
}
|
||||
|
||||
public function get_name() {
|
||||
return 'data-manager';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return \Elementor\Data\Base\Controller[]
|
||||
*/
|
||||
public function get_controllers() {
|
||||
return $this->controllers;
|
||||
}
|
||||
|
||||
private function get_cache( $key ) {
|
||||
return self::get_items( $this->cache, $key );
|
||||
}
|
||||
|
||||
private function set_cache( $key, $value ) {
|
||||
$this->cache[ $key ] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Register controller.
|
||||
*
|
||||
* @param string $controller_class_name
|
||||
*
|
||||
* @return \Elementor\Data\Base\Controller
|
||||
*/
|
||||
public function register_controller( $controller_class_name ) {
|
||||
$controller_instance = new $controller_class_name();
|
||||
|
||||
return $this->register_controller_instance( $controller_instance );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register controller instance.
|
||||
*
|
||||
* @param \Elementor\Data\Base\Controller $controller_instance
|
||||
*
|
||||
* @return \Elementor\Data\Base\Controller
|
||||
*/
|
||||
public function register_controller_instance( $controller_instance ) {
|
||||
// TODO: Validate instance.
|
||||
|
||||
$this->controllers[ $controller_instance->get_name() ] = $controller_instance;
|
||||
|
||||
return $controller_instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Register endpoint format.
|
||||
*
|
||||
* @param string $command
|
||||
* @param string $format
|
||||
*
|
||||
*/
|
||||
public function register_endpoint_format( $command, $format ) {
|
||||
$this->command_formats[ $command ] = rtrim( $format, '/' );
|
||||
}
|
||||
|
||||
public function register_rest_error_handler() {
|
||||
// TODO: Remove - Find better solution.
|
||||
return;
|
||||
|
||||
if ( ! $this->is_internal() ) {
|
||||
$logger_manager = \Elementor\Core\Logger\Manager::instance();
|
||||
|
||||
set_error_handler( [ $logger_manager, 'rest_error_handler' ], E_ALL );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Find controller instance.
|
||||
*
|
||||
* By given command name.
|
||||
*
|
||||
* @param string $command
|
||||
*
|
||||
* @return false|\Elementor\Data\Base\Controller
|
||||
*/
|
||||
public function find_controller_instance( $command ) {
|
||||
$command_parts = explode( '/', $command );
|
||||
$assumed_command_parts = [];
|
||||
|
||||
foreach ( $command_parts as $command_part ) {
|
||||
$assumed_command_parts [] = $command_part;
|
||||
|
||||
foreach ( $this->controllers as $controller_name => $controller ) {
|
||||
$assumed_command = implode( '/', $assumed_command_parts );
|
||||
|
||||
if ( $assumed_command === $controller_name ) {
|
||||
return $controller;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Command extract args.
|
||||
*
|
||||
* @param string $command
|
||||
* @param array $args
|
||||
*
|
||||
* @return \stdClass
|
||||
*/
|
||||
public function command_extract_args( $command, $args = [] ) {
|
||||
$result = new \stdClass();
|
||||
$result->command = $command;
|
||||
$result->args = $args;
|
||||
|
||||
if ( false !== strpos( $command, '?' ) ) {
|
||||
$command_parts = explode( '?', $command );
|
||||
$pure_command = $command_parts[0];
|
||||
$query_string = $command_parts[1];
|
||||
|
||||
parse_str( $query_string, $temp );
|
||||
|
||||
$result->command = rtrim( $pure_command, '/' );
|
||||
$result->args = array_merge( $args, $temp );
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Command to endpoint.
|
||||
*
|
||||
* Format is required otherwise $command will returned.
|
||||
*
|
||||
* @param string $command
|
||||
* @param string $format
|
||||
* @param array $args
|
||||
*
|
||||
* @return string endpoint
|
||||
*/
|
||||
public function command_to_endpoint( $command, $format, $args ) {
|
||||
$endpoint = $command;
|
||||
|
||||
if ( $format ) {
|
||||
$formatted = $format;
|
||||
|
||||
array_walk( $args, function ( $val, $key ) use ( &$formatted ) {
|
||||
$formatted = str_replace( '{' . $key . '}', $val, $formatted );
|
||||
} );
|
||||
|
||||
// Remove remaining format if not requested via `$args`.
|
||||
if ( strstr( $formatted, '/{' ) ) {
|
||||
/**
|
||||
* Example:
|
||||
* $command = 'example/documents';
|
||||
* $format = 'example/documents/{document_id}/elements/{element_id}';
|
||||
* $formatted = 'example/documents/1618/elements/{element_id}';
|
||||
* Result:
|
||||
* $formatted = 'example/documents/1618/elements';
|
||||
*/
|
||||
$formatted = substr( $formatted, 0, strpos( $formatted, '/{' ) );
|
||||
}
|
||||
|
||||
$endpoint = $formatted;
|
||||
}
|
||||
|
||||
return $endpoint;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run server.
|
||||
*
|
||||
* Init WordPress reset api.
|
||||
*
|
||||
* @return \WP_REST_Server
|
||||
*/
|
||||
public function run_server() {
|
||||
/**
|
||||
* If run_server() called means, that rest api is simulated from the backend.
|
||||
*/
|
||||
$this->is_internal = true;
|
||||
|
||||
if ( ! $this->server ) {
|
||||
// Remove all 'rest_api_init' actions.
|
||||
remove_all_actions( 'rest_api_init' );
|
||||
|
||||
// Call custom reset api loader.
|
||||
do_action( 'elementor_rest_api_before_init' );
|
||||
|
||||
$this->server = rest_get_server(); // Init API.
|
||||
}
|
||||
|
||||
return $this->server;
|
||||
}
|
||||
|
||||
/**
|
||||
* Kill server.
|
||||
*
|
||||
* Free server and controllers.
|
||||
*/
|
||||
public function kill_server() {
|
||||
global $wp_rest_server;
|
||||
|
||||
$this->controllers = [];
|
||||
$this->command_formats = [];
|
||||
$this->server = false;
|
||||
$this->is_internal = false;
|
||||
$this->cache = [];
|
||||
$wp_rest_server = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run processor.
|
||||
*
|
||||
* @param \Elementor\Data\Base\Processor $processor
|
||||
* @param array $data
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function run_processor( $processor, $data ) {
|
||||
if ( call_user_func_array( [ $processor, 'get_conditions' ], $data ) ) {
|
||||
return call_user_func_array( [ $processor, 'apply' ], $data );
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run processors.
|
||||
*
|
||||
* Filter them by class.
|
||||
*
|
||||
* @param \Elementor\Data\Base\Processor[] $processors
|
||||
* @param string $filter_by_class
|
||||
* @param array $data
|
||||
*
|
||||
* @return false|array
|
||||
*/
|
||||
public function run_processors( $processors, $filter_by_class, $data ) {
|
||||
foreach ( $processors as $processor ) {
|
||||
if ( $processor instanceof $filter_by_class ) {
|
||||
if ( Processor\Before::class === $filter_by_class ) {
|
||||
$this->run_processor( $processor, $data );
|
||||
} elseif ( Processor\After::class === $filter_by_class ) {
|
||||
$result = $this->run_processor( $processor, $data );
|
||||
if ( $result ) {
|
||||
$data[1] = $result;
|
||||
}
|
||||
} else {
|
||||
// TODO: error
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return isset( $data[1] ) ? $data[1] : false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run request.
|
||||
*
|
||||
* Simulate rest API from within the backend.
|
||||
* Use args as query.
|
||||
*
|
||||
* @param string $endpoint
|
||||
* @param array $args
|
||||
* @param string $method
|
||||
*
|
||||
* @return \WP_REST_Response
|
||||
*/
|
||||
private function run_request( $endpoint, $args, $method ) {
|
||||
$this->run_server();
|
||||
|
||||
$endpoint = '/' . self::ROOT_NAMESPACE . '/v' . self::VERSION . '/' . $endpoint;
|
||||
|
||||
// Run reset api.
|
||||
$request = new \WP_REST_Request( $method, $endpoint );
|
||||
|
||||
if ( 'GET' === $method ) {
|
||||
$request->set_query_params( $args );
|
||||
} else {
|
||||
$request->set_body_params( $args );
|
||||
}
|
||||
|
||||
return rest_do_request( $request );
|
||||
}
|
||||
|
||||
/**
|
||||
* Run endpoint.
|
||||
*
|
||||
* Wrapper for `$this->run_request` return `$response->getData()` instead of `$response`.
|
||||
*
|
||||
* @param string $endpoint
|
||||
* @param array $args
|
||||
* @param string $method
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function run_endpoint( $endpoint, $args = [], $method = 'GET' ) {
|
||||
$response = $this->run_request( $endpoint, $args, $method );
|
||||
|
||||
return $response->get_data();
|
||||
}
|
||||
|
||||
/**
|
||||
* Run ( simulated reset api ).
|
||||
*
|
||||
* Do:
|
||||
* Init reset server.
|
||||
* Run before processors.
|
||||
* Run command as reset api endpoint from internal.
|
||||
* Run after processors.
|
||||
*
|
||||
* @param string $command
|
||||
* @param array $args
|
||||
* @param string $method
|
||||
*
|
||||
* @return array|false processed result
|
||||
*/
|
||||
public function run( $command, $args = [], $method = 'GET' ) {
|
||||
$key = crc32( $command . '-' . wp_json_encode( $args ) . '-' . $method );
|
||||
$cache = $this->get_cache( $key );
|
||||
|
||||
if ( $cache ) {
|
||||
return $cache;
|
||||
}
|
||||
|
||||
$this->run_server();
|
||||
|
||||
$controller_instance = $this->find_controller_instance( $command );
|
||||
|
||||
if ( ! $controller_instance ) {
|
||||
$this->set_cache( $key, [] );
|
||||
return [];
|
||||
}
|
||||
|
||||
$extracted_command = $this->command_extract_args( $command, $args );
|
||||
$command = $extracted_command->command;
|
||||
$args = $extracted_command->args;
|
||||
|
||||
$format = isset( $this->command_formats[ $command ] ) ? $this->command_formats[ $command ] : false;
|
||||
|
||||
$command_processors = $controller_instance->get_processors( $command );
|
||||
|
||||
$endpoint = $this->command_to_endpoint( $command, $format, $args );
|
||||
|
||||
$this->run_processors( $command_processors, Processor\Before::class, [ $args ] );
|
||||
|
||||
$response = $this->run_request( $endpoint, $args, $method );
|
||||
$result = $response->get_data();
|
||||
|
||||
if ( $response->is_error() ) {
|
||||
$this->set_cache( $key, [] );
|
||||
return [];
|
||||
}
|
||||
|
||||
$result = $this->run_processors( $command_processors, Processor\After::class, [ $args, $result ] );
|
||||
|
||||
$this->set_cache( $key, $result );
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function is_internal() {
|
||||
return $this->is_internal;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user