|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * The PluginUpdater class which can be used to pull plugin updates from a new location. |
| 4 | + * @package wp-migrate-db |
| 5 | + */ |
| 6 | + |
| 7 | +namespace DeliciousBrains\WPMDB\Free; |
| 8 | + |
| 9 | +// Exit if accessed directly. |
| 10 | +if ( ! defined( 'ABSPATH' ) ) { |
| 11 | + exit; |
| 12 | +} |
| 13 | + |
| 14 | +use stdClass; |
| 15 | + |
| 16 | +/** |
| 17 | + * The PluginUpdater class which can be used to pull plugin updates from a new location. |
| 18 | + */ |
| 19 | +class PluginUpdater { |
| 20 | + /** |
| 21 | + * The URL where the api is located. |
| 22 | + * @var ApiUrl |
| 23 | + */ |
| 24 | + private $api_url; |
| 25 | + |
| 26 | + /** |
| 27 | + * The amount of time to wait before checking for new updates. |
| 28 | + * @var CacheTime |
| 29 | + */ |
| 30 | + private $cache_time; |
| 31 | + |
| 32 | + /** |
| 33 | + * These properties are passed in when instantiating to identify the plugin and it's update location. |
| 34 | + * @var Properties |
| 35 | + */ |
| 36 | + private $properties; |
| 37 | + |
| 38 | + /** |
| 39 | + * Get the class constructed. |
| 40 | + * |
| 41 | + * @param Properties $properties These properties are passed in when instantiating to identify the plugin and it's update location. |
| 42 | + */ |
| 43 | + public function __construct( $properties ) { |
| 44 | + if ( |
| 45 | + empty( $properties['plugin_slug'] ) || |
| 46 | + empty( $properties['plugin_basename'] ) |
| 47 | + ) { |
| 48 | + error_log( 'WPE Secure Plugin Updater received a malformed request.' ); |
| 49 | + return; |
| 50 | + } |
| 51 | + |
| 52 | + $this->api_url = 'https://wpe-plugin-updates.wpengine.com/'; |
| 53 | + |
| 54 | + $this->cache_time = time() + HOUR_IN_SECONDS * 5; |
| 55 | + |
| 56 | + $this->properties = $this->get_full_plugin_properties( $properties, $this->api_url ); |
| 57 | + |
| 58 | + if ( ! $this->properties ) { |
| 59 | + return; |
| 60 | + } |
| 61 | + |
| 62 | + $this->register(); |
| 63 | + } |
| 64 | + |
| 65 | + /** |
| 66 | + * Get the full plugin properties, including the directory name, version, basename, and add a transient name. |
| 67 | + * |
| 68 | + * @param Properties $properties These properties are passed in when instantiating to identify the plugin and it's update location. |
| 69 | + * @param ApiUrl $api_url The URL where the api is located. |
| 70 | + */ |
| 71 | + public function get_full_plugin_properties( $properties, $api_url ) { |
| 72 | + $plugins = \get_plugins(); |
| 73 | + |
| 74 | + // Scan through all plugins installed and find the one which matches this one in question. |
| 75 | + foreach ( $plugins as $plugin_basename => $plugin_data ) { |
| 76 | + // Match using the passed-in plugin's basename. |
| 77 | + if ( $plugin_basename === $properties['plugin_basename'] ) { |
| 78 | + // Add the values we need to the properties. |
| 79 | + $properties['plugin_dirname'] = dirname( $plugin_basename ); |
| 80 | + $properties['plugin_version'] = $plugin_data['Version']; |
| 81 | + $properties['plugin_update_transient_name'] = 'wpesu-plugin-' . sanitize_title( $properties['plugin_dirname'] ); |
| 82 | + $properties['plugin_update_transient_exp_name'] = 'wpesu-plugin-' . sanitize_title( $properties['plugin_dirname'] ) . '-expiry'; |
| 83 | + $properties['plugin_manifest_url'] = trailingslashit( $api_url ) . trailingslashit( $properties['plugin_slug'] ) . 'info.json'; |
| 84 | + |
| 85 | + return $properties; |
| 86 | + } |
| 87 | + } |
| 88 | + |
| 89 | + // No matching plugin was found installed. |
| 90 | + return null; |
| 91 | + } |
| 92 | + |
| 93 | + /** |
| 94 | + * Register hooks. |
| 95 | + * |
| 96 | + * @return void |
| 97 | + */ |
| 98 | + public function register() { |
| 99 | + add_filter( 'plugins_api', array( $this, 'filter_plugin_update_info' ), 20, 3 ); |
| 100 | + add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'filter_plugin_update_transient' ) ); |
| 101 | + } |
| 102 | + |
| 103 | + /** |
| 104 | + * Filter the plugin update transient to take over update notifications. |
| 105 | + * |
| 106 | + * @param object $transient The site_transient_update_plugins transient. |
| 107 | + * |
| 108 | + * @handles site_transient_update_plugins |
| 109 | + * @return object |
| 110 | + */ |
| 111 | + public function filter_plugin_update_transient( $transient ) { |
| 112 | + // No update object exists. Return early. |
| 113 | + if ( empty( $transient ) ) { |
| 114 | + return $transient; |
| 115 | + } |
| 116 | + |
| 117 | + $result = $this->fetch_plugin_info(); |
| 118 | + |
| 119 | + if ( false === $result ) { |
| 120 | + return $transient; |
| 121 | + } |
| 122 | + |
| 123 | + if ( version_compare( $this->properties['plugin_version'], $result->version, '<' ) ) { |
| 124 | + $res = $this->parse_plugin_info( $result ); |
| 125 | + $transient->response[ $res->plugin ] = $res; |
| 126 | + $transient->checked[ $res->plugin ] = $result->version; |
| 127 | + } |
| 128 | + |
| 129 | + return $transient; |
| 130 | + } |
| 131 | + |
| 132 | + /** |
| 133 | + * Filters the plugin update information. |
| 134 | + * |
| 135 | + * @param object $res The response to be modified for the plugin in question. |
| 136 | + * @param string $action The action in question. |
| 137 | + * @param object $args The arguments for the plugin in question. |
| 138 | + * |
| 139 | + * @handles plugins_api |
| 140 | + * @return object |
| 141 | + */ |
| 142 | + public function filter_plugin_update_info( $res, $action, $args ) { |
| 143 | + // Do nothing if this is not about getting plugin information. |
| 144 | + if ( 'plugin_information' !== $action ) { |
| 145 | + return $res; |
| 146 | + } |
| 147 | + |
| 148 | + // Do nothing if it is not our plugin. |
| 149 | + if ( $this->properties['plugin_dirname'] !== $args->slug ) { |
| 150 | + return $res; |
| 151 | + } |
| 152 | + |
| 153 | + $result = $this->fetch_plugin_info(); |
| 154 | + |
| 155 | + // Do nothing if we don't get the correct response from the server. |
| 156 | + if ( false === $result ) { |
| 157 | + return $res; |
| 158 | + } |
| 159 | + |
| 160 | + return $this->parse_plugin_info( $result ); |
| 161 | + } |
| 162 | + |
| 163 | + /** |
| 164 | + * Fetches the plugin update object from the WP Product Info API. |
| 165 | + * |
| 166 | + * @return object|false |
| 167 | + */ |
| 168 | + private function fetch_plugin_info() { |
| 169 | + // Fetch cache first. |
| 170 | + $expiry = get_option( $this->properties['plugin_update_transient_exp_name'], 0 ); |
| 171 | + $response = get_option( $this->properties['plugin_update_transient_name'] ); |
| 172 | + |
| 173 | + if ( empty( $expiry ) || time() > $expiry || empty( $response ) ) { |
| 174 | + $response = wp_remote_get( |
| 175 | + $this->properties['plugin_manifest_url'], |
| 176 | + array( |
| 177 | + 'timeout' => 10, |
| 178 | + 'headers' => array( |
| 179 | + 'Accept' => 'application/json', |
| 180 | + ), |
| 181 | + ) |
| 182 | + ); |
| 183 | + |
| 184 | + if ( |
| 185 | + is_wp_error( $response ) || |
| 186 | + 200 !== wp_remote_retrieve_response_code( $response ) || |
| 187 | + empty( wp_remote_retrieve_body( $response ) ) |
| 188 | + ) { |
| 189 | + return false; |
| 190 | + } |
| 191 | + |
| 192 | + $response = wp_remote_retrieve_body( $response ); |
| 193 | + |
| 194 | + // Cache the response. |
| 195 | + update_option( $this->properties['plugin_update_transient_exp_name'], $this->cache_time, false ); |
| 196 | + update_option( $this->properties['plugin_update_transient_name'], $response, false ); |
| 197 | + } |
| 198 | + |
| 199 | + $decoded_response = json_decode( $response ); |
| 200 | + |
| 201 | + if ( json_last_error() !== JSON_ERROR_NONE ) { |
| 202 | + return false; |
| 203 | + } |
| 204 | + |
| 205 | + return $decoded_response; |
| 206 | + } |
| 207 | + |
| 208 | + /** |
| 209 | + * Parses the product info response into an object that WordPress would be able to understand. |
| 210 | + * |
| 211 | + * @param object $response The response object. |
| 212 | + * |
| 213 | + * @return stdClass |
| 214 | + */ |
| 215 | + private function parse_plugin_info( $response ) { |
| 216 | + |
| 217 | + global $wp_version; |
| 218 | + |
| 219 | + $res = new stdClass(); |
| 220 | + $res->name = $response->name; |
| 221 | + $res->slug = $response->slug; |
| 222 | + $res->version = $response->version; |
| 223 | + $res->requires = $response->requires; |
| 224 | + $res->download_link = $response->download_link; |
| 225 | + $res->trunk = $response->download_link; |
| 226 | + $res->new_version = $response->version; |
| 227 | + $res->plugin = $this->properties['plugin_basename']; |
| 228 | + $res->package = $response->download_link; |
| 229 | + |
| 230 | + // Plugin information modal and core update table use a strict version comparison, which is weird. |
| 231 | + // If we're genuinely not compatible with the point release, use our WP tested up to version. |
| 232 | + // otherwise use exact same version as WP to avoid false positive. |
| 233 | + $res->tested = 1 === version_compare( substr( $wp_version, 0, 3 ), $response->tested ) |
| 234 | + ? $response->tested |
| 235 | + : $wp_version; |
| 236 | + |
| 237 | + $res->sections = array( |
| 238 | + 'description' => $response->sections->description, |
| 239 | + 'changelog' => $response->sections->changelog, |
| 240 | + ); |
| 241 | + |
| 242 | + return $res; |
| 243 | + } |
| 244 | +} |
0 commit comments