RestServiceProvider.php — SureCart – Ecommerce Made Easy For Selling Physical Products, Digital Downloads, Subscriptions, Donations, & Payments 1.4.0

surecart / app / src / Rest / RestServiceProvider.php

surecart / app / src / Rest Last commit date

RestServiceProvider.php

298 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Models\Model;
6	use SureCart\Rest\RestServiceInterface;
7
8	/**
9	* Abstract Rest Service Provider interface
10	*/
11	abstract class RestServiceProvider extends \WP_REST_Controller implements RestServiceInterface {
12	/**
13	* Mark specific properties that need additional permissions checks
14	* before modifying. We don't want customers being able to modify these.
15	*
16	* @var array
17	*/
18	protected $property_permissions = [];
19
20	/**
21	* Plugin namespace.
22	*
23	* @var string
24	*/
25	protected $name = 'surecart';
26
27	/**
28	* API Version
29	*
30	* @var string
31	*/
32	protected $version = '1';
33
34	/**
35	* Endpoint.
36	*
37	* @var string
38	*/
39	protected $endpoint = '';
40
41	/**
42	* Controller class
43	*
44	* @var string
45	*/
46	protected $controller = '';
47
48	/**
49	* Methods allowed for the model.
50	*
51	* @var array
52	*/
53	protected $methods = [ 'index', 'create', 'find', 'edit', 'delete' ];
54
55	/**
56	* {@inheritDoc}
57	*
58	* @param \Pimple\Container $container Service Container.
59	*/
60	public function register( $container ) {
61	// nothing to register.
62	}
63
64	/**
65	* Bootstrap routes
66	*
67	* @param \Pimple\Container $container Service Container.
68	*
69	* @return void
70	*/
71	public function bootstrap( $container ) {
72	add_action( 'rest_api_init', [ $this, 'registerModelRoutes' ] );
73	}
74
75	/**
76	* Do we have the method
77	*
78	* @param string $name
79	* @return boolean
80	*/
81	public function hasMethod( $name ) {
82	return in_array( $name, $this->methods, true );
83	}
84
85	/**
86	* Do we have all these methods.
87	*
88	* @param array $methods Array of method names.
89	* @return boolean
90	*/
91	public function hasAnyMethods( $methods = [] ) {
92	foreach ( $methods as $method ) {
93	if ( $this->hasMethod( $method ) ) {
94	return true;
95	}
96	}
97	return false;
98	}
99
100	/**
101	* Register REST Routes
102	*
103	* @return void
104	*/
105	public function registerModelRoutes() {
106	if ( $this->hasAnyMethods( [ 'index', 'create' ] ) ) {
107	register_rest_route(
108	"$this->name/v$this->version",
109	"$this->endpoint",
110	array_filter(
111	[
112	( $this->hasMethod( 'index' ) ? [
113	'methods' => \WP_REST_Server::READABLE,
114	'callback' => $this->callback( $this->controller, 'index' ),
115	'permission_callback' => [ $this, 'get_items_permissions_check' ],
116	'args' => $this->get_collection_params(),
117	] : [] ),
118	( $this->hasMethod( 'create' ) ? [
119	'methods' => \WP_REST_Server::CREATABLE,
120	'callback' => $this->callback( $this->controller, 'create' ),
121	'permission_callback' => [ $this, 'create_item_permissions_check' ],
122	] : [] ),
123	'schema' => [ $this, 'get_item_schema' ],
124	]
125	)
126	);
127	}
128
129	if ( $this->hasAnyMethods( [ 'find', 'edit', 'delete' ] ) ) {
130	register_rest_route(
131	"$this->name/v$this->version",
132	$this->endpoint . '/(?P<id>[^/]+)',
133	array_filter(
134	[
135	( $this->hasMethod( 'find' ) ? [
136	'methods' => \WP_REST_Server::READABLE,
137	'callback' => $this->callback( $this->controller, 'find' ),
138	'permission_callback' => [ $this, 'get_item_permissions_check' ],
139	] : [] ),
140	( $this->hasMethod( 'edit' ) ? [
141	'methods' => \WP_REST_Server::EDITABLE,
142	'callback' => $this->callback( $this->controller, 'edit' ),
143	'permission_callback' => [ $this, 'update_item_permissions_check' ],
144	] : [] ),
145	( $this->hasMethod( 'delete' ) ? [
146	'methods' => \WP_REST_Server::DELETABLE,
147	'callback' => $this->callback( $this->controller, 'delete' ),
148	'permission_callback' => [ $this, 'delete_item_permissions_check' ],
149	] : [] ),
150	// Register our schema callback.
151	'schema' => [ $this, 'get_item_schema' ],
152	]
153	)
154	);
155	}
156
157	$this->registerRoutes();
158	}
159
160	/**
161	* Additional routes to register for the model.
162	*
163	* @return void
164	*/
165	public function registerRoutes() {
166	}
167
168	/**
169	* Process the callback for the route.
170	*
171	* @param string $class Class name.
172	* @param string $method Class method.
173	* @return callback
174	*/
175	public function callback( $class, $method ) {
176	// litespeed caching bypass.
177	do_action( 'litespeed_control_set_nocache', 'surecart api request' );
178
179	return function ( $request ) use ( $class, $method ) {
180	// get and call controller with request.
181	$controller = \SureCart::closure()->method( $class, $method );
182	$model = $controller( $request );
183
184	// check and filter context.
185	$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
186
187	if ( is_wp_error( $model ) ) {
188	return $model;
189	}
190
191	// if we are editing, creating, deleting, we are in an edit context. No need to pass the context.
192	if ( in_array( $method, [ 'edit', 'create', 'delete' ], true ) ) {
193	$context = 'edit';
194	}
195
196	// remove wp_created_by to prevent user ids from being leaked.
197	if ( 'edit' !== $context && ! empty( $model->metadata->wp_created_by ) ) {
198	unset( $model->metadata->wp_created_by );
199	}
200
201	$response = rest_ensure_response( $this->filter_response_by_context( is_a( $model, Model::class ) ? $model->toArray() : $model, $context ) );
202
203	if ( is_a( $model, Model::class ) ) {
204	$response->header( 'X-SURECART-CACHE-STATUS', $model->getCacheStatus() );
205	}
206
207	return $response;
208	};
209	}
210
211	/**
212	* Check permissions for specific properties of the request.
213	*
214	* @param \WP_REST_Request $request Full details about the request.
215	* @param array $keys Keys to check.
216	*
217	* @return boolean
218	*/
219	protected function requestOnlyHasKeys( $request, $keys ) {
220	$keys = array_merge( $keys, [ 'context', '_locale', 'rest_route', 'id', 'expand' ] );
221	foreach ( $request->get_params() as $key => $value ) {
222	if ( ! in_array( $key, $keys, true ) ) {
223	return false;
224	}
225	}
226	return true;
227	}
228
229	/**
230	* Retrieves the query params for collections.
231	*
232	* @return array
233	*/
234	public function get_collection_params() {
235	return [];
236	}
237
238	/**
239	* Set these all as false by default
240	* in case parent class doesn't implement them.
241	*
242	* @param \WP_REST_Request $request Full details about the request.
243	*
244	* @return false
245	*/
246	public function get_item_permissions_check( $request ) {
247	return false;
248	}
249
250	/**
251	* Set these all as false by default
252	* in case parent class doesn't implement them.
253	*
254	* @param \WP_REST_Request $request Full details about the request.
255	*
256	* @return false
257	*/
258	public function get_items_permissions_check( $request ) {
259	return false;
260	}
261
262	/**
263	* Set these all as false by default
264	* in case parent class doesn't implement them.
265	*
266	* @param \WP_REST_Request $request Full details about the request.
267	*
268	* @return false
269	*/
270	public function create_item_permissions_check( $request ) {
271	return false;
272	}
273
274	/**
275	* Set these all as false by default
276	* in case parent class doesn't implement them.
277	*
278	* @param \WP_REST_Request $request Full details about the request.
279	*
280	* @return false
281	*/
282	public function update_item_permissions_check( $request ) {
283	return false;
284	}
285
286	/**
287	* Set these all as false by default
288	* in case parent class doesn't implement them.
289	*
290	* @param \WP_REST_Request $request Full details about the request.
291	*
292	* @return false
293	*/
294	public function delete_item_permissions_check( $request ) {
295	return false;
296	}
297	}
298