elementor / data / v2 / base / base-route.php

base-route.php in Elementor Website Builder – more than just a page builder 3.24.5, at data/v2/base/base-route.php

381 lines 10.3 KB

Raw Download Zip

1	<?php
2	namespace Elementor\Data\V2\Base;
3
4	use Elementor\Data\V2\Base\Exceptions\Data_Exception;
5	use Elementor\Data\V2\Base\Exceptions\Error_500;
6	use WP_REST_Server;
7
8	if ( ! defined( 'ABSPATH' ) ) {
9	exit; // Exit if accessed directly
10	}
11
12	/**
13	* Class purpose is to separate routing logic into one file.
14	*/
15	abstract class Base_Route {
16	const AVAILABLE_METHODS = [
17	WP_REST_Server::READABLE,
18	WP_REST_Server::CREATABLE,
19	WP_REST_Server::EDITABLE,
20	WP_REST_Server::DELETABLE,
21	WP_REST_Server::ALLMETHODS,
22	];
23
24	/**
25	* Controller of current endpoint.
26	*
27	* @var \Elementor\Data\V2\Base\Controller
28	*/
29	protected $controller;
30
31	/**
32	* Current route, effect only in case the endpoint behave like sub-endpoint.
33	*
34	* @var string
35	*/
36	protected $route;
37
38	/**
39	* All register routes.
40	*
41	* @var array
42	*/
43	protected $routes = [];
44
45	/**
46	* Registered item route.
47	*
48	* @var array\|null
49	*/
50	protected $item_route = null;
51
52	protected $id_arg_name = 'id';
53	protected $id_arg_type_regex = '[\d]+';
54
55	/**
56	* Ensure start-with and end-with slashes.
57	*
58	* '/' => '/'
59	* 'abc' => '/abc/'
60	* '/abc' => '/abc/'
61	* 'abc/' => '/abc/'
62	* '/abc/' => '/abc/'
63	*
64	* @param string $route
65	*
66	* @return string
67	*/
68	private function ensure_slashes( $route ) {
69	if ( '/' !== $route[0] ) {
70	$route = '/' . $route;
71	}
72
73	return trailingslashit( $route );
74	}
75
76	/**
77	* Get base route.
78	* This method should always return the base route starts with '/' and ends without '/'.
79	*
80	* @return string
81	*/
82	public function get_base_route() {
83	$name = $this->get_public_name();
84	$parent = $this->get_parent();
85	$parent_base = $parent->get_base_route();
86	$route = '/';
87
88	if ( ! ( $parent instanceof Controller ) ) {
89	$route = $parent->item_route ? $parent->item_route['route'] . '/' : $this->route;
90	}
91
92	return untrailingslashit( '/' . trim( $parent_base . $route . $name, '/' ) );
93	}
94
95	/**
96	* Get permission callback.
97	*
98	* By default get permission callback from the controller.
99	*
100	* @param \WP_REST_Request $request Full data about the request.
101	*
102	* @return boolean
103	*/
104	public function get_permission_callback( $request ) {
105	return $this->controller->get_permission_callback( $request );
106	}
107
108	/**
109	* Retrieves a collection of items.
110	*
111	* @param \WP_REST_Request $request Full data about the request.
112	*
113	* @return \WP_Error\|\WP_REST_Response Response object on success, or WP_Error object on failure.
114	*/
115	protected function get_items( $request ) {
116	return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );
117	}
118
119	/**
120	* Retrieves one item from the collection.
121	*
122	* @param string $id
123	* @param \WP_REST_Request $request Full data about the request.
124	*
125	* @return \WP_Error\|\WP_REST_Response Response object on success, or WP_Error object on failure.
126	*/
127	protected function get_item( $id, $request ) {
128	return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );
129	}
130
131	/**
132	* Creates multiple items.
133	*
134	* @param \WP_REST_Request $request Full data about the request.
135	*
136	* @return \WP_Error\|\WP_REST_Response Response object on success, or WP_Error object on failure.
137	*/
138	protected function create_items( $request ) {
139	return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );
140	}
141
142	/**
143	* Creates one item.
144	*
145	* @param string $id id of request item.
146	* @param \WP_REST_Request $request Full data about the request.
147	*
148	* @return \WP_Error\|\WP_REST_Response Response object on success, or WP_Error object on failure.
149	*/
150	protected function create_item( $id, $request ) {
151	return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );
152	}
153
154	/**
155	* Updates multiple items.
156	*
157	* @param \WP_REST_Request $request Full data about the request.
158	*
159	* @return \WP_Error\|\WP_REST_Response Response object on success, or WP_Error object on failure.
160	*/
161	protected function update_items( $request ) {
162	return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );
163	}
164
165	/**
166	* Updates one item.
167	*
168	* @param string $id id of request item.
169	* @param \WP_REST_Request $request Full data about the request.
170	*
171	* @return \WP_Error\|\WP_REST_Response Response object on success, or WP_Error object on failure.
172	*/
173	protected function update_item( $id, $request ) {
174	return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );
175	}
176
177	/**
178	* Delete multiple items.
179	*
180	* @param \WP_REST_Request $request Full data about the request.
181	*
182	* @return \WP_Error\|\WP_REST_Response Response object on success, or WP_Error object on failure.
183	*/
184	protected function delete_items( $request ) {
185	return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );
186	}
187
188	/**
189	* Delete one item.
190	*
191	* @param string $id id of request item.
192	* @param \WP_REST_Request $request Full data about the request.
193	*
194	* @return \WP_Error\|\WP_REST_Response Response object on success, or WP_Error object on failure.
195	*/
196	protected function delete_item( $id, $request ) {
197	return new \WP_Error( 'invalid-method', sprintf( "Method '%s' not implemented. Must be overridden in subclass.", __METHOD__ ), [ 'status' => 405 ] );
198	}
199
200	/**
201	* Register the endpoint.
202	*
203	* By default: register get items route.
204	*/
205	protected function register() {
206	$this->register_items_route();
207	}
208
209	protected function register_route( $route = '', $methods = WP_REST_Server::READABLE, $args = [] ) {
210	if ( ! in_array( $methods, self::AVAILABLE_METHODS, true ) ) {
211	trigger_error( "Invalid method: '$methods'.", E_USER_ERROR ); // phpcs:ignore
212	}
213
214	$route = $this->get_base_route() . $route;
215
216	$this->routes [] = [
217	'args' => $args,
218	'route' => $route,
219	];
220
221	/**
222	* Determine behaviour of `base_callback()` and `get_permission_callback()`:
223	* For `base_callback()` which applying the action.
224	* 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()`.
225	*/
226	$is_multi = ! empty( $args['is_multi'] );
227
228	if ( $is_multi ) {
229	unset( $args['is_multi'] );
230	}
231
232	$callback = function ( $request ) use ( $methods, $args, $is_multi ) {
233	return $this->base_callback( $methods, $request, $is_multi );
234	};
235
236	return register_rest_route( $this->controller->get_namespace(), $route, [
237	[
238	'args' => $args,
239	'methods' => $methods,
240	'callback' => $callback,
241	'permission_callback' => function ( $request ) {
242	return $this->get_permission_callback( $request );
243	},
244	],
245	] );
246	}
247
248	/**
249	* Register items route.
250	*
251	* @param string $methods
252	* @param array $args
253	*/
254	public function register_items_route( $methods = WP_REST_Server::READABLE, $args = [] ) {
255	$args['is_multi'] = true;
256
257	$this->register_route( '', $methods, $args );
258	}
259
260	/**
261	* Register item route.
262	*
263	* @param string $route
264	* @param array $args
265	* @param string $methods
266	*/
267	public function register_item_route( $methods = WP_REST_Server::READABLE, $args = [], $route = '/' ) {
268	if ( ! empty( $args['id_arg_name'] ) ) {
269	$this->id_arg_name = $args['id_arg_name'];
270
271	unset( $args['id_arg_name'] );
272	}
273
274	if ( ! empty( $args['id_arg_type_regex'] ) ) {
275	$this->id_arg_type_regex = $args['id_arg_type_regex'];
276
277	unset( $args['id_arg_type_regex'] );
278	}
279
280	$args = array_merge( [
281	$this->id_arg_name => [
282	'description' => 'Unique identifier for the object.',
283	'type' => 'string',
284	'required' => true,
285	],
286	], $args );
287
288	$route .= '(?P<' . $this->id_arg_name . '>' . $this->id_arg_type_regex . ')';
289
290	$this->item_route = [
291	'args' => $args,
292	'route' => $route,
293	];
294
295	$this->register_route( $route, $methods, $args );
296	}
297
298	/**
299	* Base callback.
300	* All reset requests from the client should pass this function.
301	*
302	* @param string $methods
303	* @param \WP_REST_Request $request
304	* @param bool $is_multi
305	* @param array $args
306	*
307	* @return mixed\|\WP_Error\|\WP_HTTP_Response\|\WP_REST_Response
308	*/
309	public function base_callback( $methods, $request, $is_multi = false, $args = [] ) {
310	if ( $request ) {
311	$json_params = $request->get_json_params();
312
313	if ( $json_params ) {
314	$request->set_body_params( $json_params );
315	}
316	}
317
318	$args = wp_parse_args( $args, [
319	'is_debug' => ( defined( 'WP_DEBUG' ) && WP_DEBUG ),
320	] );
321
322	$result = new \WP_Error( 'invalid_methods', 'route not supported.' );
323
324	$request->set_param( 'is_multi', $is_multi );
325
326	try {
327	switch ( $methods ) {
328	case WP_REST_Server::READABLE:
329	$result = $is_multi ? $this->get_items( $request ) : $this->get_item( $request->get_param( 'id' ), $request );
330	break;
331
332	case WP_REST_Server::CREATABLE:
333	$result = $is_multi ? $this->create_items( $request ) : $this->create_item( $request->get_param( 'id' ), $request );
334	break;
335
336	case WP_REST_Server::EDITABLE:
337	$result = $is_multi ? $this->update_items( $request ) : $this->update_item( $request->get_param( 'id' ), $request );
338	break;
339
340	case WP_REST_Server::DELETABLE:
341	$result = $is_multi ? $this->delete_items( $request ) : $this->delete_item( $request->get_param( 'id' ), $request );
342	break;
343	}
344	} catch ( Data_Exception $e ) {
345	$result = $e->to_wp_error();
346	} catch ( \Exception $e ) {
347	if ( empty( $args['is_debug'] ) ) {
348	$result = ( new Error_500() )->to_wp_error();
349	} else {
350	// For frontend.
351	$exception_mapping = [
352	'trace' => $e->getTrace(),
353	'file' => $e->getFile(),
354	'line' => $e->getLine(),
355	];
356
357	$e->debug = $exception_mapping;
358
359	$result = ( new Data_Exception( $e->getMessage(), $e->getCode(), $e ) )->to_wp_error();
360	}
361	}
362
363	return rest_ensure_response( $result );
364	}
365
366	/**
367	* Constructor.
368	*
369	* run `$this->register()`.
370	*
371	* @param \Elementor\Data\V2\Base\Controller $controller
372	* @param string $route
373	*/
374	protected function __construct( Controller $controller, $route ) {
375	$this->controller = $controller;
376	$this->route = $this->ensure_slashes( $route );
377
378	$this->register();
379	}
380	}
381