Skip to content

Commit

Permalink
Improve error handling for Gravity Forms
Browse files Browse the repository at this point in the history
Separated unserialization error handling from HTTP request/response error handling.

Wrapped unserialization in try/catch to intercept any throwables from unexpected objects in their unserialization handlers. Gravity Forms is supposed to return an associative array but could be compromised.

Output a truncated excerpt of the response body if unserialization fails to give a hint of what the issue might be. Ideally, add an error handler to catch the PHP notice that is raised by `unserialize()`.
  • Loading branch information
mcaskill committed Jun 9, 2023
1 parent 134926b commit ab73a24
Showing 1 changed file with 51 additions and 13 deletions.
64 changes: 51 additions & 13 deletions src/Plugins/GravityForms.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,34 +44,72 @@ public function getDownloadUrl() {
$api_url = 'https://gravityapi.com/wp-content/plugins/gravitymanager/api.php';

try {
$response = unserialize( $http->get( $api_url, $api_query ) );
$response = $http->get( $api_url, $api_query );
} catch ( Exception $e ) {
$details = $e->getMessage();
if ( $details ) {
$details = PHP_EOL . $details;
$details = [];

$error = $e->getMessage();
if ( $error ) {
$details[] = 'HTTP Error: ' . $error;
}

throw new UnexpectedValueException( sprintf(
'Could not query API for package %s. Please try again later.' . $details,
$message = sprintf(
'Could not query API for package %s. Please try again later.',
$this->getPackageName()
) );
);

if ( $details ) {
$message .= PHP_EOL . PHP_EOL . implode( PHP_EOL . PHP_EOL, $details );
}

throw new UnexpectedValueException( $message );
}

if ( ! is_array( $response ) ) {
throw new UnexpectedValueException( sprintf(
'Expected a serialized object from API for package %s',
// Catch any throwables from objects in their unserialization handlers.
// Composer itself handles converting PHP notices into exceptions.
try {
/**
* @todo When the Composer plugin drops support for PHP 5,
* use the `unserialize()` function's `allowed_classes` option,
* introduced in PHP 7, to disallow all classes.
*/
$data = unserialize( $response );

if ( $data !== false && ! is_array( $data ) ) {
throw new UnexpectedValueException(
'unserialize(): Expected a data structure'
);
}
} catch ( Exception $e ) {
$details = [
$e->getMessage(),
];

$response_length = mb_strlen( $response );
if ( $response_length > 0 ) {
$details[] = ' ' . mb_substr( $response, 0, 100 ) . ( $response_length > 100 ? '...' : '' );
}

$message = sprintf(
'Expected a data structure from API for package %s.',
$this->getPackageName()
) );
);

if ( $details ) {
$message .= PHP_EOL . PHP_EOL . implode( PHP_EOL . PHP_EOL, $details );
}

throw new UnexpectedValueException( $message );
}

if ( empty( $response['download_url_latest'] ) || ! is_string( $response['download_url_latest'] ) ) {
if ( empty( $data['download_url_latest'] ) || ! is_string( $data['download_url_latest'] ) ) {
throw new UnexpectedValueException( sprintf(
'Expected a valid download URL for package %s',
$this->getPackageName()
) );
}

return str_replace( 'http://', 'https://', $response['download_url_latest'] );
return str_replace( 'http://', 'https://', $data['download_url_latest'] );
}

}

0 comments on commit ab73a24

Please sign in to comment.