Inventory_Presser_Addon_Updater
Allows plugins to use their own update API.
On This Page
Description Description
This class is provided by Easy Digital Downloads and is originally named EDD_SL_Plugin_Updater.
Source Source
File: includes/addon/class-addon-updater.php
class Inventory_Presser_Addon_Updater {
private $api_url = '';
private $api_data = array();
private $beta = false;
private $name = '';
private $slug = '';
private $version = '';
private $wp_override = false;
private $cache_key = '';
private $health_check_timeout = 5;
/**
* Class constructor.
*
* @uses plugin_basename()
* @uses hook()
*
* @param string $_api_url The URL pointing to the custom API endpoint.
* @param string $_plugin_file Path to the plugin file.
* @param array $_api_data Optional data to send with API calls.
*/
public function __construct( $_api_url, $_plugin_file, $_api_data = null ) {
global $edd_plugin_data;
$this->api_url = trailingslashit( $_api_url );
$this->api_data = $_api_data;
$this->name = plugin_basename( $_plugin_file );
$this->slug = basename( $_plugin_file, '.php' );
$this->version = $_api_data['version'];
$this->wp_override = isset( $_api_data['wp_override'] ) ? (bool) $_api_data['wp_override'] : false;
$this->beta = ! empty( $this->api_data['beta'] ) ? true : false;
$this->cache_key = 'edd_sl_' . md5( wp_json_encode( $this->slug . $this->api_data['license'] . $this->beta ) );
$edd_plugin_data[ $this->slug ] = $this->api_data;
/**
* Fires after the $edd_plugin_data is setup.
*
* @since x.x.x
*
* @param array $edd_plugin_data Array of EDD SL plugin data.
*/
do_action( 'post_edd_sl_plugin_updater_setup', $edd_plugin_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() {
add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_update' ) );
add_filter( 'plugins_api', array( $this, 'plugins_api_filter' ), 10, 3 );
// Priority 21 because we want to remove a core hook added at 20.
add_action( 'load-plugins.php', array( $this, 'remove_core_update_row' ), 21 );
add_action( 'after_plugin_row_' . $this->name, array( $this, 'show_update_notification' ), 10, 2 );
add_action( 'admin_init', array( $this, 'show_changelog' ) );
/**
* Changes "Automatic update is unavailable for this plugin." to
* "License key is missing at Vehicles → Options" if the problem is
* a missing license key for one of our add-ons.
*/
add_filter( 'site_transient_update_plugins', array( $this, 'show_missing_license_notice' ), 10, 2 );
}
/**
* Ensures updaters are initialized for all addon plugins in multisite, even if plugins aren't active on the main site.
* This is called via a static hook registered in Inventory_Presser_Addon.
*
* @param object $_transient_data Update array build by WordPress.
* @return object
*/
public static function ensure_addon_updaters_initialized( $_transient_data ) {
if ( ! is_multisite() ) {
return $_transient_data;
}
// Map of plugin slugs to their details
$addon_plugins = array(
'make-list-widget' => array(
'option_name' => 'make_list_widget_settings',
'item_id' => 607,
'class_name' => 'Make_List_Addon',
),
'taxonomy-filters-widget' => array(
'option_name' => 'invp_filters_widget_settings',
'item_id' => 597,
'class_name' => 'Taxonomy_Filters_Addon',
),
'taxonomy-drop-down-search-widget' => array(
'option_name' => 'invp_drop_down_widget_settings',
'item_id' => 599,
'class_name' => 'Dropdown_Search_Addon',
),
);
// Check if updaters are already initialized
global $edd_plugin_data;
if ( ! isset( $edd_plugin_data ) ) {
$edd_plugin_data = array();
}
// Get all installed plugins
$all_plugins = get_plugins();
foreach ( $addon_plugins as $slug => $plugin_info ) {
// Find the plugin file
$plugin_file = null;
foreach ( $all_plugins as $file => $plugin_data ) {
if ( strpos( $file, $slug ) !== false ) {
$plugin_file = $file;
break;
}
}
if ( ! $plugin_file ) {
continue;
}
// Check if updater is already initialized
if ( isset( $edd_plugin_data[ $slug ] ) ) {
continue;
}
// Try to get license key from any site, and remember which site it came from
$license_key = '';
$license_site_url = '';
$sites = get_sites( array( 'number' => 100 ) );
foreach ( $sites as $site ) {
switch_to_blog( $site->blog_id );
$options = get_option( $plugin_info['option_name'] );
if ( ! empty( $options['license_key'] ) ) {
$license_key = $options['license_key'];
// Use the site URL where the license key was found
// This ensures the license validation matches the registered site
$license_site_url = home_url();
restore_current_blog();
break;
}
restore_current_blog();
}
// If we found a license key, initialize the updater
if ( ! empty( $license_key ) && class_exists( 'Inventory_Presser_Addon_Updater' ) ) {
// Get plugin version from file
$plugin_path = WP_PLUGIN_DIR . '/' . $plugin_file;
if ( file_exists( $plugin_path ) ) {
$plugin_data = get_file_data( $plugin_path, array( 'Version' => 'Version' ) );
$version = ! empty( $plugin_data['Version'] ) ? $plugin_data['Version'] : '1.0.0';
// Use the site URL where the license key was found, or fall back to network URL
$site_url = ! empty( $license_site_url ) ? $license_site_url : network_home_url();
$updater = new Inventory_Presser_Addon_Updater(
'https://inventorypresser.com',
$plugin_file,
array(
'version' => $version,
'license' => $license_key,
'item_id' => $plugin_info['item_id'],
'author' => 'Corey Salzano',
'url' => $site_url,
'beta' => false,
)
);
}
}
}
return $_transient_data;
}
/**
* Removes the core "There is a new version of {plugin} available"
* notice on the plugins list. We are adding our own.
*
* @return void
*/
public function remove_core_update_row() {
remove_action( 'after_plugin_row_' . $this->name, 'wp_plugin_update_row', 10 );
}
/**
* 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 Modified update array with custom plugin data.
*/
public function check_update( $_transient_data ) {
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 ] ) && false === $this->wp_override ) {
return $_transient_data;
}
// In multisite, if license key is empty, try to retrieve it before checking for updates.
// This ensures updates work even when plugins aren't active on the main site.
if ( is_multisite() && empty( $this->api_data['license'] ) ) {
$option_name_map = array(
'make-list-widget' => 'make_list_widget_settings',
'taxonomy-filters-widget' => 'invp_filters_widget_settings',
'taxonomy-drop-down-search-widget' => 'invp_drop_down_widget_settings',
);
if ( isset( $option_name_map[ $this->slug ] ) ) {
$option_name = $option_name_map[ $this->slug ];
$current_blog_id = get_current_blog_id();
// Try current site first.
$options = get_option( $option_name );
if ( ! empty( $options['license_key'] ) ) {
$this->api_data['license'] = $options['license_key'];
} else {
// If not found, check all sites in the network.
$sites = get_sites( array( 'number' => 100 ) );
foreach ( $sites as $site ) {
switch_to_blog( $site->blog_id );
$options = get_option( $option_name );
if ( ! empty( $options['license_key'] ) ) {
$this->api_data['license'] = $options['license_key'];
restore_current_blog();
break;
}
restore_current_blog();
}
}
}
}
$current = $this->get_repo_api_data();
if ( false !== $current && is_object( $current ) && isset( $current->new_version ) ) {
if ( version_compare( $this->version, $current->new_version, '<' ) ) {
$_transient_data->response[ $this->name ] = $current;
} else {
// Populating the no_update information is required to support auto-updates in WordPress 5.5.
$_transient_data->no_update[ $this->name ] = $current;
}
}
$_transient_data->last_checked = time();
$_transient_data->checked[ $this->name ] = $this->version;
return $_transient_data;
}
/**
* Get repo API data from store.
* Save to cache.
*
* @return \stdClass
*/
public function get_repo_api_data() {
$version_info = $this->get_cached_version_info();
// If cached version info has empty package URL but we have a license key, clear cache and retry.
// This fixes multisite issues where plugins initialize before site options are available.
if ( false !== $version_info && empty( $version_info->package ) && ! empty( $this->api_data['license'] ) ) {
// Clear the cache and retry.
delete_option( $this->cache_key );
$version_info = false;
}
if ( false === $version_info ) {
// If license key is empty, try to retrieve it dynamically.
// This is a fallback for multisite where site options may not be available during initialization.
if ( empty( $this->api_data['license'] ) ) {
// Try to get license key from global plugin data registry.
global $edd_plugin_data;
if ( ! empty( $edd_plugin_data[ $this->slug ]['license'] ) ) {
$this->api_data['license'] = $edd_plugin_data[ $this->slug ]['license'];
}
// If still empty and we're in multisite, try to get license key from site options.
// Map known plugin slugs to their option names.
if ( empty( $this->api_data['license'] ) && is_multisite() ) {
$option_name_map = array(
'make-list-widget' => 'make_list_widget_settings',
'taxonomy-filters-widget' => 'invp_filters_widget_settings',
'taxonomy-drop-down-search-widget' => 'invp_drop_down_widget_settings',
);
if ( isset( $option_name_map[ $this->slug ] ) ) {
$option_name = $option_name_map[ $this->slug ];
$current_blog_id = get_current_blog_id();
// Try current site first.
$options = get_option( $option_name );
if ( ! empty( $options['license_key'] ) ) {
$this->api_data['license'] = $options['license_key'];
} else {
// If not found, check all sites in the network.
$sites = get_sites( array( 'number' => 100 ) );
foreach ( $sites as $site ) {
switch_to_blog( $site->blog_id );
$options = get_option( $option_name );
if ( ! empty( $options['license_key'] ) ) {
$this->api_data['license'] = $options['license_key'];
restore_current_blog();
break;
}
restore_current_blog();
}
}
// Update global registry if we found a license key.
if ( ! empty( $this->api_data['license'] ) ) {
if ( ! isset( $edd_plugin_data ) ) {
$edd_plugin_data = array();
}
if ( ! isset( $edd_plugin_data[ $this->slug ] ) ) {
$edd_plugin_data[ $this->slug ] = array();
}
$edd_plugin_data[ $this->slug ]['license'] = $this->api_data['license'];
}
}
}
}
$version_info = $this->api_request(
'plugin_latest_version',
array(
'slug' => $this->slug,
'beta' => $this->beta,
)
);
if ( ! $version_info ) {
return false;
}
// This is required for your plugin to support auto-updates in WordPress 5.5.
$version_info->plugin = $this->name;
$version_info->id = $this->name;
$this->set_version_info_cache( $version_info );
}
return $version_info;
}
/**
* Changes "Automatic update is unavailable for this plugin." to
* "License key is missing at Vehicles → Options" if the problem is
* a missing license key for one of our add-ons.
*
* Does nothing for the WordPress Updates page. The message this method
* helps change appears only on the Plugins page.
*
* @param object $value
* @param mixed $transient
* @return object
*/
public function show_missing_license_notice( $value, $transient ) {
// Store a list of strings to avoid outputting JavaScript for the same plugin more than once.
static $handled_plugin_slugs = array();
if ( empty( $value->response ) ) {
return $value;
}
// Is there a response from inventorypresser.com in this transient?
foreach ( $value->response as $plugin_path => $update_response ) {
if ( ! is_object( $update_response ) || empty( $update_response->slug ) ) {
continue;
}
if ( strlen( $update_response->url ) < strlen( Inventory_Presser_Addon_License::STORE_URL )
|| Inventory_Presser_Addon_License::STORE_URL != substr( $update_response->url, 0, strlen( Inventory_Presser_Addon_License::STORE_URL ) )
) {
continue;
}
// This is a plugin from inventorypresser.com.
// Is the problem a missing license key?
if ( ! empty( $update_response->msg )
&& 'No license key has been provided.' === $update_response->msg
&& ! in_array( $update_response->slug, $handled_plugin_slugs, true )
&& ( ! is_multisite() || is_blog_admin() )
) {
/**
* Yes, output JavaScript that will change
* "Automatic update is unavailable for this plugin." to
* "License key is missing at Vehicles → Options"
*/
add_action(
'admin_print_footer_scripts',
function () use ( $update_response ) {
?><script type="text/javascript"><!--
jQuery(document).ready(function(){
jQuery('#<?php echo esc_js( $update_response->slug ); ?>-update .update-message p em').html( 'License key is missing at Vehicles → Options');
});
--></script>
<?php
}
);
$handled_plugin_slugs[] = $update_response->slug;
}
}
return $value;
}
/**
* 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 this is a multi-site install, only show the update on the
* network plugins page.
*/
if ( is_multisite() && ! is_network_admin() ) {
return;
}
if ( ! current_user_can( 'update_plugins' ) ) {
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 ] ) ) {
$version_info = $this->get_repo_api_data();
if ( false === $version_info ) {
$version_info = $this->api_request(
'plugin_latest_version',
array(
'slug' => $this->slug,
'beta' => $this->beta,
)
);
// Since we disabled our filter for the transient, we aren't running our object conversion on banners, sections, or icons. Do this now:
if ( isset( $version_info->banners ) && ! is_array( $version_info->banners ) ) {
$version_info->banners = $this->convert_object_to_array( $version_info->banners );
}
if ( isset( $version_info->sections ) && ! is_array( $version_info->sections ) ) {
$version_info->sections = $this->convert_object_to_array( $version_info->sections );
}
if ( isset( $version_info->icons ) && ! is_array( $version_info->icons ) ) {
$version_info->icons = $this->convert_object_to_array( $version_info->icons );
}
if ( isset( $version_info->contributors ) && ! is_array( $version_info->contributors ) ) {
$version_info->contributors = $this->convert_object_to_array( $version_info->contributors );
}
$this->set_version_info_cache( $version_info );
}
if ( ! is_object( $version_info ) ) {
return;
}
if ( version_compare( $this->version, $version_info->new_version, '<' ) ) {
$update_cache->response[ $this->name ] = $version_info;
} else {
$update_cache->no_update[ $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.
printf(
'<tr class="plugin-update-tr" id="%1$s-update" data-slug="%1$s" data-plugin="%2$s">'
. '<td colspan="4" class="plugin-update colspanchange">'
. '<div class="update-message notice inline notice-warning notice-alt"><p>',
esc_attr( $this->slug ),
esc_attr( $file )
);
$changelog_link = self_admin_url(
add_query_arg(
array(
'edd_sl_action' => 'view_plugin_changelog',
'plugin' => $this->name,
'slug' => $this->slug,
'TB_iframe' => 'true',
'width' => '772',
'height' => '911',
),
'index.php'
)
);
printf(
'%s %s %s <a href="%s" class="thickbox open-plugin-details-modal" aria-label="%s %s %s %s %s">%s %s %s</a>',
esc_html__( 'There is a new version of', 'inventory-presser' ),
esc_html( $version_info->name ),
esc_html__( 'available.', 'inventory-presser' ),
esc_url( $changelog_link ),
esc_html__( 'View', 'inventory-presser' ),
esc_html( $version_info->name ),
esc_html__( 'version', 'inventory-presser' ),
esc_html( $version_info->new_version ),
esc_html__( 'details', 'inventory-presser' ),
esc_html__( ' View version', 'inventory-presser' ),
esc_html( $version_info->new_version ),
esc_html__( 'details', 'inventory-presser' )
);
// Do we have a license key? Include "update now" link if so.
if ( ! empty( $this->api_data['license'] ) ) {
$update_url = wp_nonce_url(
self_admin_url( add_query_arg( 'action', 'upgrade-plugin', add_query_arg( 'plugin', $this->name, 'update.php' ) ) ),
'upgrade-plugin_' . $this->name
);
printf(
' %s <a href="%s" class="update-link" aria-label="%s %s %s">%s</a>.',
esc_html__( 'or', 'inventory-presser' ),
esc_url( $update_url ),
esc_attr__( 'Update', 'inventory-presser' ),
esc_html( $version_info->name ),
esc_attr__( 'now', 'inventory-presser' ),
esc_html__( 'update now', 'inventory-presser' )
);
} else {
echo '.';
}
do_action( "in_plugin_update_message-{$file}", $plugin, $version_info );
echo ' <em></em></p></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 ( 'plugin_information' !== $_action ) {
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' => array(),
'reviews' => false,
'icons' => array(),
),
);
// Get the transient where we store the api request for this plugin for 24 hours.
$edd_api_request_transient = $this->get_cached_version_info();
// If we have no transient-saved value, run the API, set a fresh transient with the API value, and return that value too right now.
if ( empty( $edd_api_request_transient ) ) {
$api_response = $this->api_request( 'plugin_information', $to_send );
// Expires in 3 hours.
$this->set_version_info_cache( $api_response );
if ( false !== $api_response ) {
$_data = $api_response;
}
} else {
$_data = $edd_api_request_transient;
}
// Convert sections into an associative array, since we're getting an object, but Core expects an array.
if ( isset( $_data->sections ) && ! is_array( $_data->sections ) ) {
$_data->sections = $this->convert_object_to_array( $_data->sections );
}
// Convert banners into an associative array, since we're getting an object, but Core expects an array.
if ( isset( $_data->banners ) && ! is_array( $_data->banners ) ) {
$_data->banners = $this->convert_object_to_array( $_data->banners );
}
// Convert icons into an associative array, since we're getting an object, but Core expects an array.
if ( isset( $_data->icons ) && ! is_array( $_data->icons ) ) {
$_data->icons = $this->convert_object_to_array( $_data->icons );
}
// Convert contributors into an associative array, since we're getting an object, but Core expects an array.
if ( isset( $_data->contributors ) && ! is_array( $_data->contributors ) ) {
$_data->contributors = $this->convert_object_to_array( $_data->contributors );
}
if ( ! isset( $_data->plugin ) ) {
$_data->plugin = $this->name;
}
return $_data;
}
/**
* Convert some objects to arrays when injecting data into the update API
*
* Some data like sections, banners, and icons are expected to be an associative array, however due to the JSON
* decoding, they are objects. This method allows us to pass in the object and return an associative array.
*
* @since 3.6.5
*
* @param stdClass $data
*
* @return array
*/
private function convert_object_to_array( $data ) {
$new_data = array();
foreach ( $data as $key => $value ) {
$new_data[ $key ] = is_object( $value ) ? $this->convert_object_to_array( $value ) : $value;
}
return $new_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 ) {
$verify_ssl = $this->verify_ssl();
if ( strpos( $url ?? '', 'https://' ) !== false && strpos( $url ?? '', 'edd_action=package_download' ) ) {
$args['sslverify'] = $verify_ssl;
}
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, $edd_plugin_url_available;
$verify_ssl = $this->verify_ssl();
// Do a quick status check on this domain if we haven't already checked it.
$store_hash = md5( $this->api_url );
if ( ! is_array( $edd_plugin_url_available ) || ! isset( $edd_plugin_url_available[ $store_hash ] ) ) {
$test_url_parts = wp_parse_url( $this->api_url );
$scheme = ! empty( $test_url_parts['scheme'] ) ? $test_url_parts['scheme'] : 'http';
$host = ! empty( $test_url_parts['host'] ) ? $test_url_parts['host'] : '';
$port = ! empty( $test_url_parts['port'] ) ? ':' . $test_url_parts['port'] : '';
if ( empty( $host ) ) {
$edd_plugin_url_available[ $store_hash ] = false;
} else {
$test_url = $scheme . '://' . $host . $port;
$response = wp_remote_get(
$test_url,
array(
'timeout' => $this->health_check_timeout,
'sslverify' => $verify_ssl,
)
);
$edd_plugin_url_available[ $store_hash ] = is_wp_error( $response ) ? false : true;
}
}
if ( false === $edd_plugin_url_available[ $store_hash ] ) {
return false;
}
$data = array_merge( $this->api_data, $_data );
if ( $data['slug'] !== $this->slug ) {
return false;
}
if ( $this->api_url === trailingslashit( home_url() ) ) {
return false; // Don't allow a plugin to ping itself.
}
// Use the URL from api_data if set (this is the site URL where the license key was found)
// Otherwise fall back to home_url() for backward compatibility
$request_url = ! empty( $data['url'] ) ? $data['url'] : home_url();
$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,
'version' => isset( $data['version'] ) ? $data['version'] : false,
'slug' => $data['slug'],
'author' => $data['author'],
'url' => $request_url,
'beta' => ! empty( $data['beta'] ),
);
$request = wp_remote_post(
$this->api_url,
array(
'timeout' => 15,
'sslverify' => $verify_ssl,
'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;
}
if ( $request && isset( $request->banners ) ) {
$request->banners = maybe_unserialize( $request->banners );
}
if ( $request && isset( $request->icons ) ) {
$request->icons = maybe_unserialize( $request->icons );
}
if ( ! empty( $request->sections ) ) {
foreach ( $request->sections as $key => $section ) {
$request->$key = (array) $section;
}
}
return $request;
}
/**
* If available, show the changelog for sites in a multisite install.
*/
public function show_changelog() {
global $edd_plugin_data;
if ( empty( $_REQUEST['edd_sl_action'] ) || 'view_plugin_changelog' !== sanitize_text_field( wp_unslash( $_REQUEST['edd_sl_action'] ) ) ) {
return;
}
if ( empty( $_REQUEST['plugin'] ) ) {
return;
}
if ( empty( $_REQUEST['slug'] ) ) {
return;
}
if ( ! current_user_can( 'update_plugins' ) ) {
wp_die( esc_html__( 'You do not have permission to install plugin updates', 'inventory-presser' ), esc_html__( 'Error', 'inventory-presser' ), array( 'response' => 403 ) );
}
$slug = sanitize_text_field( wp_unslash( $_REQUEST['slug'] ) );
$data = isset( $edd_plugin_data[ $slug ] ) ? $edd_plugin_data[ $slug ] : null;
if ( empty( $data ) ) {
return;
}
$version_info = $this->get_cached_version_info();
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' => $slug,
'author' => $data['author'],
'url' => home_url(),
'beta' => ! empty( $data['beta'] ),
);
$verify_ssl = $this->verify_ssl();
$request = wp_remote_post(
$this->api_url,
array(
'timeout' => 15,
'sslverify' => $verify_ssl,
'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;
}
if ( ! empty( $version_info ) ) {
foreach ( $version_info->sections as $key => $section ) {
$version_info->$key = (array) $section;
}
}
$this->set_version_info_cache( $version_info );
// Delete the unneeded option.
$plugin = sanitize_text_field( wp_unslash( $_REQUEST['plugin'] ) );
delete_option( md5( 'edd_plugin_' . sanitize_key( $plugin ) . '_' . $this->beta . '_version_info' ) );
}
if ( isset( $version_info->sections ) ) {
$sections = $this->convert_object_to_array( $version_info->sections );
if ( ! empty( $sections['changelog'] ) ) {
echo '<div style="background:#fff;padding:10px;">' . wp_kses_post( $sections['changelog'] ) . '</div>';
}
}
exit;
}
/**
* Gets the plugin's cached version information from the database.
*
* @param string $cache_key
* @return boolean|string
*/
public function get_cached_version_info( $cache_key = '' ) {
if ( empty( $cache_key ) ) {
$cache_key = $this->cache_key;
}
$cache = get_option( $cache_key );
if ( empty( $cache['timeout'] ) || time() > $cache['timeout'] ) {
return false; // Cache is expired.
}
// We need to turn the icons into an array, thanks to WP Core forcing these into an object at some point.
$cache['value'] = json_decode( $cache['value'] );
if ( ! empty( $cache['value']->icons ) ) {
$cache['value']->icons = (array) $cache['value']->icons;
}
return $cache['value'];
}
/**
* Adds the plugin version information to the database.
*
* @param string $value
* @param string $cache_key
*/
public function set_version_info_cache( $value = '', $cache_key = '' ) {
if ( empty( $cache_key ) ) {
$cache_key = $this->cache_key;
}
$data = array(
'timeout' => strtotime( '+3 hours', time() ),
'value' => wp_json_encode( $value ),
);
update_option( $cache_key, $data, false );
}
/**
* Returns if the SSL of the store should be verified.
*
* @since 1.6.13
* @return bool
*/
private function verify_ssl() {
return (bool) apply_filters( 'edd_sl_api_request_verify_ssl', true, $this );
}
}
Expand full source codeCollapse full source codeView on Github
Methods Methods
- __construct — Class constructor.
- api_request — Calls the API and, if successfull, returns the object delivered by the API.
- check_update — Check for Updates at the defined API endpoint and modify the update array.
- convert_object_to_array — Convert some objects to arrays when injecting data into the update API
- ensure_addon_updaters_initialized — Ensures updaters are initialized for all addon plugins in multisite, even if plugins aren’t active on the main site.
- get_cached_version_info — Gets the plugin’s cached version information from the database.
- get_repo_api_data — Get repo API data from store.
- http_request_args — Disable SSL verification in order to prevent download update failures
- init — Set up WordPress filters to hook into WP’s update process.
- plugins_api_filter — Updates information on the “View version x.x details” page with custom data.
- remove_core_update_row — Removes the core “There is a new version of {plugin} available” notice on the plugins list. We are adding our own.
- set_version_info_cache — Adds the plugin version information to the database.
- show_changelog — If available, show the changelog for sites in a multisite install.
- show_missing_license_notice — Changes “Automatic update is unavailable for this plugin.” to “License key is missing at Vehicles → Options” if the problem is a missing license key for one of our add-ons.
- show_update_notification — show update nofication row — needed for multisite subsites, because WP won’t tell you otherwise!
- verify_ssl — Returns if the SSL of the store should be verified.