Skip to content

Commit

Permalink
Deploying version 1.7.1
Browse files Browse the repository at this point in the history
  • Loading branch information
ianmjones committed Oct 4, 2024
1 parent 8b4d4a2 commit 9984004
Show file tree
Hide file tree
Showing 78 changed files with 1,554 additions and 215 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
**Requires at least:** 5.3 \
**Tested up to:** 6.6 \
**Requires PHP:** 7.4 \
**Stable tag:** 1.7.0
**Stable tag:** 1.7.1

Fix your email delivery problems by sending your WordPress emails through Amazon SES's powerful email sending infrastructure.

Expand Down Expand Up @@ -197,6 +197,13 @@ Please double check the credentials match up with the credentials you received w

## Changelog

### 1.7.1 - 2024-10-04

* Security: The plugin now uses its own update mechanism from WP Engine servers
* New: Amazon SES regions Asia Pacific (Jakarta), Asia Pacific (Osaka), and Israel (Tel Aviv) are now selectable
* New: AWS PHP SDK has been updated to v3.319.4
* New: PHP and JS dependencies have been updated

### 1.7.0 - 2024-07-01

* New: Logs of successfully sent emails can now be instantly removed
Expand Down
244 changes: 244 additions & 0 deletions classes/Plugin-Updater.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,244 @@
<?php
/**
* The PluginUpdater class which can be used to pull plugin updates from a new location.
* @package wp-offload-ses
*/

namespace DeliciousBrains\WP_Offload_SES;

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}

use stdClass;

/**
* The PluginUpdater class which can be used to pull plugin updates from a new location.
*/
class Plugin_Updater {
/**
* The URL where the api is located.
* @var ApiUrl
*/
private $api_url;

/**
* The amount of time to wait before checking for new updates.
* @var CacheTime
*/
private $cache_time;

/**
* These properties are passed in when instantiating to identify the plugin and it's update location.
* @var Properties
*/
private $properties;

/**
* Get the class constructed.
*
* @param Properties $properties These properties are passed in when instantiating to identify the plugin and it's update location.
*/
public function __construct( $properties ) {
if (
empty( $properties['plugin_slug'] ) ||
empty( $properties['plugin_basename'] )
) {
error_log( 'WPE Secure Plugin Updater received a malformed request.' );
return;
}

$this->api_url = 'https://wpe-plugin-updates.wpengine.com/';

$this->cache_time = time() + HOUR_IN_SECONDS * 5;

$this->properties = $this->get_full_plugin_properties( $properties, $this->api_url );

if ( ! $this->properties ) {
return;
}

$this->register();
}

/**
* Get the full plugin properties, including the directory name, version, basename, and add a transient name.
*
* @param Properties $properties These properties are passed in when instantiating to identify the plugin and it's update location.
* @param ApiUrl $api_url The URL where the api is located.
*/
public function get_full_plugin_properties( $properties, $api_url ) {
$plugins = \get_plugins();

// Scan through all plugins installed and find the one which matches this one in question.
foreach ( $plugins as $plugin_basename => $plugin_data ) {
// Match using the passed-in plugin's basename.
if ( $plugin_basename === $properties['plugin_basename'] ) {
// Add the values we need to the properties.
$properties['plugin_dirname'] = dirname( $plugin_basename );
$properties['plugin_version'] = $plugin_data['Version'];
$properties['plugin_update_transient_name'] = 'wpesu-plugin-' . sanitize_title( $properties['plugin_dirname'] );
$properties['plugin_update_transient_exp_name'] = 'wpesu-plugin-' . sanitize_title( $properties['plugin_dirname'] ) . '-expiry';
$properties['plugin_manifest_url'] = trailingslashit( $api_url ) . trailingslashit( $properties['plugin_slug'] ) . 'info.json';

return $properties;
}
}

// No matching plugin was found installed.
return null;
}

/**
* Register hooks.
*
* @return void
*/
public function register() {
add_filter( 'plugins_api', array( $this, 'filter_plugin_update_info' ), 20, 3 );
add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'filter_plugin_update_transient' ) );
}

/**
* Filter the plugin update transient to take over update notifications.
*
* @param object $transient The site_transient_update_plugins transient.
*
* @handles site_transient_update_plugins
* @return object
*/
public function filter_plugin_update_transient( $transient ) {
// No update object exists. Return early.
if ( empty( $transient ) ) {
return $transient;
}

$result = $this->fetch_plugin_info();

if ( false === $result ) {
return $transient;
}

if ( version_compare( $this->properties['plugin_version'], $result->version, '<' ) ) {
$res = $this->parse_plugin_info( $result );
$transient->response[ $res->plugin ] = $res;
$transient->checked[ $res->plugin ] = $result->version;
}

return $transient;
}

/**
* Filters the plugin update information.
*
* @param object $res The response to be modified for the plugin in question.
* @param string $action The action in question.
* @param object $args The arguments for the plugin in question.
*
* @handles plugins_api
* @return object
*/
public function filter_plugin_update_info( $res, $action, $args ) {
// Do nothing if this is not about getting plugin information.
if ( 'plugin_information' !== $action ) {
return $res;
}

// Do nothing if it is not our plugin.
if ( $this->properties['plugin_dirname'] !== $args->slug ) {
return $res;
}

$result = $this->fetch_plugin_info();

// Do nothing if we don't get the correct response from the server.
if ( false === $result ) {
return $res;
}

return $this->parse_plugin_info( $result );
}

/**
* Fetches the plugin update object from the WP Product Info API.
*
* @return object|false
*/
private function fetch_plugin_info() {
// Fetch cache first.
$expiry = get_option( $this->properties['plugin_update_transient_exp_name'], 0 );
$response = get_option( $this->properties['plugin_update_transient_name'] );

if ( empty( $expiry ) || time() > $expiry || empty( $response ) ) {
$response = wp_remote_get(
$this->properties['plugin_manifest_url'],
array(
'timeout' => 10,
'headers' => array(
'Accept' => 'application/json',
),
)
);

if (
is_wp_error( $response ) ||
200 !== wp_remote_retrieve_response_code( $response ) ||
empty( wp_remote_retrieve_body( $response ) )
) {
return false;
}

$response = wp_remote_retrieve_body( $response );

// Cache the response.
update_option( $this->properties['plugin_update_transient_exp_name'], $this->cache_time, false );
update_option( $this->properties['plugin_update_transient_name'], $response, false );
}

$decoded_response = json_decode( $response );

if ( json_last_error() !== JSON_ERROR_NONE ) {
return false;
}

return $decoded_response;
}

/**
* Parses the product info response into an object that WordPress would be able to understand.
*
* @param object $response The response object.
*
* @return stdClass
*/
private function parse_plugin_info( $response ) {

global $wp_version;

$res = new stdClass();
$res->name = $response->name;
$res->slug = $response->slug;
$res->version = $response->version;
$res->requires = $response->requires;
$res->download_link = $response->download_link;
$res->trunk = $response->download_link;
$res->new_version = $response->version;
$res->plugin = $this->properties['plugin_basename'];
$res->package = $response->download_link;

// Plugin information modal and core update table use a strict version comparison, which is weird.
// If we're genuinely not compatible with the point release, use our WP tested up to version.
// otherwise use exact same version as WP to avoid false positive.
$res->tested = 1 === version_compare( substr( $wp_version, 0, 3 ), $response->tested )
? $response->tested
: $wp_version;

$res->sections = array(
'description' => $response->sections->description,
'changelog' => $response->sections->changelog,
);

return $res;
}
}
3 changes: 3 additions & 0 deletions classes/SES-API.php
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,14 @@ public static function get_regions(): array {
'eu-north-1' => __( 'Europe (Stockholm)', 'wp-offload-ses' ),
'eu-south-1' => __( 'Europe (Milan)', 'wp-offload-ses' ),
'af-south-1' => __( 'Africa (Cape Town)', 'wp-offload-ses' ),
'ap-southeast-3' => __( 'Asia Pacific (Jakarta)', 'wp-offload-ses' ),
'ap-south-1' => __( 'Asia Pacific (Mumbai)', 'wp-offload-ses' ),
'ap-northeast-3' => __( 'Asia Pacific (Osaka)', 'wp-offload-ses' ),
'ap-northeast-2' => __( 'Asia Pacific (Seoul)', 'wp-offload-ses' ),
'ap-southeast-1' => __( 'Asia Pacific (Singapore)', 'wp-offload-ses' ),
'ap-southeast-2' => __( 'Asia Pacific (Sydney)', 'wp-offload-ses' ),
'ap-northeast-1' => __( 'Asia Pacific (Tokyo)', 'wp-offload-ses' ),
'il-central-1' => __( 'Israel (Tel Aviv)', 'wp-offload-ses' ),
'me-south-1' => __( 'Middle East (Bahrain)', 'wp-offload-ses' ),
'sa-east-1' => __( 'South America (São Paulo)', 'wp-offload-ses' ),
);
Expand Down
Loading

0 comments on commit 9984004

Please sign in to comment.