Configs.php — Advanced Access Manager – Access Governance for WordPress trunk

advanced-access-manager / application / Restful / Configs.php

advanced-access-manager / application / Restful Last commit date

AccessDeniedRedirect.php 1 year ago AdminToolbar.php 1 year ago ApiRoute.php 1 year ago BackendMenu.php 1 year ago BackwardCompatibility.php 1 year ago Capability.php 1 year ago Configs.php 5 months ago Content.php 1 year ago Identity.php 1 year ago Jwt.php 5 months ago LoginRedirect.php 1 year ago LogoutRedirect.php 1 year ago Metabox.php 1 year ago Mu.php 1 year ago NotFoundRedirect.php 1 year ago Policies.php 1 year ago Roles.php 1 year ago SecureLogin.php 1 year ago SecurityAudit.php 1 year ago ServiceTrait.php 1 year ago Settings.php 1 year ago Urls.php 1 year ago Users.php 1 year ago Widgets.php 1 year ago

Configs.php

315 lines

1	<?php
2
3	/**
4	* ======================================================================
5	* LICENSE: This file is subject to the terms and conditions defined in *
6	* file 'license.txt', which is part of this source code package. *
7	* ======================================================================
8	*/
9
10	/**
11	* RESTful API for the Configurations service
12	*
13	* @package AAM
14	* @version 7.0.0
15	*/
16	class AAM_Restful_Configs
17	{
18
19	use AAM_Restful_ServiceTrait;
20
21	/**
22	* Necessary permissions to access endpoint
23	*
24	* @version 7.0.0
25	*/
26	const PERMISSIONS = [
27	'aam_manager',
28	'aam_manage_configs'
29	];
30
31	/**
32	* Constructor
33	*
34	* @return void
35	* @access protected
36	*
37	* @version 7.0.0
38	*/
39	protected function __construct()
40	{
41	// Register API endpoint
42	add_action('rest_api_init', function() {
43	// Get list of all AAM configurations explicitly defined
44	$this->_register_route('/configs', array(
45	'methods' => WP_REST_Server::READABLE,
46	'callback' => array($this, 'get_configurations'),
47	), self::PERMISSIONS, false);
48
49	// Get a single configuration
50	$this->_register_route('/config/(?P<key>[\w\.]+)', array(
51	'methods' => WP_REST_Server::READABLE,
52	'callback' => array($this, 'get_configuration'),
53	'args' => array(
54	'key' => array(
55	'description' => 'Configuration key',
56	'type' => 'string',
57	'required' => true
58	)
59	)
60	), self::PERMISSIONS, false);
61
62	// Get ConfigPress
63	$this->_register_route('/configpress', array(
64	'methods' => WP_REST_Server::READABLE,
65	'callback' => array($this, 'get_configpress')
66	), self::PERMISSIONS, false);
67
68	// Set config
69	$this->_register_route('/config/(?P<key>[\w\.]+)', array(
70	'methods' => WP_REST_Server::CREATABLE,
71	'callback' => array($this, 'set_configuration'),
72	'args' => array(
73	'key' => array(
74	'description' => 'Configuration key',
75	'type' => 'string',
76	'required' => true
77	),
78	'value' => array(
79	'description' => 'Configuration value',
80	'type' => [
81	'string',
82	'number',
83	'boolean'
84	],
85	'required' => true
86	)
87	)
88	), self::PERMISSIONS, false);
89
90	// Set ConfigPress
91	$this->_register_route('/configpress', array(
92	'methods' => WP_REST_Server::CREATABLE,
93	'callback' => array($this, 'set_configpress'),
94	'args' => array(
95	'ini' => array(
96	'description' => 'ConfigPress INI',
97	'type' => 'string',
98	'required' => false
99	)
100	)
101	), self::PERMISSIONS, false);
102
103	// Reset AAM configurations
104	$this->_register_route('/configs', array(
105	'methods' => WP_REST_Server::DELETABLE,
106	'callback' => array($this, 'reset_configurations')
107	), self::PERMISSIONS, false);
108
109	// Reset AAM ConfigPress
110	$this->_register_route('/configpress', array(
111	'methods' => WP_REST_Server::DELETABLE,
112	'callback' => array($this, 'reset_configpress')
113	), self::PERMISSIONS, false);
114	});
115	}
116
117	/**
118	* Get all defined configurations
119	*
120	* @return WP_REST_Response
121	* @access public
122	*
123	* @version 7.0.0
124	*/
125	public function get_configurations()
126	{
127	try {
128	$result = AAM::api()->config->get();
129	} catch (Exception $e) {
130	$result = $this->_prepare_error_response($e);
131	}
132
133	return rest_ensure_response($result);
134	}
135
136	/**
137	* Get a single configuration
138	*
139	* @param WP_REST_Request $request
140	*
141	* @return WP_REST_Response
142	* @access public
143	*
144	* @version 7.0.0
145	*/
146	public function get_configuration(WP_REST_Request $request)
147	{
148	try {
149	$key = $request->get_param('key');
150	$result = [
151	$key => AAM::api()->config->get($key)
152	];
153	} catch (Exception $e) {
154	$result = $this->_prepare_error_response($e);
155	}
156
157	return rest_ensure_response($result);
158	}
159
160	/**
161	* Get ConfigPress
162	*
163	* @return WP_REST_Response
164	* @access public
165	*
166	* @version 7.0.0
167	*/
168	public function get_configpress()
169	{
170	try {
171	// Read stored ConfigPress from DB
172	$raw = AAM::api()->db->read(AAM_Service_Core::DB_OPTION);
173
174	if (!empty($raw)) {
175	$parsed = parse_ini_string($raw, true, INI_SCANNER_TYPED);
176	$parsed = !empty($parsed['aam']) ? $parsed['aam'] : [];
177	} else {
178	$parsed = [];
179	}
180
181	$result = [
182	'ini' => empty($raw) ? '[aam]' : $raw,
183	'parsed' => $parsed
184	];
185	} catch (Exception $e) {
186	$result = $this->_prepare_error_response($e);
187	}
188
189	return rest_ensure_response($result);
190	}
191
192	/**
193	* Set configuration
194	*
195	* @param WP_REST_Request $request
196	*
197	* @return WP_REST_Response
198	* @access public
199	*
200	* @version 7.0.0
201	*/
202	public function set_configuration(WP_REST_Request $request)
203	{
204	try {
205	$key = $request->get_param('key');
206	$value = $request->get_param('value');
207
208	// Normalize the configuration value
209	if (in_array($value, [ 'true', 'false' ], true)) {
210	$value = filter_var($value, FILTER_VALIDATE_BOOLEAN);
211	} elseif (is_numeric($value)) {
212	$value = intval($value);
213	}
214
215	$status = AAM::api()->config->set($key, $value);
216
217	if ($status) {
218	$result = [
219	$key => AAM::api()->config->get($key)
220	];
221	}
222	} catch (Exception $e) {
223	$result = $this->_prepare_error_response($e);
224	}
225
226	return rest_ensure_response($result);
227	}
228
229	/**
230	* Set ConfigPress
231	*
232	* @param WP_REST_Request $request
233	*
234	* @return WP_REST_Response
235	* @access public
236	*
237	* @version 7.1.0
238	*/
239	public function set_configpress(WP_REST_Request $request)
240	{
241	try {
242	$raw = $request->get_param('ini');
243
244	if (!empty($raw)) {
245	$parsed = parse_ini_string($raw, true, INI_SCANNER_TYPED);
246	} else {
247	$parsed = [];
248	}
249
250	if (empty($parsed)) { // If empty - delete ConfigPress settings
251	$result = AAM::api()->db->delete(AAM_Service_Core::DB_OPTION);
252	} else {
253	$result = AAM::api()->db->write(
254	AAM_Service_Core::DB_OPTION, $raw
255	);
256	}
257
258	if ($result) {
259	$result = [
260	'ini' => $raw,
261	'parsed' => $parsed
262	];
263	}
264	} catch (Exception $e) {
265	$result = $this->_prepare_error_response($e);
266	}
267
268	return rest_ensure_response($result);
269	}
270
271	/**
272	* Reset all configurations
273	*
274	* @return WP_REST_Response
275	* @access public
276	*
277	* @version 7.0.0
278	*/
279	public function reset_configurations()
280	{
281	try {
282	$result = [
283	'success' => AAM::api()->config->reset()
284	];
285	} catch (Exception $e) {
286	$result = $this->_prepare_error_response($e);
287	}
288
289	return rest_ensure_response($result);
290	}
291
292	/**
293	* Reset all configurations
294	*
295	* @return WP_REST_Response
296	* @access public
297	*
298	* @version 7.0.0
299	*/
300	public function reset_configpress()
301	{
302	try {
303	$result = [
304	'success' => AAM::api()->db->delete(
305	AAM_Service_Core::DB_OPTION
306	)
307	];
308	} catch (Exception $e) {
309	$result = $this->_prepare_error_response($e);
310	}
311
312	return rest_ensure_response($result);
313	}
314
315	}