AnsPress_Prod_Updater()
Description #
Allows plugins to use their own update API.
Source #
File: admin/updater.php
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 | class AnsPress_Prod_Updater { private $api_url = ''; private $api_data = array(); private $name = ''; private $slug = ''; private $version = ''; private $response_key = ''; private $license = ''; private $strings = ''; private $update_checked = false; private $is_plugin = true; /** * Class constructor. * * @uses plugin_basename() * @uses hook() * * @param string $_plugin_file Path to the plugin file. * @param array|null $_api_data Optional data to send with API calls. * @param boolean $is_plugin Is plugin. */ public function __construct( $_plugin_file, $_api_data = null, $is_plugin = true ) { global $edd_plugin_data; $this->is_plugin = $is_plugin; $this->api_data = $_api_data; $this->name = plugin_basename( $_plugin_file ); $this->slug = isset( $this->api_data['slug'] ) ? $this->api_data['slug'] : basename( $_plugin_file, '.php' ); $this->version = $_api_data['version']; $this->response_key = $this->slug . '-update-response'; $edd_plugin_data[ $this->slug ] = $this->api_data; // Set up hooks. $this->init(); } /** * Set up WordPress filters to hook into WP's update process. * * @uses add_filter() * * @return void */ public function init() { if ( $this->is_plugin ) { add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_update' ) ); add_filter( 'plugins_api', array( $this, 'plugins_api_filter' ), 10, 3 ); remove_action( 'after_plugin_row_' . $this->name, 'wp_plugin_update_row', 10, 2 ); add_action( 'after_plugin_row_' . $this->name, array( $this, 'show_update_notification' ), 10, 2 ); add_action( 'admin_init', array( $this, 'show_changelog' ) ); } else { $this->strings = array( 'theme-license' => __( 'Theme License', 'edd-theme-updater' ), 'enter-key' => __( 'Enter your theme license key.', 'edd-theme-updater' ), 'license-key' => __( 'License Key', 'edd-theme-updater' ), 'license-action' => __( 'License Action', 'edd-theme-updater' ), 'deactivate-license' => __( 'Deactivate License', 'edd-theme-updater' ), 'activate-license' => __( 'Activate License', 'edd-theme-updater' ), 'status-unknown' => __( 'License status is unknown.', 'edd-theme-updater' ), 'renew' => __( 'Renew?', 'edd-theme-updater' ), 'unlimited' => __( 'unlimited', 'edd-theme-updater' ), 'license-key-is-active' => __( 'License key is active.', 'edd-theme-updater' ), 'expires%s' => __( 'Expires %s.', 'edd-theme-updater' ), '%1$s/%2$-sites' => __( 'You have %1$s / %2$s sites activated.', 'edd-theme-updater' ), 'license-key-expired-%s' => __( 'License key expired %s.', 'edd-theme-updater' ), 'license-key-expired' => __( 'License key has expired.', 'edd-theme-updater' ), 'license-keys-do-not-match' => __( 'License keys do not match.', 'edd-theme-updater' ), 'license-is-inactive' => __( 'License is inactive.', 'edd-theme-updater' ), 'license-key-is-disabled' => __( 'License key is disabled.', 'edd-theme-updater' ), 'site-is-inactive' => __( 'Site is inactive.', 'edd-theme-updater' ), 'license-status-unknown' => __( 'License status is unknown.', 'edd-theme-updater' ), 'update-notice' => __( "Updating this theme will lose any customizations you have made. 'Cancel' to stop, 'OK' to update.", 'edd-theme-updater' ), 'update-available' => __( '<strong>%1$s %2$s</strong> is available. <a href="%3$s" class="thickbox" title="%4s">Check out what\'s new</a> or <a href="%5$s"%6$s>update now</a>.', 'edd-theme-updater' ), ); add_filter( 'site_transient_update_themes', [ $this, 'theme_update_transient' ] ); add_filter( 'delete_site_transient_update_themes', [ $this, 'delete_theme_update_transient' ] ); add_action( 'load-update-core.php', [ $this, 'delete_theme_update_transient' ] ); add_action( 'load-themes.php', [ $this, 'delete_theme_update_transient' ] ); add_action( 'load-themes.php', [ $this, 'load_themes_screen' ] ); } } /** * Check for Updates at the defined API endpoint and modify the update array. * * This function dives into the update API just when WordPress creates its update array, * then adds a custom API call and injects the custom plugin data retrieved from the API. * It is reassembled from parts of the native WordPress plugin update code. * See wp-includes/update.php line 121 for the original wp_update_plugins() function. * * @uses api_request() * * @param array $_transient_data Update array build by WordPress. * @return array|object Modified update array with custom plugin data. */ function check_update( $_transient_data ) { if ( $this->update_checked ) { return $_transient_data; } $this->update_checked = true; global $pagenow; if ( ! is_object( $_transient_data ) ) { $_transient_data = new stdClass(); } if ( 'plugins.php' == $pagenow && is_multisite() ) { return $_transient_data; } if ( empty( $_transient_data->response ) || empty( $_transient_data->response[ $this->name ] ) ) { $version_info = $this->api_request( 'plugin_latest_version', array( 'slug' => $this->slug ) ); if ( false !== $version_info && is_object( $version_info ) && isset( $version_info->new_version ) ) { if ( version_compare( $this->version, $version_info->new_version, '<' ) ) { $_transient_data->response[ $this->name ] = $version_info; } $_transient_data->last_checked = time(); $_transient_data->checked[ $this->name ] = $this->version; } } return $_transient_data; } /** * show update nofication row -- needed for multisite subsites, because WP won't tell you otherwise! * * @param string $file * @param array $plugin */ public function show_update_notification( $file, $plugin ) { if ( ! current_user_can( 'update_plugins' ) ) { return; } if ( ! is_multisite() ) { return; } if ( $this->name != $file ) { return; } // Remove our filter on the site transient. remove_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_update' ), 10 ); $update_cache = get_site_transient( 'update_plugins' ); $update_cache = is_object( $update_cache ) ? $update_cache : new stdClass(); if ( empty( $update_cache->response ) || empty( $update_cache->response[ $this->name ] ) ) { $cache_key = md5( 'edd_plugin_' . sanitize_key( $this->name ) . '_version_info' ); $version_info = get_transient( $cache_key ); if ( false === $version_info ) { $version_info = $this->api_request( 'plugin_latest_version', array( 'slug' => $this->slug ) ); set_transient( $cache_key, $version_info, 3600 ); } if ( ! is_object( $version_info ) ) { return; } if ( version_compare( $this->version, $version_info->new_version, '<' ) ) { $update_cache->response[ $this->name ] = $version_info; } $update_cache->last_checked = time(); $update_cache->checked[ $this->name ] = $this->version; set_site_transient( 'update_plugins', $update_cache ); } else { $version_info = $update_cache->response[ $this->name ]; } // Restore our filter. add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_update' ) ); if ( ! empty( $update_cache->response[ $this->name ] ) && version_compare( $this->version, $version_info->new_version, '<' ) ) { // Build a plugin list row, with update notification. $wp_list_table = _get_list_table( 'WP_Plugins_List_Table' ); echo '<tr class="plugin-update-tr"><td colspan="' . $wp_list_table->get_column_count() . '" class="plugin-update colspanchange"><div class="update-message">'; $changelog_link = self_admin_url( 'index.php?edd_sl_action=view_plugin_changelog&plugin=' . $this->name . '&slug=' . $this->slug . '&TB_iframe=true&width=772&height=911' ); if ( empty( $version_info->download_link ) ) { printf( __( 'There is a new version of %1$s available. <a target="_blank" class="thickbox" href="%2$s">View version %3$s details</a>.', 'easy-digital-downloads' ), esc_html( $version_info->name ), esc_url( $changelog_link ), esc_html( $version_info->new_version ) ); } else { printf( __( 'There is a new version of %1$s available. <a target="_blank" class="thickbox" href="%2$s">View version %3$s details</a> or <a href="%4$s">update now</a>.', 'easy-digital-downloads' ), esc_html( $version_info->name ), esc_url( $changelog_link ), esc_html( $version_info->new_version ), esc_url( wp_nonce_url( self_admin_url( 'update.php?action=upgrade-plugin&plugin=' ) . $this->name, 'upgrade-plugin_' . $this->name ) ) ); } do_action( "in_plugin_update_message-{$file}", $plugin, $version_info ); echo '</div></td></tr>'; } } /** * Updates information on the "View version x.x details" page with custom data. * * @uses api_request() * * @param mixed $_data * @param string $_action * @param object $_args * @return object $_data */ public function plugins_api_filter( $_data, $_action = '', $_args = null ) { if ( $_action != 'plugin_information' ) { return $_data; } if ( ! isset( $_args->slug ) || ( $_args->slug != $this->slug ) ) { return $_data; } $to_send = array( 'slug' => $this->slug, 'is_ssl' => is_ssl(), 'fields' => array( 'banners' => false, // These will be supported soon hopefully 'reviews' => false, ), ); $api_response = $this->api_request( 'plugin_information', $to_send ); if ( false !== $api_response ) { $_data = $api_response; } return $_data; } /** * Disable SSL verification in order to prevent download update failures * * @param array $args * @param string $url * @return object $array */ public function http_request_args( $args, $url ) { // If it is an https request and we are performing a package download, disable ssl verification $args['sslverify'] = false; } return $args; } /** * Calls the API and, if successfull, returns the object delivered by the API. * * @uses get_bloginfo() * @uses wp_remote_post() * @uses is_wp_error() * * @param string $_action The requested action. * @param array $_data Parameters for the API action. * @return false|object */ private function api_request( $_action, $_data ) { global $wp_version; $data = array_merge( $this->api_data, $_data ); if ( $data['slug'] != $this->slug ) { return; } if ( $this->api_url == home_url() ) { return false; // Don't allow a plugin to ping itself } $api_params = array( 'edd_action' => 'get_version', 'license' => ! empty( $data['license'] ) ? $data['license'] : '', 'item_name' => isset( $data['item_name'] ) ? $data['item_name'] : false, 'item_id' => isset( $data['item_id'] ) ? $data['item_id'] : false, 'slug' => $data['slug'], 'author' => $data['author'], 'url' => home_url(), 'anspress_ver' => AP_VERSION, ); $request = wp_remote_post( $this->api_url, array( 'timeout' => 15, 'sslverify' => false, 'body' => $api_params, ) ); if ( ! is_wp_error( $request ) ) { $request = json_decode( wp_remote_retrieve_body( $request ) ); } if ( $request && isset( $request->sections ) ) { $request->sections = maybe_unserialize( $request->sections ); } else { $request = false; } return $request; } public function show_changelog() { global $edd_plugin_data; if ( empty( $_REQUEST['edd_sl_action'] ) || 'view_plugin_changelog' != $_REQUEST['edd_sl_action'] ) { return; } if ( empty( $_REQUEST['plugin'] ) ) { return; } if ( empty( $_REQUEST['slug'] ) ) { return; } if ( ! current_user_can( 'update_plugins' ) ) { wp_die( __( 'You do not have permission to install plugin updates', 'easy-digital-downloads' ), __( 'Error', 'easy-digital-downloads' ), array( 'response' => 403 ) ); } $data = $edd_plugin_data[ $_REQUEST['slug'] ]; $cache_key = md5( 'edd_plugin_' . sanitize_key( $_REQUEST['plugin'] ) . '_version_info' ); $version_info = get_transient( $cache_key ); if ( false === $version_info ) { $api_params = array( 'edd_action' => 'get_version', 'item_name' => isset( $data['item_name'] ) ? $data['item_name'] : false, 'item_id' => isset( $data['item_id'] ) ? $data['item_id'] : false, 'slug' => $_REQUEST['slug'], 'author' => $data['author'], 'url' => home_url(), ); $request = wp_remote_post( $this->api_url, array( 'timeout' => 15, 'sslverify' => false, 'body' => $api_params, ) ); if ( ! is_wp_error( $request ) ) { $version_info = json_decode( wp_remote_retrieve_body( $request ) ); } if ( ! empty( $version_info ) && isset( $version_info->sections ) ) { $version_info->sections = maybe_unserialize( $version_info->sections ); } else { $version_info = false; } set_transient( $cache_key, $version_info, 3600 ); } if ( ! empty( $version_info ) && isset( $version_info->sections['changelog'] ) ) { echo '<div style="background:#fff;padding:10px;">' . $version_info->sections['changelog'] . '</div>'; } wp_die(); } public function theme_update_transient( $value ) { $update_data = $this->check_theme_update(); if ( $update_data ) { $value->response[ $this->slug ] = $update_data; } return $value; } public function delete_theme_update_transient() { delete_transient( $this->response_key ); } function load_themes_screen() { add_thickbox(); add_action( 'admin_notices', [ $this, 'update_nag' ] ); } function update_nag() { $strings = $this->strings; $theme = wp_get_theme( $this->slug ); $api_response = get_transient( $this->response_key ); if ( false === $api_response ) { return; } $update_url = wp_nonce_url( 'update.php?action=upgrade-theme&theme=' . urlencode( $this->slug ), 'upgrade-theme_' . $this->slug ); $update_onclick = ' onclick="if ( confirm(\'' . esc_js( $strings['update-notice'] ) . '\') ) {return true;}return false;"'; if ( version_compare( $this->version, $api_response->new_version, '<' ) ) { echo '<div id="update-nag">'; printf( $strings['update-available'], $theme->get( 'Name' ), $api_response->new_version, '#TB_inline?width=640&inlineId=' . $this->slug . '_changelog', $theme->get( 'Name' ), $update_url, $update_onclick ); echo '</div>'; echo '<div id="' . $this->slug . '_' . 'changelog" style="display:none;">'; echo wpautop( $api_response->sections['changelog'] ); echo '</div>'; } } function check_theme_update() { $update_data = get_transient( $this->response_key ); if ( false === $update_data ) { $failed = false; $api_params = array( 'edd_action' => 'get_version', 'license' => $this->api_data['license'], 'name' => $this->api_data['item_name'], 'slug' => $this->slug, 'author' => $this->api_data['author'], 'anspress_ver' => AP_VERSION, ); $response = wp_remote_post( $this->api_url, [ 'timeout' => 15, 'body' => $api_params, ] ); // Make sure the response was successful. if ( is_wp_error( $response ) || 200 != wp_remote_retrieve_response_code( $response ) ) { $failed = true; } $update_data = json_decode( wp_remote_retrieve_body( $response ) ); if ( ! is_object( $update_data ) ) { $failed = true; } // If the response failed, try again in 30 minutes if ( $failed ) { $data = new stdClass(); $data->new_version = $this->version; set_transient( $this->response_key, $data, strtotime( '+30 minutes' ) ); return false; } // If the status is 'ok', return the update arguments if ( ! $failed ) { $update_data->sections = maybe_unserialize( $update_data->sections ); set_transient( $this->response_key, $update_data, strtotime( '+12 hours' ) ); } } if ( version_compare( $this->version, $update_data->new_version, '>=' ) ) { return false; } return (array) $update_data; }} |
Expand full source code Collapse full source code View on GitHub: admin/updater.php:24
Add your comment
