Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* Simple object to hold HTTP request details.

[3] Fix | Delete

[4] Fix | Delete

* @since 1.1.0

[5] Fix | Delete

[6] Fix | Delete

* @package ET\Core\HTTP

[7] Fix | Delete

[8] Fix | Delete

class ET_Core_HTTPRequest {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* @var array

[12] Fix | Delete

[13] Fix | Delete

public $ARGS;

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* @var bool

[17] Fix | Delete

[18] Fix | Delete

public $BLOCKING = true;

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* @var null|array

[22] Fix | Delete

[23] Fix | Delete

public $BODY = null;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* @var bool

[27] Fix | Delete

[28] Fix | Delete

public $COMPLETE = false;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* @var array

[32] Fix | Delete

[33] Fix | Delete

public $COOKIES = array();

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* @var array

[37] Fix | Delete

[38] Fix | Delete

public $HEADERS = array();

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* @var bool

[42] Fix | Delete

[43] Fix | Delete

public $IS_AUTH = false;

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* @var string

[47] Fix | Delete

[48] Fix | Delete

public $METHOD = 'GET';

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* @var string

[52] Fix | Delete

[53] Fix | Delete

public $OWNER;

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* @var string

[57] Fix | Delete

[58] Fix | Delete

public $URL;

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* @var string

[62] Fix | Delete

[63] Fix | Delete

public $USER_AGENT;

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* ET_Core_HTTP_Request constructor.

[67] Fix | Delete

[68] Fix | Delete

* @param string $url The request URL.

[69] Fix | Delete

* @param string $method HTTP request method. Default is 'GET'.

[70] Fix | Delete

* @param string $owner The name of the owner of this request instance. Default is 'ET_Core'.

[71] Fix | Delete

* @param bool $is_auth Whether or not this request is auth-related. Cache disabled if `true`. Default is `false`.

[72] Fix | Delete

* @param array $body The request body. Default is `null`.

[73] Fix | Delete

* @param bool $is_json_body

[74] Fix | Delete

[75] Fix | Delete

public function __construct( $url, $method = 'GET', $owner = 'ET_Core', $is_auth = false, $body = null, $is_json_body = false, $ssl_verify = true ) {

[76] Fix | Delete

$this->URL = esc_url_raw( $url );

[77] Fix | Delete

$this->METHOD = $method;

[78] Fix | Delete

$this->BODY = $body;

[79] Fix | Delete

$this->IS_AUTH = $is_auth;

[80] Fix | Delete

$this->OWNER = $owner;

[81] Fix | Delete

$this->data_format = null;

[82] Fix | Delete

$this->JSON_BODY = $is_json_body;

[83] Fix | Delete

$this->SSL_VERIFY = $ssl_verify;

[84] Fix | Delete

[85] Fix | Delete

$this->_set_user_agent();

[86] Fix | Delete

$this->prepare_args();

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Only include necessary properties when printing this object using {@link var_dump}.

[91] Fix | Delete

[92] Fix | Delete

* @return array

[93] Fix | Delete

[94] Fix | Delete

public function __debugInfo() {

[95] Fix | Delete

return array(

[96] Fix | Delete

'ARGS' => $this->ARGS,

[97] Fix | Delete

'URL' => $this->URL,

[98] Fix | Delete

'METHOD' => $this->METHOD,

[99] Fix | Delete

'BODY' => $this->BODY,

[100] Fix | Delete

'IS_AUTH' => $this->IS_AUTH,

[101] Fix | Delete

'IS_JSON_BODY' => $this->JSON_BODY,

[102] Fix | Delete

'OWNER' => $this->OWNER,

[103] Fix | Delete

);

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Sets the user agent string.

[108] Fix | Delete

[109] Fix | Delete

private function _set_user_agent() {

[110] Fix | Delete

global $wp_version;

[111] Fix | Delete

$owner = $this->OWNER;

[112] Fix | Delete

$version = 'bloom' === $owner ? $GLOBALS['et_bloom']->plugin_version : ET_CORE_VERSION;

[113] Fix | Delete

[114] Fix | Delete

if ( 'builder' === $owner ) {

[115] Fix | Delete

$owner = 'Divi Builder';

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

if ( '' === $owner ) {

[119] Fix | Delete

$this->OWNER = $owner = 'ET_Core';

[120] Fix | Delete

[121] Fix | Delete

} else {

[122] Fix | Delete

$owner = ucfirst( $owner );

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

$this->USER_AGENT = "WordPress/{$wp_version}; {$owner}/{$version}; " . esc_url_raw( get_bloginfo( 'url' ) );

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

/**

[129] Fix | Delete

* Prepares the request arguments (to be passed to wp_remote_*())

[130] Fix | Delete

[131] Fix | Delete

public function prepare_args() {

[132] Fix | Delete

$this->ARGS = array(

[133] Fix | Delete

'blocking' => $this->BLOCKING,

[134] Fix | Delete

'body' => $this->BODY,

[135] Fix | Delete

'cookies' => $this->COOKIES,

[136] Fix | Delete

'headers' => $this->HEADERS,

[137] Fix | Delete

'method' => $this->METHOD,

[138] Fix | Delete

'sslverify' => $this->SSL_VERIFY,

[139] Fix | Delete

'user-agent' => $this->USER_AGENT,

[140] Fix | Delete

'timeout' => 30,

[141] Fix | Delete

);

[142] Fix | Delete

}

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

/**

[146] Fix | Delete

* Simple object to hold HTTP response details.

[147] Fix | Delete

[148] Fix | Delete

* @since 1.1.0

[149] Fix | Delete

[150] Fix | Delete

* @package ET\Core\HTTP

[151] Fix | Delete

[152] Fix | Delete

class ET_Core_HTTPResponse {

[153] Fix | Delete

[154] Fix | Delete

/**

[155] Fix | Delete

* @var array

[156] Fix | Delete

[157] Fix | Delete

public $COOKIES;

[158] Fix | Delete

[159] Fix | Delete

/**

[160] Fix | Delete

* @var string|array

[161] Fix | Delete

[162] Fix | Delete

public $DATA;

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* @var bool

[166] Fix | Delete

[167] Fix | Delete

public $ERROR = false;

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* The error message if `self::$ERROR` is `true`.

[171] Fix | Delete

[172] Fix | Delete

* @var string

[173] Fix | Delete

[174] Fix | Delete

public $ERROR_MESSAGE;

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* @var array

[178] Fix | Delete

[179] Fix | Delete

public $HEADERS;

[180] Fix | Delete

[181] Fix | Delete

/**

[182] Fix | Delete

* @var array|WP_Error

[183] Fix | Delete

[184] Fix | Delete

public $RAW_RESPONSE;

[185] Fix | Delete

[186] Fix | Delete

/**

[187] Fix | Delete

* @var ET_Core_HTTPRequest

[188] Fix | Delete

[189] Fix | Delete

public $REQUEST;

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* The response's HTTP status code.

[193] Fix | Delete

[194] Fix | Delete

* @var int

[195] Fix | Delete

[196] Fix | Delete

public $STATUS_CODE;

[197] Fix | Delete

[198] Fix | Delete

/**

[199] Fix | Delete

* @var string

[200] Fix | Delete

[201] Fix | Delete

public $STATUS_MESSAGE;

[202] Fix | Delete

[203] Fix | Delete

/**

[204] Fix | Delete

* ET_Core_HTTP_Response constructor.

[205] Fix | Delete

[206] Fix | Delete

* @param ET_Core_HTTPRequest $request

[207] Fix | Delete

* @param array|WP_Error $response

[208] Fix | Delete

[209] Fix | Delete

public function __construct( $request, $response ) {

[210] Fix | Delete

$this->REQUEST = $request;

[211] Fix | Delete

$this->RAW_RESPONSE = $response;

[212] Fix | Delete

[213] Fix | Delete

$this->_parse_response();

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

/**

[217] Fix | Delete

* Parse response and save relevant details.

[218] Fix | Delete

[219] Fix | Delete

private function _parse_response() {

[220] Fix | Delete

if ( is_wp_error( $this->RAW_RESPONSE ) ) {

[221] Fix | Delete

$this->ERROR = true;

[222] Fix | Delete

$this->ERROR_MESSAGE = $this->RAW_RESPONSE->get_error_message();

[223] Fix | Delete

$this->STATUS_CODE = $this->RAW_RESPONSE->get_error_code();

[224] Fix | Delete

$this->STATUS_MESSAGE = $this->ERROR_MESSAGE;

[225] Fix | Delete

return;

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

$this->DATA = $this->RAW_RESPONSE['body'];

[229] Fix | Delete

$this->HEADERS = $this->RAW_RESPONSE['headers'];

[230] Fix | Delete

$this->COOKIES = $this->RAW_RESPONSE['cookies'];

[231] Fix | Delete

$this->STATUS_CODE = $this->RAW_RESPONSE['response']['code'];

[232] Fix | Delete

$this->STATUS_MESSAGE = $this->RAW_RESPONSE['response']['message'];

[233] Fix | Delete

[234] Fix | Delete

if ( $this->STATUS_CODE >= 400 ) {

[235] Fix | Delete

$this->ERROR = true;

[236] Fix | Delete

$this->ERROR_MESSAGE = $this->STATUS_MESSAGE;

[237] Fix | Delete

}

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

/**

[241] Fix | Delete

* Only include necessary properties when printing this object using {@link var_dump}.

[242] Fix | Delete

[243] Fix | Delete

* @return array

[244] Fix | Delete

[245] Fix | Delete

public function __debugInfo() {

[246] Fix | Delete

return array(

[247] Fix | Delete

'STATUS_CODE' => $this->STATUS_CODE,

[248] Fix | Delete

'STATUS_MESSAGE' => $this->STATUS_MESSAGE,

[249] Fix | Delete

'ERROR' => $this->ERROR,

[250] Fix | Delete

'ERROR_MESSAGE' => $this->ERROR_MESSAGE,

[251] Fix | Delete

'DATA' => $this->DATA,

[252] Fix | Delete

);

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Only include necessary properties when serializing this object for

[257] Fix | Delete

* storage in the WP Transient Cache.

[258] Fix | Delete

[259] Fix | Delete

* @return array

[260] Fix | Delete

[261] Fix | Delete

public function __sleep() {

[262] Fix | Delete

return array( 'ERROR', 'ERROR_MESSAGE', 'STATUS_CODE', 'STATUS_MESSAGE', 'DATA' );

[263] Fix | Delete

}

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

[267] Fix | Delete

/**

[268] Fix | Delete

* High level, generic, wrapper for making HTTP requests. It uses WordPress HTTP API under-the-hood.

[269] Fix | Delete

[270] Fix | Delete

* @since 1.1.0

[271] Fix | Delete

[272] Fix | Delete

* @package ET\Core\HTTP

[273] Fix | Delete

[274] Fix | Delete

class ET_Core_HTTPInterface {

[275] Fix | Delete

/**

[276] Fix | Delete

* How much time responses are cached (in seconds).

[277] Fix | Delete

[278] Fix | Delete

* @since 1.1.0

[279] Fix | Delete

* @var int

[280] Fix | Delete

[281] Fix | Delete

protected $cache_timeout;

[282] Fix | Delete

[283] Fix | Delete

/**

[284] Fix | Delete

* @var ET_Core_HTTPRequest

[285] Fix | Delete

[286] Fix | Delete

public $request;

[287] Fix | Delete

[288] Fix | Delete

/**

[289] Fix | Delete

* @var ET_Core_HTTPResponse

[290] Fix | Delete

[291] Fix | Delete

public $response;

[292] Fix | Delete

[293] Fix | Delete

/**

[294] Fix | Delete

* ET_Core_API_HTTP_Interface constructor.

[295] Fix | Delete

[296] Fix | Delete

* @since 1.1.0

[297] Fix | Delete

[298] Fix | Delete

* @param string $owner The name of the theme/plugin that created this class instance. Default: 'ET_Core'.

[299] Fix | Delete

* @param array $request_details Array of config values for the request. Optional.

[300] Fix | Delete

* @param bool $json Whether or not json responses are expected to be received. Default is `true`.

[301] Fix | Delete

[302] Fix | Delete

public function __construct( $owner = 'ET_Core', $request_details = array(), $json = true ) {

[303] Fix | Delete

$this->expects_json = $json;

[304] Fix | Delete

$this->cache_timeout = 15 * MINUTE_IN_SECONDS;

[305] Fix | Delete

$this->owner = $owner;

[306] Fix | Delete

[307] Fix | Delete

if ( ! empty( $request_details ) ) {

[308] Fix | Delete

list( $url, $method, $is_auth, $body ) = $request_details;

[309] Fix | Delete

$this->prepare_request( $url, $method, $is_auth, $body );

[310] Fix | Delete

}

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete

/**

[314] Fix | Delete

* Only include necessary properties when printing this object using {@link var_dump}.

[315] Fix | Delete

[316] Fix | Delete

* @return array

[317] Fix | Delete

[318] Fix | Delete

public function __debugInfo() {

[319] Fix | Delete

return array(

[320] Fix | Delete

'REQUEST' => $this->request,

[321] Fix | Delete

'RESPONSE' => $this->response,

[322] Fix | Delete

);

[323] Fix | Delete

}

[324] Fix | Delete

[325] Fix | Delete

/**

[326] Fix | Delete

* Only include necessary properties when serializing this object for

[327] Fix | Delete

* storage in the WP Transient Cache.

[328] Fix | Delete

[329] Fix | Delete

* @return array

[330] Fix | Delete

[331] Fix | Delete

public function __sleep() {

[332] Fix | Delete

return array( 'request', 'response' );

[333] Fix | Delete

}

[334] Fix | Delete

[335] Fix | Delete

/**

[336] Fix | Delete

* Creates an identifier key for a request based on the URL and body content.

[337] Fix | Delete

[338] Fix | Delete

* @internal

[339] Fix | Delete

* @since 1.1.0

[340] Fix | Delete

[341] Fix | Delete

* @param string $url The request URL.

[342] Fix | Delete

* @param string|string[] $body The request body.

[343] Fix | Delete

[344] Fix | Delete

* @return string

[345] Fix | Delete

[346] Fix | Delete

protected static function _get_cache_key_for_request( $url, $body ) {

[347] Fix | Delete

if ( is_array( $body ) ) {

[348] Fix | Delete

$url .= json_encode( $body );

[349] Fix | Delete

[350] Fix | Delete

} else if ( ! empty( $body ) ) {

[351] Fix | Delete

$url .= $body;

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

return 'et-core-http-response-' . md5( $url );

[355] Fix | Delete

}

[356] Fix | Delete

[357] Fix | Delete

/**

[358] Fix | Delete

* Writes request/response info to the error log for failed requests.

[359] Fix | Delete

[360] Fix | Delete

* @internal

[361] Fix | Delete

* @since 1.1.0

[362] Fix | Delete

[363] Fix | Delete

protected function _log_failed_request() {

[364] Fix | Delete

$details = print_r( $this, true );

[365] Fix | Delete

$class_name = get_class( $this );

[366] Fix | Delete

$msg_part = "{$class_name} ERROR :: Remote request failed...\n\n";

[367] Fix | Delete

$msg = "{$msg_part}Details: {$details}";

[368] Fix | Delete

[369] Fix | Delete

$max_len = @ini_get( 'log_errors_max_len' );

[370] Fix | Delete

[371] Fix | Delete

@ini_set( 'log_errors_max_len', 0 );

[372] Fix | Delete

[373] Fix | Delete

ET_Core_Logger::error( $msg );

[374] Fix | Delete

[375] Fix | Delete

if ( $max_len ) {

[376] Fix | Delete

@ini_set( 'log_errors_max_len', $max_len );

[377] Fix | Delete

}

[378] Fix | Delete

}

[379] Fix | Delete

[380] Fix | Delete

/**

[381] Fix | Delete

* Prepares request to send JSON data.

[382] Fix | Delete

[383] Fix | Delete

protected function _setup_json_request() {

[384] Fix | Delete

$this->request->HEADERS['Accept'] = 'application/json';

[385] Fix | Delete

[386] Fix | Delete

if ( $this->request->JSON_BODY ) {

[387] Fix | Delete

$this->request->HEADERS['Content-Type'] = 'application/json';

[388] Fix | Delete

[389] Fix | Delete

$is_json = is_string( $this->request->BODY ) && in_array( $this->request->BODY[0], array( '[', '{' ) );

[390] Fix | Delete

[391] Fix | Delete

if ( $is_json || null === $this->request->BODY ) {

[392] Fix | Delete

return;

[393] Fix | Delete

}

[394] Fix | Delete

[395] Fix | Delete

$this->request->BODY = json_encode( $this->request->BODY );

[396] Fix | Delete

}

[397] Fix | Delete

}

[398] Fix | Delete

[399] Fix | Delete

/**

[400] Fix | Delete

* Performs a remote HTTP request. Responses are cached for {@see self::$cache_timeout} seconds using

[401] Fix | Delete

* the {@link https://goo.gl/c0FSMH WP Transients API}.

[402] Fix | Delete

[403] Fix | Delete

* @since 1.1.0

[404] Fix | Delete

[405] Fix | Delete

public function make_remote_request() {

[406] Fix | Delete

$response = null;

[407] Fix | Delete

[408] Fix | Delete

if ( $this->expects_json && ! isset( $this->request->HEADERS['Content-Type'] ) ) {

[409] Fix | Delete

$this->_setup_json_request();

[410] Fix | Delete

}

[411] Fix | Delete

[412] Fix | Delete

// Make sure we include any changes made after request object was instantiated.

[413] Fix | Delete

$this->request->prepare_args();

[414] Fix | Delete

[415] Fix | Delete

if ( 'POST' === $this->request->METHOD ) {

[416] Fix | Delete

$response = wp_remote_post( $this->request->URL, $this->request->ARGS );

[417] Fix | Delete

[418] Fix | Delete

} else if ( 'GET' === $this->request->METHOD && null === $this->request->data_format ) {

[419] Fix | Delete

$response = wp_remote_get( $this->request->URL, $this->request->ARGS );

[420] Fix | Delete

[421] Fix | Delete

} else if ( 'GET' === $this->request->METHOD && null !== $this->request->data_format ) {

[422] Fix | Delete

// WordPress sends data as query args for GET and HEAD requests and provides no way

[423] Fix | Delete

// to alter that behavior. Thus, we need to monkey patch it for now. See the mp'd class

[424] Fix | Delete

// for more details.

[425] Fix | Delete

require_once 'lib/WPHttp.php';

[426] Fix | Delete

$wp_http = new ET_Core_LIB_WPHttp();

[427] Fix | Delete

$this->request->ARGS['data_format'] = $this->request->data_format;

[428] Fix | Delete

$response = $wp_http->request( $this->request->URL, $this->request->ARGS );

[429] Fix | Delete

[430] Fix | Delete

} else if ( 'PUT' === $this->request->METHOD ) {

[431] Fix | Delete

$this->request->ARGS['method'] = 'PUT';

[432] Fix | Delete

$response = wp_remote_request( $this->request->URL, $this->request->ARGS );

[433] Fix | Delete

}

[434] Fix | Delete

[435] Fix | Delete

$this->response = $response = new ET_Core_HTTPResponse( $this->request, $response );

[436] Fix | Delete

[437] Fix | Delete

if ( $response->ERROR || defined( 'ET_DEBUG' ) ) {

[438] Fix | Delete

$this->_log_failed_request();

[439] Fix | Delete

}

[440] Fix | Delete

[441] Fix | Delete

if ( $this->expects_json ) {

[442] Fix | Delete

$response->DATA = json_decode( $response->DATA, true );

[443] Fix | Delete

}

[444] Fix | Delete

[445] Fix | Delete

$this->request->COMPLETE = true;

[446] Fix | Delete

}

[447] Fix | Delete

[448] Fix | Delete

/**

[449] Fix | Delete

* Replaces the current request object with a new instance.

[450] Fix | Delete

[451] Fix | Delete

* @param string $url

[452] Fix | Delete

* @param string $method

[453] Fix | Delete

* @param bool $is_auth

[454] Fix | Delete

* @param mixed? $body

[455] Fix | Delete

* @param bool $json_body

[456] Fix | Delete

* @param bool $ssl_verify

[457] Fix | Delete

[458] Fix | Delete

public function prepare_request( $url, $method = 'GET', $is_auth = false, $body = null, $json_body = false, $ssl_verify = true ) {

[459] Fix | Delete

$this->request = new ET_Core_HTTPRequest( $url, $method, $this->owner, $is_auth, $body, $json_body, $ssl_verify );

[460] Fix | Delete

}

[461] Fix | Delete

}

[462] Fix | Delete

[463] Fix | Delete