Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Inc

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Handles requests to MyYoast.

[8] Fix | Delete

[9] Fix | Delete

class WPSEO_MyYoast_Api_Request {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* The Request URL.

[13] Fix | Delete

[14] Fix | Delete

* @var string

[15] Fix | Delete

[16] Fix | Delete

protected $url;

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* The request parameters.

[20] Fix | Delete

[21] Fix | Delete

* @var array

[22] Fix | Delete

[23] Fix | Delete

protected $args = [

[24] Fix | Delete

'method' => 'GET',

[25] Fix | Delete

'timeout' => 5,

[26] Fix | Delete

'headers' => [

[27] Fix | Delete

'Accept-Encoding' => '*',

[28] Fix | Delete

'Expect' => '',

[29] Fix | Delete

[30] Fix | Delete

];

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Contains the fetched response.

[34] Fix | Delete

[35] Fix | Delete

* @var stdClass

[36] Fix | Delete

[37] Fix | Delete

protected $response;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Contains the error message when request went wrong.

[41] Fix | Delete

[42] Fix | Delete

* @var string

[43] Fix | Delete

[44] Fix | Delete

protected $error_message = '';

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Constructor.

[48] Fix | Delete

[49] Fix | Delete

* @codeCoverageIgnore

[50] Fix | Delete

[51] Fix | Delete

* @param string $url The request url.

[52] Fix | Delete

* @param array $args The request arguments.

[53] Fix | Delete

[54] Fix | Delete

public function __construct( $url, array $args = [] ) {

[55] Fix | Delete

$this->url = 'https://my.yoast.com/api/' . $url;

[56] Fix | Delete

$this->args = wp_parse_args( $args, $this->args );

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Fires the request.

[61] Fix | Delete

[62] Fix | Delete

* @return bool True when request is successful.

[63] Fix | Delete

[64] Fix | Delete

public function fire() {

[65] Fix | Delete

try {

[66] Fix | Delete

$response = $this->do_request( $this->url, $this->args );

[67] Fix | Delete

$this->response = $this->decode_response( $response );

[68] Fix | Delete

[69] Fix | Delete

return true;

[70] Fix | Delete

}

[71] Fix | Delete

catch ( WPSEO_MyYoast_Bad_Request_Exception $bad_request_exception ) {

[72] Fix | Delete

$this->error_message = $bad_request_exception->getMessage();

[73] Fix | Delete

[74] Fix | Delete

return false;

[75] Fix | Delete

}

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Retrieves the error message.

[80] Fix | Delete

[81] Fix | Delete

* @return string The set error message.

[82] Fix | Delete

[83] Fix | Delete

public function get_error_message() {

[84] Fix | Delete

return $this->error_message;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Retrieves the response.

[89] Fix | Delete

[90] Fix | Delete

* @return stdClass The response object.

[91] Fix | Delete

[92] Fix | Delete

public function get_response() {

[93] Fix | Delete

return $this->response;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

/**

[97] Fix | Delete

* Performs the request using WordPress internals.

[98] Fix | Delete

[99] Fix | Delete

* @codeCoverageIgnore

[100] Fix | Delete

[101] Fix | Delete

* @param string $url The request URL.

[102] Fix | Delete

* @param array $request_arguments The request arguments.

[103] Fix | Delete

[104] Fix | Delete

* @return string The retrieved body.

[105] Fix | Delete

* @throws WPSEO_MyYoast_Bad_Request_Exception When request is invalid.

[106] Fix | Delete

[107] Fix | Delete

protected function do_request( $url, $request_arguments ) {

[108] Fix | Delete

$request_arguments = $this->enrich_request_arguments( $request_arguments );

[109] Fix | Delete

$response = wp_remote_request( $url, $request_arguments );

[110] Fix | Delete

[111] Fix | Delete

if ( is_wp_error( $response ) ) {

[112] Fix | Delete

throw new WPSEO_MyYoast_Bad_Request_Exception( $response->get_error_message() );

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

$response_code = wp_remote_retrieve_response_code( $response );

[116] Fix | Delete

$response_message = wp_remote_retrieve_response_message( $response );

[117] Fix | Delete

[118] Fix | Delete

// Do nothing, response code is okay.

[119] Fix | Delete

if ( $response_code === 200 || strpos( $response_code, '200' ) !== false ) {

[120] Fix | Delete

return wp_remote_retrieve_body( $response );

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

throw new WPSEO_MyYoast_Bad_Request_Exception( esc_html( $response_message ), (int) $response_code );

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

/**

[127] Fix | Delete

* Decodes the JSON encoded response.

[128] Fix | Delete

[129] Fix | Delete

* @param string $response The response to decode.

[130] Fix | Delete

[131] Fix | Delete

* @return stdClass The json decoded response.

[132] Fix | Delete

* @throws WPSEO_MyYoast_Invalid_JSON_Exception When decoded string is not a JSON object.

[133] Fix | Delete

[134] Fix | Delete

protected function decode_response( $response ) {

[135] Fix | Delete

$response = json_decode( $response );

[136] Fix | Delete

[137] Fix | Delete

if ( ! is_object( $response ) ) {

[138] Fix | Delete

throw new WPSEO_MyYoast_Invalid_JSON_Exception(

[139] Fix | Delete

esc_html__( 'No JSON object was returned.', 'wordpress-seo' )

[140] Fix | Delete

);

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

return $response;

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* Checks if MyYoast tokens are allowed and adds the token to the request body.

[148] Fix | Delete

[149] Fix | Delete

* When tokens are disallowed it will add the url to the request body.

[150] Fix | Delete

[151] Fix | Delete

* @param array $request_arguments The arguments to enrich.

[152] Fix | Delete

[153] Fix | Delete

* @return array The enriched arguments.

[154] Fix | Delete

[155] Fix | Delete

protected function enrich_request_arguments( array $request_arguments ) {

[156] Fix | Delete

$request_arguments = wp_parse_args( $request_arguments, [ 'headers' => [] ] );

[157] Fix | Delete

$addon_version_headers = $this->get_installed_addon_versions();

[158] Fix | Delete

[159] Fix | Delete

foreach ( $addon_version_headers as $addon => $version ) {

[160] Fix | Delete

$request_arguments['headers'][ $addon . '-version' ] = $version;

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

$request_body = $this->get_request_body();

[164] Fix | Delete

if ( $request_body !== [] ) {

[165] Fix | Delete

$request_arguments['body'] = $request_body;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

return $request_arguments;

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

/**

[172] Fix | Delete

* Retrieves the request body based on URL or access token support.

[173] Fix | Delete

[174] Fix | Delete

* @codeCoverageIgnore

[175] Fix | Delete

[176] Fix | Delete

* @return array The request body.

[177] Fix | Delete

[178] Fix | Delete

public function get_request_body() {

[179] Fix | Delete

return [ 'url' => WPSEO_Utils::get_home_url() ];

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

/**

[183] Fix | Delete

* Wraps the get current user id function.

[184] Fix | Delete

[185] Fix | Delete

* @codeCoverageIgnore

[186] Fix | Delete

[187] Fix | Delete

* @return int The user id.

[188] Fix | Delete

[189] Fix | Delete

protected function get_current_user_id() {

[190] Fix | Delete

return get_current_user_id();

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

/**

[194] Fix | Delete

* Retrieves the installed addons as http headers.

[195] Fix | Delete

[196] Fix | Delete

* @codeCoverageIgnore

[197] Fix | Delete

[198] Fix | Delete

* @return array The installed addon versions.

[199] Fix | Delete

[200] Fix | Delete

protected function get_installed_addon_versions() {

[201] Fix | Delete

$addon_manager = new WPSEO_Addon_Manager();

[202] Fix | Delete

[203] Fix | Delete

return $addon_manager->get_installed_addons_versions();

[204] Fix | Delete

}

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete