Weak hands cannot be planted, meager skills have no foundation. Shallow wisdom is futile, how can one hope for a good name?扰扰从役倦，屑屑身事微。少壮轻年月，迟暮惜光辉。
account_url;
}
/**
* Returns the URL where the user can register, if they
* do not yet have an account
*
* @since 2.8.9
*
* @return string Registration URL
*/
public function get_registration_url() {
return $this->referral_url;
}
/**
* Overrides the default API Key with the supplied API Key
*
* @since 2.2.9
*
* @param string $api_key API Key.
*/
public function set_api_key( $api_key ) {
$this->api_key = $api_key;
}
/**
* Sets headers to include in the request
*
* @since 2.2.9
*
* @param array $headers HTTP Headers.
*/
public function set_headers( $headers ) {
$this->headers = $headers;
}
/**
* Sanitizes API arguments, by removing false or empty
* arguments in the array.
*
* @since 2.8.9
*
* @param array $args Arguments.
* @return array Sanitized Arguments
*/
public function sanitize_arguments( $args ) {
foreach ( $args as $key => $value ) {
if ( empty( $value ) ) {
unset( $args[ $key ] );
}
}
return $args;
}
/**
* Performs a GET request
*
* @since 2.2.9
*
* @param string $cmd Command.
* @param array|bool|string $params Params.
* @return WP_Error|string|object
*/
public function get( $cmd, $params = false ) {
return $this->request( $cmd, 'get', $params );
}
/**
* Performs a POST request
*
* @since 2.2.9
*
* @param string $cmd Command.
* @param array|bool|string $params Params.
* @return WP_Error|string|object
*/
public function post( $cmd, $params = false ) {
return $this->request( $cmd, 'post', $params );
}
/**
* Performs a PUT request
*
* @since 2.8.9
*
* @param string $cmd Command.
* @param array|bool|string $params Params.
* @return WP_Error|string|object
*/
public function put( $cmd, $params = false ) {
return $this->request( $cmd, 'put', $params );
}
/**
* Returns the maximum amount of time to wait for
* a response to the request before exiting
*
* @since 2.2.9
*
* @return int Timeout, in seconds
*/
public function get_timeout() {
$timeout = 30;
/**
* Defines the maximum time to allow the API request to run.
*
* @since 2.2.9
*
* @param int $timeout Timeout, in seconds
*/
$timeout = apply_filters( 'page_generator_pro_api_get_timeout', $timeout );
return $timeout;
}
/**
* Returns the number of seconds to pause before attempting
* a request again when the first request returned a 429
* rate limit reached.
*
* @since 4.8.0
*
* @param bool|array $response HTTP response.
* @param bool|string|array $body HTTP response body. If JSON, this will be a non-decoded string.
* @return int Pause, in seconds
*/
public function get_backoff_time( $response = false, $body = false ) {
$pause = 5;
/**
* Returns the number of seconds to pause before attempting
* a request again when the first request returned a 429
* rate limit reached.
*
* @since 4.8.0
*
* @param int $pause Pause, in seconds.
* @param bool|array $response HTTP response.
* @param bool|string|array $body HTTP response body. If JSON, this will be a non-decoded string.
*/
$pause = apply_filters( 'page_generator_pro_api_get_backoff_time', $pause, $response, $body );
return $pause;
}
/**
* Main function which handles sending requests to an API using WordPress functions
*
* @since 2.2.9
*
* @param string $cmd Command (required).
* @param string $method HTTP Method (optional).
* @param array|bool|string $params Params.
* @param bool $retry_if_rate_limit_hit Pause and retry the request if a 429 rate limit hit.
* @return WP_Error|object|string
*/
private function request( $cmd, $method = 'get', $params = array(), $retry_if_rate_limit_hit = true ) {
// Send request.
switch ( $method ) {
/**
* POST
*/
case 'post':
$result = wp_remote_post(
$this->set_url( $cmd ),
array(
'headers' => $this->headers,
'body' => $this->build_params_string( $params ),
'timeout' => $this->get_timeout(),
'user-agent' => $this->user_agent,
'sslverify' => false,
)
);
break;
/**
* PUT
*/
case 'put':
$result = wp_remote_post(
$this->set_url( $cmd ),
array(
'method' => 'PUT',
'headers' => $this->headers,
'body' => $this->build_params_string( $params ),
'timeout' => $this->get_timeout(),
'user-agent' => $this->user_agent,
'sslverify' => false,
)
);
break;
/**
* GET
*/
case 'get':
default:
$result = wp_remote_get(
$this->set_url( $cmd ),
array(
'headers' => $this->headers,
'body' => ( $params !== false ? $params : '' ),
'timeout' => $this->get_timeout(),
'user-agent' => $this->user_agent,
'sslverify' => false,
)
);
break;
}
// If an error occured, return it now.
if ( is_wp_error( $result ) ) {
return $result;
}
// Fetch HTTP response code and body.
$http_response_code = wp_remote_retrieve_response_code( $result );
$body = wp_remote_retrieve_body( $result );
// Check the HTTP response code for possible generic errors that we can provide
// tailored error messages for.
switch ( $http_response_code ) {
case 401:
case 403:
return new WP_Error(
'page_generator_pro_api_request_error',
sprintf(
/* translators: HTTP response code */
__( 'HTTP Code %s. Did you enter a valid API key in the Plugin Settings?', 'page-generator-pro' ),
$http_response_code
),
$body
);
// API rate limit reached.
case 429:
// If retry on rate limit hit is disabled, return a WP_Error.
if ( ! $retry_if_rate_limit_hit ) {
return new WP_Error(
'page_generator_pro_api_request_error',
__( '429 Rate Limit hit.', 'page-generator-pro' ),
$body
);
}
// Wait for the duration of the backoff time, and retry the request a final time.
sleep( $this->get_backoff_time( $result, $body ) );
return $this->request( $cmd, $method, $params, false );
// Server temporarily overloaded.
case 529:
// If retry on rate limit hit is disabled, return a WP_Error.
if ( ! $retry_if_rate_limit_hit ) {
return new WP_Error(
'page_generator_pro_api_request_error',
__( '529 API temporarily overloaded.', 'page-generator-pro' ),
$body
);
}
// Wait for the duration of the backoff time, and retry the request a final time.
sleep( $this->get_backoff_time( $result, $body ) );
return $this->request( $cmd, $method, $params, false );
}
// If the body is empty, return a generic error.
if ( is_null( $body ) || empty( $body ) ) { // @phpstan-ignore-line
return new WP_Error(
'page_generator_pro_api_error',
__( 'Response data empty', 'page-generator-pro' ),
$body
);
}
// Just return the body if it's not a JSON response.
if ( ! $this->is_json_response ) {
return $body;
}
// Decode JSON.
$body = json_decode( $body );
// If decoding JSON results in a null string, something went wrong.
if ( is_null( $body ) ) {
return new WP_Error(
'page_generator_pro_api_error',
__( 'Response data not valid JSON', 'page-generator-pro' )
);
}
// Return JSON response object.
return $body;
}
/**
* Inspects the response from the API call, returning an error
* or data if it exists in $response->error->message.
*
* Integrations may override this method if they need to inspect
* different objects and keys.
*
* @since 4.9.1
*
* @param WP_Error|object $response Response.
* @return WP_Error|object
*/
public function response( $response ) {
// If the response is an error, return it.
// This happens when a 401, 403, 429 or 529 happen.
if ( is_wp_error( $response ) ) {
// If the error data is null, return the original WP_Error,
// with the ID set to this integration.
if ( is_null( $response->get_error_data() ) ) {
return new WP_Error(
'page_generator_pro_error',
$response->get_error_message()
);
}
// If the WP_Error object includes error_data, fetch it.
$error = json_decode( $response->get_error_data() );
// If the error is false, return the original WP_Error,
// with the ID set to this integration.
if ( ! $error ) {
return new WP_Error(
'page_generator_pro_error',
$response->get_error_message()
);
}
// Assign the JSON decoded body to $response.
$response = $error;
}
// The request returned a different HTTP code, so the body will be a JSON
// decoded object.
// Check it for any errors.
if ( isset( $response->error ) ) {
return new WP_Error(
'page_generator_pro_error',
$response->error->message
);
}
// If here, the request succeeded.
return $response;
}
/**
* Sets the full URL to request
*
* @since 2.2.9
*
* @param string $cmd Command.
* @return string Full URL
*/
private function set_url( $cmd ) {
// If $cmd is empty, bail.
if ( empty( $cmd ) ) {
return $this->api_endpoint;
}
return $this->api_endpoint . '/' . $cmd;
}
/**
* Returns a string to send in the body of a request, depending on
* whether the data should be JSON encoded or not
*
* @since 2.8.9