setup = get_option( 'wpgetapi_setup' ); $this->api = get_option( 'wpgetapi_' . $api_id ); $this->encryption = new WpGetApi_Encryption(); $this->api_id = sanitize_text_field( $api_id ); $this->endpoint_id = sanitize_text_field( $endpoint_id ); $this->keys = $keys; $this->args = $args; add_filter( 'wpgetapi_raw_data', array( $this, 'maybe_add_debug_info' ), 99, 2 ); } /** * Init our api data */ public function init() { // if we are doing importer plugin, // we need to intercept and modify most of our methods values if( $this->api_id === 'wpgetapi_importer' ) { $data = apply_filters( 'wpgetapi_api_importer_init', $this ); if( $data ) { foreach ($data as $key => $value) { $this->{$key} = $value; } $this->query_parameters = ! empty( $this->query_parameters ) ? $this->do_parameters( $this->query_parameters ) : array(); $this->header_parameters = ! empty( $this->header_parameters ) ? $this->do_parameters( $this->header_parameters ) : array(); $this->body_parameters = ! empty( $this->body_parameters ) ? $this->do_parameters( $this->body_parameters ) : array(); return; } } // do some checks if( empty( $this->setup ) || ! isset( $this->setup['apis'] ) || empty( $this->setup['apis'] ) ) return 'No API found.'; // do some checks if( ! $this->api || ! isset( $this->api['endpoints'] ) || empty( $this->api['endpoints'] )) return 'API not found.'; // loop through api's // set base_url foreach ( $this->setup['apis'] as $index => $api_item ) { if( $this->api_id == $api_item['id'] ) { $this->base_url = isset( $api_item['base_url'] ) && ! empty( $api_item['base_url'] ) ? esc_url_raw( $api_item['base_url'] ) : ''; } } // loop through endpoints foreach ( $this->api['endpoints'] as $index => $endpoint ) { if( $this->endpoint_id == $endpoint['id'] ) { $this->method = isset( $endpoint['method'] ) && $endpoint['method'] != '' ? sanitize_text_field( $endpoint['method'] ) : 'GET'; $this->cache_time = isset( $endpoint['cache_time'] ) && ! empty( $endpoint['cache_time'] ) ? absint( $endpoint['cache_time'] ) : ''; $this->endpoint = isset( $endpoint['endpoint'] ) && ! empty( $endpoint['endpoint'] ) ? sanitize_text_field( $endpoint['endpoint'] ) : ''; $this->query_parameters = isset( $endpoint['query_parameters'] ) && ! empty( $endpoint['query_parameters'] ) ? $this->do_parameters( $endpoint['query_parameters'] ) : array(); $this->header_parameters = isset( $endpoint['header_parameters'] ) && ! empty( $endpoint['header_parameters'] ) ? $this->do_parameters( $endpoint['header_parameters'] ) : array(); $this->body_parameters = isset( $endpoint['body_parameters'] ) && ! empty( $endpoint['body_parameters'] ) ? $this->do_parameters( $endpoint['body_parameters'] ) : array(); // how to encode the body $this->body_json_encode = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'true' ? true : false; $this->body_url_encode = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'url' ? true : false; $this->body_base64_encode = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'base64' ? true : false; $this->body_xml_format = isset( $endpoint['body_json_encode'] ) && $endpoint['body_json_encode'] == 'xml' ? true : false; $this->xml_root_node = isset( $endpoint['xml_root'] ) && ! empty( $endpoint['xml_root'] ) ? $endpoint['xml_root'] : $this->xml_root_node; $this->results_format = isset( $endpoint['results_format'] ) ? sanitize_text_field( $endpoint['results_format'] ) : $this->results_format; if( // set the format to php array data if html format is set ( isset( $this->args['format'] ) && $this->args['format'] == 'html' && $this->results_format != 'xml_array' ) || // set the format to php array data if it is set in the args (coming from the importer) ( isset( $this->args['results_format'] ) && $this->args['results_format'] == 'json_decoded' ) ) { $this->results_format = 'json_decoded'; } // set the format to JSON string if it is set in the args (coming from the wpdatatables integration) if( isset( $this->args['results_format'] ) && $this->args['results_format'] == 'json_string' ) { $this->results_format = 'json_string'; } // set the format to JSON string if it is set in the args (coming from the wpdatatables integration) if( isset( $this->args['results_format'] ) && $this->args['results_format'] == 'json_decoded' ) { $this->results_format = 'json_decoded'; } } } $this->timeout = isset( $this->api['timeout'] ) && ! empty( $this->api['timeout'] ) ? $this->api['timeout'] : $this->timeout; $this->sslverify = isset( $this->api['sslverify'] ) ? absint( $this->api['sslverify'] ) : $this->sslverify; } /** * The main function to output the data * * @param string $field Field to retrieve */ public function endpoint_output() { do_action( 'wpgetapi_before_do_the_call', $this ); return $this->do_the_call(); } /** * Send the request and return our data */ public function do_the_call() { $this->init(); // build the URL $this->final_url = apply_filters( 'wpgetapi_final_url', $this->build_url(), $this ); // build the request args $this->final_request_args = apply_filters( 'wpgetapi_final_request_args', $this->build_request_args(), $this ); /** * Check if we should stop or not. Setting $on to true, will stop us calling the api. * @param bool $on Whether on is set or not. */ if ( apply_filters( 'wpgetapi_should_we_stop', false, $this ) ) { return; } // POST request if( $this->method == 'POST' ) $this->response = $this->POST_request(); // PUT request if( $this->method == 'PUT' ) $this->response = $this->PUT_request(); // PATCH request if( $this->method == 'PATCH' ) $this->response = $this->PATCH_request(); // GET request if( $this->method == 'GET' ) $this->response = $this->GET_request(); // DELETE request if( $this->method == 'DELETE' ) $this->response = $this->DELETE_request(); // wp error if( is_wp_error( $this->response ) ) { return apply_filters( 'wpgetapi_raw_error_data', json_encode( $this->response ), $this ); } // get response_code $this->response_code = wp_remote_retrieve_response_code( $this->response ); // action to intercept call depending on response_code $this->response = apply_filters( 'wpgetapi_before_retrieve_body', $this->response, $this->response_code, $this ); // get body // modified in version 1.6.1 to allow for OAuth 2.0 plugin returning body already $data = isset( $this->response['body'] ) ? $this->response['body'] : $this->response; // returning in JSON format if( $this->results_format == 'json_string' || $this->results_format == 'json_decoded' ) $data = $this->return_data( $data ); if( $data === 'null' ) $data = 'Result is null. Check that all endpoint settings are correct.'; return apply_filters( 'wpgetapi_raw_data', $data, $this ); } /** * Build the request url with the ability to add args */ public function build_url() { // first make sure our endpoint starts with a slash if ( substr( $this->endpoint, 0, 1 ) != '/' ) $this->endpoint = '/' . $this->endpoint; // if we have item_key from api to posts plugin // replace our keyword with the actual item_key value if ( isset( $this->args['item_key'] ) && strpos( $this->endpoint, '(importer:item_key)' ) !== false ) { $this->endpoint = str_replace( '(importer:item_key)', $this->args['item_key'], $this->endpoint ); } $this->endpoint = apply_filters( 'wpgetapi_endpoint', $this->endpoint, $this ); $url = untrailingslashit( $this->base_url ) . $this->endpoint; // if we have a URL pagination event from the import plugin // we need to modify the URL here if( isset( $this->args['paginate_url'] ) ) $url = $this->args['paginate_url']; // filter our params - added for use in Oauth 2.0 plugin $params = apply_filters( 'wpgetapi_query_parameters', $this->query_parameters, $this ); // add empty array - was getting errors if it was just null or false $params = empty( $params ) ? array(''=>'') : $params; $result = add_query_arg( $params, $url ); return $result; } /** * build the header with the ability to add args */ public function build_request_args() { // add our header parameters to the headers $headers = apply_filters( 'wpgetapi_header_parameters', array( 'headers' => $this->header_parameters, ), $this ); // if doing POST request, include body paramters if( $this->method == 'POST' || $this->method == 'PUT' || $this->method == 'DELETE' || $this->method == 'PATCH' ) { // tokens are sent through here $this->body_parameters = apply_filters( 'wpgetapi_body_parameters', $this->body_parameters, $this ); // do we json_encode the entire body if( $this->body_json_encode == true ) { $this->body_parameters = json_encode( $this->body_parameters ); } // do we urlencode the entire body if( $this->body_parameters && $this->body_url_encode == true ) { // checking if the parameters have a json string (raw) if ( ( ! is_array( $this->body_parameters ) ) && ( substr( $this->body_parameters, 0, 1 ) === '{' || substr( $this->body_parameters, 0, 1 ) === '[' ) ) { $this->body_parameters = json_decode( $this->body_parameters, true ); } $this->body_parameters = http_build_query( $this->body_parameters, '', '&' ); } // do we xml the entire body if( $this->body_parameters && $this->body_xml_format == true ) { $xml = new SimpleXmlElement( '<' . $this->xml_root_node . '/>' ); foreach( $this->body_parameters as $key => $value) { $xml->addChild( $key, $value ); } $this->body_parameters = $xml->asXML(); } // do we base64 encode the entire body if( $this->body_parameters && $this->body_base64_encode == true ) { $this->body_parameters = is_array( $this->body_parameters ) ? json_encode( $this->body_parameters ) : $this->body_parameters; $this->body_parameters = base64_encode( $this->body_parameters ); } // add our body parameters if( $this->body_parameters && ! empty( $this->body_parameters ) ) $headers['body'] = $this->body_parameters; } // get our body paramters as they are formatted $this->body_parameters = apply_filters( 'wpgetapi_final_body_parameters', $this->body_parameters, $this ); // add headers to our final request args $this->final_request_args = wp_parse_args( $headers, $this->final_request_args ); // build the args taht are sent to the request $default_args = apply_filters( 'wpgetapi_default_request_args_parameters', array( 'timeout' => $this->timeout, 'sslverify' => $this->sslverify, 'redirection' => 5, 'blocking' => true, 'cookies' => array(), ) ); return wp_parse_args( $this->final_request_args, $default_args ); } /** * Do a GET request */ public function GET_request() { $response = ''; // so we can so something before the remote_get (caching) $response = apply_filters( 'wpgetapi_before_get_request', $response, $this ); if( empty( $response ) ) $response = wp_remote_get( $this->final_url, $this->final_request_args ); return $response; } /** * Do a POST request */ public function POST_request() { $response = ''; // so we can so something before the remote_post (caching) $response = apply_filters( 'wpgetapi_before_post_request', $response, $this ); $this->final_request_args['method'] = 'POST'; if( empty( $response ) ) $response = wp_remote_post( $this->final_url, $this->final_request_args ); return $response; } /** * Do a PUT request */ public function PUT_request() { $this->final_request_args['method'] = 'PUT'; $response = wp_remote_request( $this->final_url, $this->final_request_args ); return $response; } /** * Do a PATCH request */ public function PATCH_request() { $this->final_request_args['method'] = 'PATCH'; $response = wp_remote_request( $this->final_url, $this->final_request_args ); return $response; } /** * Do a DELETE request */ public function DELETE_request() { $this->final_request_args['method'] = 'DELETE'; $response = wp_remote_request( $this->final_url, $this->final_request_args ); return $response; } /** * return data */ public function return_data( $data ) { $data = apply_filters( 'wpgetapi_json_response_body_before_decode', $data, $this->keys ); // converts all data to arrays, removing objects if( is_string( $data ) ) { $decode = json_decode( $data, true ); if( json_last_error() ) { return esc_html( $data ); } else { $data = $decode; } } $data = apply_filters( 'wpgetapi_json_response_body', $data, $this->keys ); if( $this->results_format == 'json_string' ) return trim( json_encode( $data, JSON_PRETTY_PRINT ),'"'); if( $this->results_format == 'json_decoded' ) return $data; } /** * Sort out the parameters if they exist */ public function do_parameters( $parameters ) { $new_array = array(); $raw = ''; $parameters = $this->decrypt( $parameters ); if( is_array( $parameters ) ) { foreach ( $parameters as $key => $parameter ) { if( ! empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) { $parameter['value'] = stripslashes( $parameter['value'] ); // if we have wpgetapi_on, delete it so we don't send to api if( $parameter['name'] == 'wpgetapi_on' ) { unset( $parameters[ $key ] ); continue; } // if we have item_key from api to posts plugin // replace our keyword with the actual item_key value if ( isset( $this->args['item_key'] ) && strpos( $parameter['value'], '(importer:item_key)' ) !== false ) { $parameter['value'] = str_replace( '(importer:item_key)', $this->args['item_key'], $parameter['value'] ); } $new_array[ sanitize_text_field( $parameter['name'] ) ] = $parameter['value']; // if we are sending raw body } else if( empty( $parameter['name'] ) && ! empty( $parameter['value'] ) ) { $raw = stripslashes( $parameter['value'] ); } } } // now look for array or json string and sort these out - for using such things in shortcode if( ! empty( $new_array ) ) { foreach ( $new_array as $key => $value ) { // checking if the parameters have a json string if ( strpos( $value, '{"' ) !== false && strpos( $value, '}' ) !== false ) { $tmp_val = $value; $tmp_val = json_decode( $tmp_val, true ); $new_array[ $key ] = $tmp_val ? $tmp_val : $value; } else // checking if the parameters have an array within the string // if they do, create them as an actual array if ( substr( $value, 0, 1 ) === '[' && substr( $value, -1 ) === ']' ) { $value = trim( $value,"[]" ); $new_array[ $key ] = array( $value ); } // set value as integer if ( strpos( $value, 'integer(' ) !== false && substr( $value, -1 ) === ')' ) { preg_match("/\(([^\)]*)\)/", $value, $match ); $result = $match[1]; $new_array[ $key ] = absint( $result ); } // set value as float if ( strpos( $value, 'float(' ) !== false && substr( $value, -1 ) === ')' ) { preg_match("/\(([^\)]*)\)/", $value, $match ); $result = $match[1]; if ( substr( $result, 0, 1 ) === '"' && substr( $result, -1 ) === '"' ) $result = trim( $result,'""' ); $new_array[ $key ] = (float) $result; } // set value as boolean if ( strpos( $value, 'boolean(' ) !== false && substr( $value, -1 ) === ')' ) { preg_match("/\(([^\)]*)\)/", $value, $match ); $result = $match[1]; $result = filter_var( $result, FILTER_VALIDATE_BOOLEAN ); $new_array[ $key ] = $result; } } } return $raw ? $raw : $new_array; } /** * decrypt our parameters from the DB */ public function decrypt( $array_or_string ) { if( is_string($array_or_string) ){ $array_or_string = $this->encryption->decrypt($array_or_string); }elseif( is_array($array_or_string) ){ foreach ( $array_or_string as $key => &$value ) { if( $key === 'name' ) continue; if ( is_array( $value ) ) { $value = $this->decrypt($value); } else { $value = $this->encryption->decrypt($value); } } } return $array_or_string; } /** * debug */ public function maybe_add_debug_info( $data, $wpgetapi ) { if( ( isset( $this->args['debug'] ) && ( $this->args['debug'] === true || $this->args['debug'] === 'true' ) ) || ( isset( $this->args['test_endpoint'] ) && ( $this->args['test_endpoint'] === true ) ) ) { $this->debug = true; // admin test endpoint button $testing = isset( $this->args['test_endpoint'] ) && ( $this->args['test_endpoint'] === true ) ? true : false; // get api status from response code $status = array( 'title' => 'Error in API response.', 'desc' => 'Check all details within your endpoint. Something is misconfigured.', 'type' => '' ); if( $this->response_code >= 200 && $this->response_code <= 299 ) { $status = array( 'title' => 'Success!', '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 here for info on formatting this data.', 'type' => '' ); } if( $this->response_code >= 400 && $this->response_code <= 499 ) { $status = array( 'title' => 'Bad Request', '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.', 'type' => '' ); } if( $this->response_code == 401 ) { $status = array( 'title' => 'Unauthorised', 'desc' => 'You are successfully connecting to your API. But your API key, login or API credentials are incorrect. See here for info on correctly authorizing your API requests.', 'type' => '' ); } if( $this->response_code == 403 ) { $status = array( 'title' => 'Forbidden', '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.', 'type' => '' ); } if( $this->response_code == 405 ) { $status = array( 'title' => 'Method Not Allowed', 'desc' => 'Try changing the Request Method within the endpoint settings.', 'type' => '' ); } if( $this->response_code == 415 ) { $status = array( 'title' => 'Unsupported Media Type', 'desc' => 'Try adding "Content-type" to the Headers with the Value of "json/application" as shown here.', 'type' => '' ); } if( $this->response_code >= 500 && $this->response_code <= 599 ) { $status = array( 'title' => 'Internal Server Error', 'desc' => 'This indicates an issue with the API server. Contact your API provider.', 'type' => '' ); } ob_start(); ?>

final_url ); ?>

final_request_args ); ?>

response); ?>
version ); ?>


.

final_url ); ?>

query_parameters ); ?>

header_parameters ); ?>

body_parameters ); ?>

final_request_args ); ?>

args ); ?>

response); ?>