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

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

368 lines 9.4 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 $this->controller->get_items( $request );
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 $this->controller->get_item( $request );
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 $this->controller->create_item( $request );
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 $this->controller->update_item( $request );
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 $this->controller->delete_item( $request );
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, $callback = null, $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	return register_rest_route( $this->controller->get_namespace(), $route, [
222	[
223	'args' => $args,
224	'methods' => $methods,
225	'callback' => $callback,
226	'permission_callback' => function ( $request ) {
227	return $this->get_permission_callback( $request );
228	},
229	],
230	] );
231	}
232
233	/**
234	* Register items route.
235	*
236	* @param string $methods
237	* @param array $args
238	*/
239	public function register_items_route( $methods = WP_REST_Server::READABLE, $args = [] ) {
240	$this->register_route( '', $methods, function ( $request ) use ( $methods ) {
241	return $this->base_callback( $methods, $request, true );
242	}, $args );
243	}
244
245	/**
246	* Register item route.
247	*
248	* @param string $route
249	* @param array $args
250	* @param string $methods
251	*/
252	public function register_item_route( $methods = WP_REST_Server::READABLE, $args = [], $route = '/' ) {
253	if ( ! empty( $args['id_arg_name'] ) ) {
254	$this->id_arg_name = $args['id_arg_name'];
255
256	unset( $args['id_arg_name'] );
257	}
258
259	if ( ! empty( $args['id_arg_type_regex'] ) ) {
260	$this->id_arg_type_regex = $args['id_arg_type_regex'];
261
262	unset( $args['id_arg_type_regex'] );
263	}
264
265	$args = array_merge( [
266	$this->id_arg_name => [
267	'description' => 'Unique identifier for the object.',
268	'type' => 'string',
269	'required' => true,
270	],
271	], $args );
272
273	$route .= '(?P<' . $this->id_arg_name . '>' . $this->id_arg_type_regex . ')';
274
275	$this->item_route = [
276	'args' => $args,
277	'route' => $route,
278	];
279
280	$this->register_route( $route, $methods, function ( $request ) use ( $methods ) {
281	return $this->base_callback( $methods, $request );
282	}, $args );
283	}
284
285	/**
286	* Base callback.
287	* All reset requests from the client should pass this function.
288	*
289	* @param string $methods
290	* @param \WP_REST_Request $request
291	* @param bool $is_multi
292	* @param array $args
293	*
294	* @return mixed\|\WP_Error\|\WP_HTTP_Response\|\WP_REST_Response
295	*/
296	public function base_callback( $methods, $request, $is_multi = false, $args = [] ) {
297	if ( $request ) {
298	$json_params = $request->get_json_params();
299
300	if ( $json_params ) {
301	$request->set_body_params( $json_params );
302	}
303	}
304
305	$args = wp_parse_args( $args, [
306	'is_debug' => defined( 'WP_DEBUG' ),
307	] );
308
309	$result = [];
310
311	if ( $this->get_permission_callback( $request ) ) {
312	try {
313	switch ( $methods ) {
314	case WP_REST_Server::READABLE:
315	$result = $is_multi ? $this->get_items( $request ) : $this->get_item( $request->get_param( 'id' ), $request );
316	break;
317
318	case WP_REST_Server::CREATABLE:
319	$result = $is_multi ? $this->create_items( $request ) : $this->create_item( $request->get_param( 'id' ), $request );
320	break;
321
322	case WP_REST_Server::EDITABLE:
323	$result = $is_multi ? $this->update_items( $request ) : $this->update_item( $request->get_param( 'id' ), $request );
324	break;
325
326	case WP_REST_Server::DELETABLE:
327	$result = $is_multi ? $this->delete_items( $request ) : $this->delete_item( $request->get_param( 'id' ), $request );
328	break;
329	}
330	} catch ( Data_Exception $e ) {
331	$result = $e->to_wp_error();
332	} catch ( \Exception $e ) {
333	if ( empty( $args['is_debug'] ) ) {
334	$result = ( new Error_500() )->to_wp_error();
335	} else {
336	// For frontend.
337	$exception_mapping = [
338	'trace' => $e->getTrace(),
339	'file' => $e->getFile(),
340	'line' => $e->getLine(),
341	];
342
343	$e->debug = $exception_mapping;
344
345	$result = ( new Data_Exception( $e->getMessage(), $e->getCode(), $e ) )->to_wp_error();
346	}
347	}
348	}
349
350	return rest_ensure_response( $result );
351	}
352
353	/**
354	* Constructor.
355	*
356	* run `$this->register()`.
357	*
358	* @param \Elementor\Data\V2\Base\Controller $controller
359	* @param string $route
360	*/
361	protected function __construct( Controller $controller, $route ) {
362	$this->controller = $controller;
363	$this->route = $this->ensure_slashes( $route );
364
365	$this->register();
366	}
367	}
368