PluginProbe
WPGet API – Connect to any external REST API / 1.7.0
WPGet API – Connect to any external REST API v1.7.0
1.9.2 1.9.3 1.9.4 1.9.5 1.9.6 1.9.7 1.9.8 1.9.9 2.0.0 2.0.1 2.0.2 2.0.3 2.0.4 2.0.5 2.0.6 2.1.0 2.1.1 2.1.3 2.1.4 2.1.5 2.2.0 2.2.1 2.2.10 2.2.2 2.2.3 All 97 releases
← All changes | includes/class-api.php +138 -453 2.2.31.7.0 View file →
@@ -28,11 +28,8 @@
28 28 public $header_parameters = ''; // the header paramaters
29 29 public $body_parameters = ''; // the body paramaters
30 30 public $body_json_encode = ''; // body_json_encode body
31 31 public $body_url_encode = ''; // urlencode body
32 - public $body_base64_encode = ''; // base64 encode body
33 - public $body_xml_format = ''; // xml format body
34 - public $xml_root_node = 'root'; // root node for xml
35 32
36 33 public $response = ''; // the returned response
37 34
38 35 public $final_url = ''; // final URL
@@ -37,17 +34,13 @@
37 34
38 35 public $final_url = ''; // final URL
39 36 public $final_request_args = array(); // final request_args
40 37
41 - public $results_format = 'json_string'; // results format
38 + public $results_format = 'json_string'; // reseults format
42 39
43 - public $response_code = ''; // the response code from the call
44 -
45 40 public $timeout = 10; // the timeout
46 - public $sslverify = 1; // ssl verify
41 + public $sslverify = 1; // the paramaters
47 42 public $debug = false;
48 -
49 - public $pro_plugin = false;
50 43
51 44
52 45 /**
53 46 * Main constructor
@@ -65,10 +58,9 @@
65 58 $this->endpoint_id = sanitize_text_field( $endpoint_id );
66 59 $this->keys = $keys;
67 60 $this->args = $args;
68 61
69 - add_filter( 'wpgetapi_raw_error_data', array( $this, 'maybe_add_debug_info' ), 99, 2 );
70 - add_filter( 'wpgetapi_raw_data', array( $this, 'maybe_add_debug_info' ), 99, 2 );
62 + add_filter( 'wpgetapi_raw_data', array( $this, 'maybe_add_debug_info' ), 5, 2 );
71 63
72 64 }
73 65
74 66
@@ -76,35 +68,8 @@
76 68 * Init our api data
77 69 */
78 70 public function init() {
79 71
80 - if ( ! function_exists( 'is_plugin_active' ) ) {
81 - include_once( ABSPATH . 'wp-admin/includes/plugin.php' );
82 - }
83 -
84 - $this->pro_plugin = is_plugin_active( 'wpgetapi-extras/wpgetapi-extras.php' ) ? true : false;
85 -
86 - // if we are doing importer plugin,
87 - // we need to intercept and modify most of our methods values
88 - if( $this->api_id === 'wpgetapi_importer' ) {
89 -
90 - $data = apply_filters( 'wpgetapi_api_importer_init', $this );
91 -
92 - if( $data ) {
93 -
94 - foreach ($data as $key => $value) {
95 - $this->{$key} = $value;
96 - }
97 -
98 - $this->query_parameters = ! empty( $this->query_parameters ) ? $this->do_parameters( $this->query_parameters ) : array();
99 - $this->header_parameters = ! empty( $this->header_parameters ) ? $this->do_parameters( $this->header_parameters ) : array();
100 - $this->body_parameters = ! empty( $this->body_parameters ) ? $this->do_parameters( $this->body_parameters ) : array();
101 - return;
102 -
103 - }
104 -
105 - }
106 -
107 72 // do some checks
108 73 if( empty( $this->setup ) || ! isset( $this->setup['apis'] ) || empty( $this->setup['apis'] ) )
109 74 return 'No API found.';
110 75
@@ -123,11 +88,10 @@
123 88 // loop through endpoints
124 89 foreach ( $this->api['endpoints'] as $index => $endpoint ) {
125 90
126 91 if( $this->endpoint_id == $endpoint['id'] ) {
127 -
92 +
128 93 $this->method = isset( $endpoint['method'] ) && $endpoint['method'] != '' ? sanitize_text_field( $endpoint['method'] ) : 'GET';
129 - $this->timeout = isset( $endpoint['timeout'] ) && ! empty( $endpoint['timeout'] ) ? absint( $endpoint['timeout'] ) : '';
130 94 $this->cache_time = isset( $endpoint['cache_time'] ) && ! empty( $endpoint['cache_time'] ) ? absint( $endpoint['cache_time'] ) : '';
131 95 $this->endpoint = isset( $endpoint['endpoint'] ) && ! empty( $endpoint['endpoint'] ) ? sanitize_text_field( $endpoint['endpoint'] ) : '';
132 96
133 97 $this->query_parameters = isset( $endpoint['query_parameters'] ) && ! empty( $endpoint['query_parameters'] ) ? $this->do_parameters( $endpoint['query_parameters'] ) : array();
@@ -135,40 +99,13 @@
135 99 $this->header_parameters = isset( $endpoint['header_parameters'] ) && ! empty( $endpoint['header_parameters'] ) ? $this->do_parameters( $endpoint['header_parameters'] ) : array();
136 100
137 101 $this->body_parameters = isset( $endpoint['body_parameters'] ) && ! empty( $endpoint['body_parameters'] ) ? $this->do_parameters( $endpoint['body_parameters'] ) : array();
138 102
139 - // how to encode the body
140 103 $this->body_json_encode = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'true' ? true : false;
141 104 $this->body_url_encode = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'url' ? true : false;
142 - $this->body_base64_encode = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'base64' ? true : false;
143 - $this->body_xml_format = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'xml' ? true : false;
144 105
145 - $this->xml_root_node = isset( $endpoint['xml_root'] ) && ! empty( $endpoint['xml_root'] ) ? $endpoint['xml_root'] : $this->xml_root_node;
146 -
147 106 $this->results_format = isset( $endpoint['results_format'] ) ? sanitize_text_field( $endpoint['results_format'] ) : $this->results_format;
148 -
149 -
150 - if(
151 - // set the format to php array data if html format is set
152 - ( isset( $this->args['format'] ) && $this->args['format'] == 'html' && $this->results_format != 'xml_array' ) ||
153 - // set the format to php array data if it is set in the args (coming from the importer)
154 - ( isset( $this->args['results_format'] ) && $this->args['results_format'] == 'json_decoded' )
155 - ) {
156 - $this->results_format = 'json_decoded';
157 - }
158 -
159 - // set the format to JSON string if it is set in the args (coming from the wpdatatables integration)
160 - if( isset( $this->args['results_format'] ) && $this->args['results_format'] == 'json_string' ) {
161 - $this->results_format = 'json_string';
162 - }
163 -
164 - // set the format to JSON string if it is set in the args (coming from the wpdatatables integration)
165 - if( isset( $this->args['results_format'] ) && $this->args['results_format'] == 'json_decoded' ) {
166 - $this->results_format = 'json_decoded';
167 - }
168 -
169 107 }
170 -
171 108 }
172 109
173 110 $this->timeout = isset( $this->api['timeout'] ) && ! empty( $this->api['timeout'] ) ? $this->api['timeout'] : $this->timeout;
174 111 $this->sslverify = isset( $this->api['sslverify'] ) ? absint( $this->api['sslverify'] ) : $this->sslverify;
@@ -181,21 +118,58 @@
181 118 *
182 119 * @param string $field Field to retrieve
183 120 */
184 121 public function endpoint_output() {
122 + return $this->do_the_call();
123 + }
185 124
186 - do_action( 'wpgetapi_before_do_the_call', $this );
187 125
188 - return $this->do_the_call();
126 + /**
127 + * Sort out the parameters if they exist
128 + */
129 + public function do_parameters( $parameters ) {
130 +
131 + $new_array = array();
132 + $parameters = $this->decrypt($parameters);
189 133
134 + if( is_array( $parameters ) ) {
135 + foreach ( $parameters as $key => $parameter ) {
136 + if( ! empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) {
137 + $parameter['value'] = stripslashes( $parameter['value'] );
138 + $new_array[ sanitize_text_field( $parameter['name'] ) ] = $parameter['value'];
139 + }
140 + }
141 + }
142 +
143 + // look for array or json string and sort these out - for using such things in shortcode
144 + if( is_array( $new_array ) ) {
145 +
146 + foreach ( $new_array as $key => $value ) {
147 +
148 + // checking if the parameters have a json string
149 + if ( substr( $value, 0, 1 ) === '{' && substr( $value, -1 ) === '}' ) {
150 + $new_array[ $key ] = json_decode( $value, true);
151 + }
152 +
153 + // checking if the parameters have an array within the string
154 + // if they do, create them as an actual array
155 + if ( substr( $value, 0, 1 ) === '[' && substr( $value, -1 ) === ']' ) {
156 + $new_array[ $key ] = array( $value );
157 + }
158 +
159 + }
160 +
161 + }
162 +
163 + return $new_array;
164 +
190 165 }
191 166
192 -
193 167 /**
194 168 * Send the request and return our data
195 169 */
196 170 public function do_the_call() {
197 -
171 +
198 172 $this->init();
199 173
200 174 // build the URL
201 175 $this->final_url = apply_filters( 'wpgetapi_final_url', $this->build_url(), $this );
@@ -201,18 +175,9 @@
201 175 $this->final_url = apply_filters( 'wpgetapi_final_url', $this->build_url(), $this );
202 176
203 177 // build the request args
204 178 $this->final_request_args = apply_filters( 'wpgetapi_final_request_args', $this->build_request_args(), $this );
205 -
206 - /**
207 - * Check if we should stop or not. Setting $on to true, will stop us calling the api.
208 - * @param bool $on Whether on is set or not.
209 - */
210 179
211 - if ( apply_filters( 'wpgetapi_should_we_stop', false, $this ) ) {
212 - return;
213 - }
214 -
215 180 // POST request
216 181 if( $this->method == 'POST' )
217 182 $this->response = $this->POST_request();
218 183
@@ -219,20 +184,12 @@
219 184 // PUT request
220 185 if( $this->method == 'PUT' )
221 186 $this->response = $this->PUT_request();
222 187
223 - // PATCH request
224 - if( $this->method == 'PATCH' )
225 - $this->response = $this->PATCH_request();
226 -
227 188 // GET request
228 189 if( $this->method == 'GET' )
229 190 $this->response = $this->GET_request();
230 191
231 - // DELETE request
232 - if( $this->method == 'DELETE' )
233 - $this->response = $this->DELETE_request();
234 -
235 192 // wp error
236 193 if( is_wp_error( $this->response ) ) {
237 194 return apply_filters( 'wpgetapi_raw_error_data', json_encode( $this->response ), $this );
238 195 }
@@ -237,24 +194,21 @@
237 194 return apply_filters( 'wpgetapi_raw_error_data', json_encode( $this->response ), $this );
238 195 }
239 196
240 197 // get response_code
241 - $this->response_code = wp_remote_retrieve_response_code( $this->response );
198 + $response_code = wp_remote_retrieve_response_code( $this->response );
242 199
243 200 // action to intercept call depending on response_code
244 - $this->response = apply_filters( 'wpgetapi_before_retrieve_body', $this->response, $this->response_code, $this );
201 + $this->response = apply_filters( 'wpgetapi_before_retrieve_body', $this->response, $response_code, $this );
245 202
246 203 // get body
247 204 // modified in version 1.6.1 to allow for OAuth 2.0 plugin returning body already
248 205 $data = isset( $this->response['body'] ) ? $this->response['body'] : $this->response;
249 -
206 +
250 207 // returning in JSON format
251 208 if( $this->results_format == 'json_string' || $this->results_format == 'json_decoded' )
252 209 $data = $this->return_data( $data );
253 210
254 - if( $data === 'null' )
255 - $data = 'Result is null. Check that all endpoint settings are correct.';
256 -
257 211 return apply_filters( 'wpgetapi_raw_data', $data, $this );
258 212
259 213 }
260 214
@@ -267,23 +221,10 @@
267 221 // first make sure our endpoint starts with a slash
268 222 if ( substr( $this->endpoint, 0, 1 ) != '/' )
269 223 $this->endpoint = '/' . $this->endpoint;
270 224
271 - // if we have item_key from api to posts plugin
272 - // replace our keyword with the actual item_key value
273 - if ( isset( $this->args['item_key'] ) && strpos( $this->endpoint, '(importer:item_key)' ) !== false ) {
274 - $this->endpoint = str_replace( '(importer:item_key)', $this->args['item_key'], $this->endpoint );
275 - }
276 -
277 - $this->endpoint = apply_filters( 'wpgetapi_endpoint', $this->endpoint, $this );
278 -
279 225 $url = untrailingslashit( $this->base_url ) . $this->endpoint;
280 226
281 - // if we have a URL pagination event from the import plugin
282 - // we need to modify the URL here
283 - if( isset( $this->args['paginate_url'] ) )
284 - $url = $this->args['paginate_url'];
285 -
286 227 // filter our params - added for use in Oauth 2.0 plugin
287 228 $params = apply_filters( 'wpgetapi_query_parameters', $this->query_parameters, $this );
288 229
289 230 // add empty array - was getting errors if it was just null or false
@@ -288,12 +229,10 @@
288 229
289 230 // add empty array - was getting errors if it was just null or false
290 231 $params = empty( $params ) ? array(''=>'') : $params;
291 232
292 - $result = add_query_arg( $params, $url );
233 + return add_query_arg( $params, $url );
293 234
294 - return $result;
295 -
296 235 }
297 236
298 237
299 238 /**
@@ -307,60 +246,26 @@
307 246 ), $this );
308 247
309 248
310 249 // if doing POST request, include body paramters
311 - if( $this->method == 'POST' || $this->method == 'PUT' || $this->method == 'DELETE' || $this->method == 'PATCH' ) {
250 + if( $this->method == 'POST' || $this->method == 'PUT' ) {
251 +
252 + $this->body_parameters = apply_filters( 'wpgetapi_body_parameters', $this->body_parameters, $this );
312 253
313 - // tokens are sent through here
314 - $this->body_parameters = apply_filters( 'wpgetapi_body_parameters', $this->body_parameters, $this );
315 -
316 - // do we json_encode the entire body
317 - if( $this->body_json_encode == true ) {
254 + // do we json_encode the entire body as a string
255 + if( $this->body_json_encode == true )
318 256 $this->body_parameters = json_encode( $this->body_parameters );
319 - }
320 257
321 - // do we urlencode the entire body
322 - if( $this->body_parameters && $this->body_url_encode == true ) {
323 -
324 - // checking if the parameters have a json string (raw)
325 - if (
326 - ( ! is_array( $this->body_parameters ) ) &&
327 - ( substr( $this->body_parameters, 0, 1 ) === '{' || substr( $this->body_parameters, 0, 1 ) === '[' )
328 - ) {
329 - $this->body_parameters = json_decode( $this->body_parameters, true );
258 +
259 + // do we urlencode the entire body as a string
260 + if( $this->body_url_encode == true ) {
261 + $data_raw = '';
262 + foreach ($this->body_parameters as $key => $value){
263 + $data_raw = $data_raw . $key . "=" . urlencode($value) . "&";
330 264 }
331 -
332 - $this->body_parameters = http_build_query( $this->body_parameters, '', '&' );
333 -
265 + $this->body_parameters = $data_raw;
334 266 }
335 267
336 - // do we xml the entire body
337 - if( $this->body_parameters && $this->body_xml_format == true ) {
338 -
339 - $root_node = $this->xml_root_node != '' ? '<' . $this->xml_root_node . '/>' : '';
340 -
341 - $xml_element = apply_filters( 'wpgetapi_xml_element', '<?xml version="1.0" encoding="UTF-8"?>' . $root_node );
342 -
343 - $xml = new SimpleXmlElement( $xml_element );
344 -
345 - foreach( $this->body_parameters as $key => $value) {
346 - $xml->addChild( $key, $value );
347 - }
348 -
349 - $this->body_parameters = $xml->asXML();
350 -
351 - }
352 -
353 - // do we base64 encode the entire body
354 - if( $this->body_parameters && $this->body_base64_encode == true ) {
355 -
356 - $this->body_parameters = is_array( $this->body_parameters ) ? json_encode( $this->body_parameters ) : $this->body_parameters;
357 - $this->body_parameters = base64_encode( $this->body_parameters );
358 -
359 - }
360 -
361 - $this->body_parameters = apply_filters( 'wpgetapi_modify_formatted_body_parameters', $this->body_parameters, $this );
362 -
363 268 // add our body parameters
364 269 if( $this->body_parameters && ! empty( $this->body_parameters ) )
365 270 $headers['body'] = $this->body_parameters;
366 271
@@ -365,18 +270,14 @@
365 270 $headers['body'] = $this->body_parameters;
366 271
367 272 }
368 273
369 - // get our body paramters as they are formatted
370 - // this won't change anything, it just allows us to get the parameters
371 - $this->body_parameters = apply_filters( 'wpgetapi_final_body_parameters', $this->body_parameters, $this );
372 -
373 274 // add headers to our final request args
374 275 $this->final_request_args = wp_parse_args( $headers, $this->final_request_args );
375 276
376 277 // build the args taht are sent to the request
377 278 $default_args = apply_filters( 'wpgetapi_default_request_args_parameters', array(
378 - 'timeout' => ( absint( $this->timeout ) > 0 ? absint( $this->timeout ) : 10 ),
279 + 'timeout' => $this->timeout,
379 280 'sslverify' => $this->sslverify,
380 281 'redirection' => 5,
381 282 'blocking' => true,
382 283 'cookies' => array(),
@@ -386,40 +287,27 @@
386 287
387 288 }
388 289
389 290
390 -
391 -
392 291 /**
393 292 * Do a GET request
394 293 */
395 294 public function GET_request() {
396 -
397 295 $response = '';
398 296 // so we can so something before the remote_get (caching)
399 297 $response = apply_filters( 'wpgetapi_before_get_request', $response, $this );
400 -
401 298 if( empty( $response ) )
402 299 $response = wp_remote_get( $this->final_url, $this->final_request_args );
403 300
404 301 return $response;
302 + }
405 303
406 - }
407 304
408 305 /**
409 306 * Do a POST request
410 307 */
411 308 public function POST_request() {
412 -
413 - $response = '';
414 - // so we can so something before the remote_post (caching)
415 - $response = apply_filters( 'wpgetapi_before_post_request', $response, $this );
416 -
417 - //$this->final_request_args['method'] = 'POST';
418 -
419 - if( empty( $response ) )
420 - $response = wp_remote_post( $this->final_url, $this->final_request_args );
421 -
309 + $response = wp_remote_post( $this->final_url, $this->final_request_args );
422 310 return $response;
423 311 }
424 312
425 313 /**
@@ -430,28 +318,10 @@
430 318 $response = wp_remote_request( $this->final_url, $this->final_request_args );
431 319 return $response;
432 320 }
433 321
434 - /**
435 - * Do a PATCH request
436 - */
437 - public function PATCH_request() {
438 - $this->final_request_args['method'] = 'PATCH';
439 - $response = wp_remote_request( $this->final_url, $this->final_request_args );
440 - return $response;
441 - }
442 322
443 323 /**
444 - * Do a DELETE request
445 - */
446 - public function DELETE_request() {
447 - $this->final_request_args['method'] = 'DELETE';
448 - $response = wp_remote_request( $this->final_url, $this->final_request_args );
449 - return $response;
450 - }
451 -
452 -
453 - /**
454 324 * return data
455 325 */
456 326 public function return_data( $data ) {
457 327
@@ -457,165 +327,23 @@
457 327
458 328 $data = apply_filters( 'wpgetapi_json_response_body_before_decode', $data, $this->keys );
459 329
460 330 // converts all data to arrays, removing objects
461 - if( is_string( $data ) ) {
462 - $decode = json_decode( $data, true );
463 - if( json_last_error() ) {
464 - return esc_html( $data );
465 - } else {
466 - $data = $decode;
467 - }
468 - }
469 -
331 + if( is_string( $data ) )
332 + $data = json_decode( $data, true );
333 +
470 334 $data = apply_filters( 'wpgetapi_json_response_body', $data, $this->keys );
471 335
472 336 if( $this->results_format == 'json_string' )
473 - return trim( json_encode( $data, JSON_PRETTY_PRINT ),'"');
474 -
337 + return trim( json_encode( $data ),'"');
338 +
475 339 if( $this->results_format == 'json_decoded' )
476 340 return $data;
477 341
478 342 }
479 343
480 - /**
481 - * Sort out the parameters if they exist
482 - */
483 - public function do_parameters( $parameters ) {
484 344
485 - $new_array = array();
486 - $raw = '';
487 - $parameters = $this->decrypt( $parameters );
488 -
489 - if( is_array( $parameters ) ) {
490 - foreach ( $parameters as $key => $parameter ) {
491 -
492 - if( ! empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) {
493 -
494 - $parameter['value'] = stripslashes( $parameter['value'] );
495 -
496 - // if we have wpgetapi_on, delete it so we don't send to api
497 - if( $parameter['name'] == 'wpgetapi_on' ) {
498 - unset( $parameters[ $key ] );
499 - continue;
500 - }
501 -
502 - // if we have item_key from api to posts plugin
503 - // replace our keyword with the actual item_key value
504 - if ( isset( $this->args['item_key'] ) && strpos( $parameter['value'], '(importer:item_key)' ) !== false ) {
505 - $parameter['value'] = str_replace( '(importer:item_key)', $this->args['item_key'], $parameter['value'] );
506 - }
507 -
508 - $new_array[ sanitize_text_field( $parameter['name'] ) ] = $parameter['value'];
509 -
510 - // if we are sending raw body
511 - } else if( empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) {
512 -
513 - $raw = stripslashes( $parameter['value'] );
514 -
515 - }
516 -
517 - }
518 - }
519 -
520 - // now look for array or json string and sort these out - for using such things in shortcode
521 - if( ! empty( $new_array ) ) {
522 -
523 - foreach ( $new_array as $key => $value ) {
524 -
525 - // checking if the parameters have a json string
526 - if ( strpos( $value, '{"' ) !== false && strpos( $value, '}' ) !== false ) {
527 -
528 - $tmp_val = $value;
529 - $tmp_val = json_decode( $tmp_val, true );
530 - $new_array[ $key ] = $tmp_val ? $tmp_val : $value;
531 -
532 - } else
533 -
534 - // checking if the parameters have an array within the string
535 - // if they do, create them as an actual array
536 - if ( substr( $value, 0, 1 ) === '[' && substr( $value, -1 ) === ']' ) {
537 - $value = trim( $value,"[]" );
538 - $new_array[ $key ] = array( $value );
539 - }
540 -
541 - // set value as integer
542 - if ( strpos( $value, 'integer(' ) !== false && substr( $value, -1 ) === ')' ) {
543 -
544 - preg_match("/\(([^\)]*)\)/", $value, $match );
545 - $result = trim( $match[1] );
546 -
547 - // checking if we have additional token within
548 - // and we need to send this directly to PRO plugin from here
549 - if( strpos( $value, '(' ) !== false && strpos( $value, ':' ) !== false && $this->pro_plugin ) {
550 - $result = $this->replace_tokens( $result );
551 - } else {
552 - $result = $result;
553 - }
554 -
555 - $new_array[ $key ] = absint( $result );
556 -
557 - }
558 -
559 - // set value as float
560 - if ( strpos( $value, 'float(' ) !== false && substr( $value, -1 ) === ')' ) {
561 -
562 - preg_match("/\(([^\)]*)\)/", $value, $match );
563 - $result = trim( $match[1] );
564 - if ( substr( $result, 0, 1 ) === '"' && substr( $result, -1 ) === '"' )
565 - $result = trim( $result,'""' );
566 -
567 - // checking if we have additional token within
568 - // and we need to send this directly to PRO plugin from here
569 - if( strpos( $value, '(' ) !== false && strpos( $value, ':' ) !== false && $this->pro_plugin ) {
570 - $result = $this->replace_tokens( $result );
571 - }
572 -
573 - $new_array[ $key ] = (float) $result;
574 -
575 - }
576 -
577 - // set value as boolean
578 - if ( strpos( $value, 'boolean(' ) !== false && substr( $value, -1 ) === ')' ) {
579 - preg_match("/\(([^\)]*)\)/", $value, $match );
580 - $result = $match[1];
581 -
582 - // checking if we have additional token within
583 - // and we need to send this directly to PRO plugin from here
584 - if( strpos( $value, '(' ) !== false && strpos( $value, ':' ) !== false && $this->pro_plugin ) {
585 - $result = $this->replace_tokens( $result );
586 - } else {
587 - $result = $result;
588 - }
589 -
590 - $result = filter_var( $result, FILTER_VALIDATE_BOOLEAN );
591 -
592 - $new_array[ $key ] = $result;
593 -
594 - }
595 -
596 - }
597 -
598 - }
599 -
600 - return $raw ? $raw : $new_array;
601 -
602 - }
603 -
604 -
605 345 /**
606 - * Do a direct token replacement if PRO plugin installed and is required.
607 - */
608 - public function replace_tokens( $value ) {
609 - $tokens = new WpGetApi_Extras_Tokens();
610 - $action_args = isset( $this->args['action_args'] ) ? $this->args['action_args'] : null;
611 - $value = ( substr( $value, -1 ) !== ')' ? $value . ')' : $value );
612 - $result = $tokens->replace_tokens( $value, $action_args );
613 - return $result;
614 - }
615 -
616 -
617 - /**
618 346 * decrypt our parameters from the DB
619 347 */
620 348 public function decrypt( $array_or_string ) {
621 349
@@ -649,127 +377,86 @@
649 377 ) {
650 378
651 379 $this->debug = true;
652 380
653 - // admin test endpoint button
654 381 $testing = isset( $this->args['test_endpoint'] ) && ( $this->args['test_endpoint'] === true ) ? true : false;
655 382
656 - // get api status from response code
657 - $status = array(
658 - 'title' => 'Error in API response.',
659 - 'desc' => 'Check all details within your endpoint. Something is misconfigured.',
660 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
661 - );
383 + ob_start(); ?>
662 384
663 - $search = 'cURL error 28';
664 - if( isset( $data ) && ! is_array( $data ) && preg_match( "/{$search}/i", $data ) ) {
665 - $status = array(
666 - 'title' => 'Error!',
667 - 'desc' => 'Timeout error. Try increasing the timeout value.',
668 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
669 - );
670 - }
385 +<style>
671 386
672 - $search = 'cURL error 60';
673 - if( isset( $data ) && ! is_array( $data ) && preg_match( "/{$search}/i", $data ) ) {
674 - $status = array(
675 - 'title' => 'Error!',
676 - 'desc' => 'SSL verification has failed. See <a href="https://wordpress.stackexchange.com/a/167910/11827" target="_blank">here</a> for possible solution.',
677 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
678 - );
679 - }
387 +.wpgetapi-debug {
388 + background: #fff;
389 + padding: 20px;
390 + box-shadow: 0 0 1px #aaa;
391 + margin: 20px;
392 + font-size: 15px;
393 +}
394 +.wpgetapi-debug
395 +.wpgetapi-debug p
396 +.wpgetapi-debug h5
397 +.wpgetapi-debug h6 {
398 + color: #000;
399 + line-height: 1 !important;
400 + text-transform: none !important;
401 + font-family: sans-serif !important;
402 + letter-spacing: 0px !important;
403 +}
404 +.wpgetapi-debug p.small {
405 + font-size: 85%;
406 + color: #999;
407 + margin: 0 0 12px !important;
408 +}
409 +.wpgetapi-debug h5 {
410 + font-weight: bold;
411 + font-size: 18px;
412 + margin: 0 0 3px;
413 + text-transform: none !important;
414 +}
415 +.wpgetapi-debug .debug-item {
416 + margin: 10px 0;
417 + background: #fff;
418 + padding: 15px 20px;
419 + display: inline-block !important;
420 + width: 100% !important;
421 + box-shadow: 3px 3px 0 rgb(0 0 0 / 8%);
422 + border: 1px solid #efefef;
423 +}
424 +.wpgetapi-debug .debug-item h6 {
425 + font-weight: bold;
426 + font-size: 14px;
427 + margin: 0;
428 + text-transform: none !important;
429 +}
430 +.wpgetapi-debug .debug-item .debug-result,
431 +.wpgetapi-debug .debug-item .debug-result pre {
432 + font-family: monospace !important;
433 + font-size: 13px !important;
434 + margin: 0 !important;
435 + padding: 8px 12px;
436 + background: #f8f8f8;
437 +}
438 +.wpgetapi-debug .debug-item .debug-result pre {
439 + border: none;
440 + padding: 5px
441 +}
680 442
681 - if( $this->response_code >= 200 && $this->response_code <= 299 ) {
682 - $status = array(
683 - 'title' => 'Success!',
684 - 'desc' => 'Your API is returning a success message and is returning the data as shown in the Data Output section below. You can modify this by changing the Results Format option or see <a href="https://wpgetapi.com/docs/format-api-data-as-html/">here</a> for info on formatting this data.',
685 - 'type' => '<span class="dashicons dashicons-yes-alt"></span>'
686 - );
687 - }
688 - if( $this->response_code >= 400 && $this->response_code <= 499 ) {
689 - $status = array(
690 - 'title' => 'Bad Request',
691 - 'desc' => 'This could indicate that the URL you are calling is incorrect or that some other data is missing or incorrect. Please check your Base URL and Endpoint are correct as well as the Request Method.',
692 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
693 - );
694 - }
695 - if( $this->response_code == 401 ) {
696 - $status = array(
697 - 'title' => 'Unauthorised',
698 - 'desc' => 'You are successfully connecting to your API. But your API key, login or API credentials are incorrect. See <a href="https://wpgetapi.com/docs/authentication-authorization/">here</a> for info on correctly authorizing your API requests.',
699 - 'type' => '<span class="dashicons dashicons-warning"></span>'
700 - );
701 - }
702 - if( $this->response_code == 403 ) {
703 - $status = array(
704 - 'title' => 'Forbidden',
705 - 'desc' => 'This could indicate that you may need to get your IP address whitelisted with your API provider or that you do not have access to this API.',
706 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
707 - );
708 - }
709 - if( $this->response_code == 405 ) {
710 - $status = array(
711 - 'title' => 'Method Not Allowed',
712 - 'desc' => 'Try changing the Request Method within the endpoint settings.',
713 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
714 - );
715 - }
716 - if( $this->response_code == 415 ) {
717 - $status = array(
718 - 'title' => 'Unsupported Media Type',
719 - 'desc' => 'Try adding "Content-type" to the Headers with the Value of "json/application" as shown <a href="https://wpgetapi.com/docs/troubleshooting/">here</a>.',
720 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
721 - );
722 - }
723 - if( $this->response_code >= 500 && $this->response_code <= 599 ) {
724 - $status = array(
725 - 'title' => 'Internal Server Error',
726 - 'desc' => 'This indicates an issue with the API server. Contact your API provider.',
727 - 'type' => '<span class="dashicons dashicons-dismiss"></span>'
728 - );
729 - }
443 +.wpgetapi-debug.testing {
444 + background: transparent;
445 + padding: 0;
446 + box-shadow: none;
447 +}
448 +.wpgetapi-debug.testing .debug-item {
449 + margin: 5px 0;
450 +}
451 +</style>
730 452
731 -
732 - ob_start(); ?>
733 -
734 453 <div class="wpgetapi-debug <?php echo $testing ? 'testing' : ''; ?>">
735 454
736 - <?php if( $testing ) { ?>
737 -
738 - <div class="debug-item status">
739 - <div class="">
740 - <h5><?php _e( $status['type'] ); ?> <?php esc_html_e( $status['title'] ); ?></h5>
741 - <span class="desc"><?php _e( $status['desc'] ); ?></span>
742 - </div>
743 - </div>
744 - <div class="debug-item">
745 - <h6><?php esc_html_e( 'Full URL', 'wpgetapi' ); ?></h6>
746 - <p class="small"><?php esc_html_e( 'The full URL that is being called.', 'wpgetapi' ); ?></p>
747 - <div class="debug-result"><?php esc_html_e( $this->final_url ); ?></div>
748 - </div>
749 -
750 - <div class="debug-item">
751 - <h6><?php esc_html_e( 'Data Output', 'wpgetapi' ); ?></h6>
752 - <p class="small"><?php esc_html_e( 'The output that has been returned from the API. This is what the shortcode or template tag will display and can be formatted however you like.', 'wpgetapi' ); ?></p>
753 - <div class="debug-result"><?php wpgetapi_pp( $data ); ?></div>
754 - </div>
755 -
756 - <div class="debug-item">
757 - <h6><?php esc_html_e( 'Final Request Arguments', 'wpgetapi' ); ?></h6>
758 - <p class="small"><?php esc_html_e( 'The final request arguments sent in the API request. Includes headers and body arguments.', 'wpgetapi' ); ?></p>
759 - <div class="debug-result"><?php wpgetapi_pp( $this->final_request_args ); ?></div>
760 - </div>
761 -
762 - <div class="debug-item">
763 - <h6><?php esc_html_e( 'Response', 'wpgetapi' ); ?></h6>
764 - <p class="small"><?php esc_html_e( 'The full response from the API request.', 'wpgetapi' ); ?></p>
765 - <div class="debug-result"><?php wpgetapi_pp( $this->response); ?></div>
766 - </div>
767 -
768 - <?php } else { ?>
769 -
770 - <h5><strong><?php esc_html_e( 'WPGetAPI, Debug Mode - Plugin Version', 'wpgetapi' ); ?> <?php esc_html_e( WpGetApi()->version ); ?></strong></h5>
455 + <?php if( ! $testing ) { ?>
456 + <h5><strong><?php esc_html_e( 'WPGetAPI, Debug Mode - Plugin Version', 'wpgetapi' ); ?> <?php esc_html_e( WpGetApi()->version ); ?></strong></h5>
771 457 <p class="small"><?php esc_html_e( 'Below you will find debug info for the current API call. To turn this off, set debug to false in your shortcode or template tag.', 'wpgetapi' ); ?><br><?php esc_html_e( 'Connecting to API\'s can be tricky - if you require help, please see the', 'wpgetapi' ); ?> <a target="_blank" href="https://wpgetapi.com/docs/"><?php esc_html_e( 'Documentation', 'wpgetapi' ); ?></a>.</p>
458 + <?php } ?>
772 459
773 460 <div class="debug-item">
774 461 <h6><?php esc_html_e( 'Full URL', 'wpgetapi' ); ?></h6>
775 462 <p class="small"><?php esc_html_e( 'The full URL that is being called.', 'wpgetapi' ); ?></p>
@@ -816,10 +503,8 @@
816 503 <h6><?php esc_html_e( 'Response', 'wpgetapi' ); ?></h6>
817 504 <p class="small"><?php esc_html_e( 'The full response from the API request.', 'wpgetapi' ); ?></p>
818 505 <div class="debug-result"><?php wpgetapi_pp( $this->response); ?></div>
819 506 </div>
820 -
821 - <?php } ?>
822 507
823 508 </div>
824 509
825 510 <?php