| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493 |
- <?php
- /**
- * The update helper for WooCommerce.com plugins.
- *
- * @class WC_Helper_Updater
- * @package WooCommerce\Admin\Helper
- */
- if ( ! defined( 'ABSPATH' ) ) {
- exit;
- }
- /**
- * WC_Helper_Updater Class
- *
- * Contains the logic to fetch available updates and hook into Core's update
- * routines to serve WooCommerce.com-provided packages.
- */
- class WC_Helper_Updater {
- /**
- * Loads the class, runs on init.
- */
- public static function load() {
- add_action( 'pre_set_site_transient_update_plugins', array( __CLASS__, 'transient_update_plugins' ), 21, 1 );
- add_action( 'pre_set_site_transient_update_themes', array( __CLASS__, 'transient_update_themes' ), 21, 1 );
- add_action( 'upgrader_process_complete', array( __CLASS__, 'upgrader_process_complete' ) );
- add_action( 'upgrader_pre_download', array( __CLASS__, 'block_expired_updates' ), 10, 2 );
- }
- /**
- * Runs in a cron thread, or in a visitor thread if triggered
- * by _maybe_update_plugins(), or in an auto-update thread.
- *
- * @param object $transient The update_plugins transient object.
- *
- * @return object The same or a modified version of the transient.
- */
- public static function transient_update_plugins( $transient ) {
- $update_data = self::get_update_data();
- foreach ( WC_Helper::get_local_woo_plugins() as $plugin ) {
- if ( empty( $update_data[ $plugin['_product_id'] ] ) ) {
- continue;
- }
- $data = $update_data[ $plugin['_product_id'] ];
- $filename = $plugin['_filename'];
- $item = array(
- 'id' => 'woocommerce-com-' . $plugin['_product_id'],
- 'slug' => 'woocommerce-com-' . $data['slug'],
- 'plugin' => $filename,
- 'new_version' => $data['version'],
- 'url' => $data['url'],
- 'package' => $data['package'],
- 'upgrade_notice' => $data['upgrade_notice'],
- );
- if ( isset( $data['requires_php'] ) ) {
- $item['requires_php'] = $data['requires_php'];
- }
- // We don't want to deliver a valid upgrade package when their subscription has expired.
- // To avoid the generic "no_package" error that empty strings give, we will store an
- // indication of expiration for the `upgrader_pre_download` filter to error on.
- if ( ! self::_has_active_subscription( $plugin['_product_id'] ) ) {
- $item['package'] = 'woocommerce-com-expired-' . $plugin['_product_id'];
- }
- if ( version_compare( $plugin['Version'], $data['version'], '<' ) ) {
- $transient->response[ $filename ] = (object) $item;
- unset( $transient->no_update[ $filename ] );
- } else {
- $transient->no_update[ $filename ] = (object) $item;
- unset( $transient->response[ $filename ] );
- }
- }
- $translations = self::get_translations_update_data();
- $transient->translations = array_merge( isset( $transient->translations ) ? $transient->translations : array(), $translations );
- return $transient;
- }
- /**
- * Runs on pre_set_site_transient_update_themes, provides custom
- * packages for WooCommerce.com-hosted extensions.
- *
- * @param object $transient The update_themes transient object.
- *
- * @return object The same or a modified version of the transient.
- */
- public static function transient_update_themes( $transient ) {
- $update_data = self::get_update_data();
- foreach ( WC_Helper::get_local_woo_themes() as $theme ) {
- if ( empty( $update_data[ $theme['_product_id'] ] ) ) {
- continue;
- }
- $data = $update_data[ $theme['_product_id'] ];
- $slug = $theme['_stylesheet'];
- $item = array(
- 'theme' => $slug,
- 'new_version' => $data['version'],
- 'url' => $data['url'],
- 'package' => '',
- );
- if ( self::_has_active_subscription( $theme['_product_id'] ) ) {
- $item['package'] = $data['package'];
- }
- if ( version_compare( $theme['Version'], $data['version'], '<' ) ) {
- $transient->response[ $slug ] = $item;
- } else {
- unset( $transient->response[ $slug ] );
- $transient->checked[ $slug ] = $data['version'];
- }
- }
- return $transient;
- }
- /**
- * Get update data for all extensions.
- *
- * Scans through all subscriptions for the connected user, as well
- * as all Woo extensions without a subscription, and obtains update
- * data for each product.
- *
- * @return array Update data {product_id => data}
- */
- public static function get_update_data() {
- $payload = array();
- // Scan subscriptions.
- foreach ( WC_Helper::get_subscriptions() as $subscription ) {
- $payload[ $subscription['product_id'] ] = array(
- 'product_id' => $subscription['product_id'],
- 'file_id' => '',
- );
- }
- // Scan local plugins which may or may not have a subscription.
- foreach ( WC_Helper::get_local_woo_plugins() as $data ) {
- if ( ! isset( $payload[ $data['_product_id'] ] ) ) {
- $payload[ $data['_product_id'] ] = array(
- 'product_id' => $data['_product_id'],
- );
- }
- $payload[ $data['_product_id'] ]['file_id'] = $data['_file_id'];
- }
- // Scan local themes.
- foreach ( WC_Helper::get_local_woo_themes() as $data ) {
- if ( ! isset( $payload[ $data['_product_id'] ] ) ) {
- $payload[ $data['_product_id'] ] = array(
- 'product_id' => $data['_product_id'],
- );
- }
- $payload[ $data['_product_id'] ]['file_id'] = $data['_file_id'];
- }
- return self::_update_check( $payload );
- }
- /**
- * Get translations updates informations.
- *
- * Scans through all subscriptions for the connected user, as well
- * as all Woo extensions without a subscription, and obtains update
- * data for each product.
- *
- * @return array Update data {product_id => data}
- */
- public static function get_translations_update_data() {
- $payload = array();
- $installed_translations = wp_get_installed_translations( 'plugins' );
- $locales = array_values( get_available_languages() );
- /**
- * Filters the locales requested for plugin translations.
- *
- * @since 3.7.0
- * @since 4.5.0 The default value of the `$locales` parameter changed to include all locales.
- *
- * @param array $locales Plugin locales. Default is all available locales of the site.
- */
- $locales = apply_filters( 'plugins_update_check_locales', $locales );
- $locales = array_unique( $locales );
- // No locales, the respone will be empty, we can return now.
- if ( empty( $locales ) ) {
- return array();
- }
- // Scan local plugins which may or may not have a subscription.
- $plugins = WC_Helper::get_local_woo_plugins();
- $active_woo_plugins = array_intersect( array_keys( $plugins ), get_option( 'active_plugins', array() ) );
- /*
- * Use only plugins that are subscribed to the automatic translations updates.
- */
- $active_for_translations = array_filter(
- $active_woo_plugins,
- function( $plugin ) use ( $plugins ) {
- return apply_filters( 'woocommerce_translations_updates_for_' . $plugins[ $plugin ]['slug'], false );
- }
- );
- // Nothing to check for, exit.
- if ( empty( $active_for_translations ) ) {
- return array();
- }
- if ( wp_doing_cron() ) {
- $timeout = 30;
- } else {
- // Three seconds, plus one extra second for every 10 plugins.
- $timeout = 3 + (int) ( count( $active_for_translations ) / 10 );
- }
- $request_body = array(
- 'locales' => $locales,
- 'plugins' => array(),
- );
- foreach ( $active_for_translations as $active_plugin ) {
- $plugin = $plugins[ $active_plugin ];
- $request_body['plugins'][ $plugin['slug'] ] = array( 'version' => $plugin['Version'] );
- }
- $raw_response = wp_remote_post(
- 'https://translate.wordpress.com/api/translations-updates/woocommerce',
- array(
- 'body' => json_encode( $request_body ),
- 'headers' => array( 'Content-Type: application/json' ),
- 'timeout' => $timeout,
- )
- );
- // Something wrong happened on the translate server side.
- $response_code = wp_remote_retrieve_response_code( $raw_response );
- if ( 200 !== $response_code ) {
- return array();
- }
- $response = json_decode( wp_remote_retrieve_body( $raw_response ), true );
- // API error, api returned but something was wrong.
- if ( array_key_exists( 'success', $response ) && false === $response['success'] ) {
- return array();
- }
- $translations = array();
- foreach ( $response['data'] as $plugin_name => $language_packs ) {
- foreach ( $language_packs as $language_pack ) {
- // Maybe we have this language pack already installed so lets check revision date.
- if ( array_key_exists( $plugin_name, $installed_translations ) && array_key_exists( $language_pack['wp_locale'], $installed_translations[ $plugin_name ] ) ) {
- $installed_translation_revision_time = new DateTime( $installed_translations[ $plugin_name ][ $language_pack['wp_locale'] ]['PO-Revision-Date'] );
- $new_translation_revision_time = new DateTime( $language_pack['last_modified'] );
- // Skip if translation language pack is not newer than what is installed already.
- if ( $new_translation_revision_time <= $installed_translation_revision_time ) {
- continue;
- }
- }
- $translations[] = array(
- 'type' => 'plugin',
- 'slug' => $plugin_name,
- 'language' => $language_pack['wp_locale'],
- 'version' => $language_pack['version'],
- 'updated' => $language_pack['last_modified'],
- 'package' => $language_pack['package'],
- 'autoupdate' => true,
- );
- }
- }
- return $translations;
- }
- /**
- * Run an update check API call.
- *
- * The call is cached based on the payload (product ids, file ids). If
- * the payload changes, the cache is going to miss.
- *
- * @param array $payload Information about the plugin to update.
- * @return array Update data for each requested product.
- */
- private static function _update_check( $payload ) {
- ksort( $payload );
- $hash = md5( wp_json_encode( $payload ) );
- $cache_key = '_woocommerce_helper_updates';
- $data = get_transient( $cache_key );
- if ( false !== $data ) {
- if ( hash_equals( $hash, $data['hash'] ) ) {
- return $data['products'];
- }
- }
- $data = array(
- 'hash' => $hash,
- 'updated' => time(),
- 'products' => array(),
- 'errors' => array(),
- );
- $request = WC_Helper_API::post(
- 'update-check',
- array(
- 'body' => wp_json_encode( array( 'products' => $payload ) ),
- 'authenticated' => true,
- )
- );
- if ( wp_remote_retrieve_response_code( $request ) !== 200 ) {
- $data['errors'][] = 'http-error';
- } else {
- $data['products'] = json_decode( wp_remote_retrieve_body( $request ), true );
- }
- set_transient( $cache_key, $data, 12 * HOUR_IN_SECONDS );
- return $data['products'];
- }
- /**
- * Check for an active subscription.
- *
- * Checks a given product id against all subscriptions on
- * the current site. Returns true if at least one active
- * subscription is found.
- *
- * @param int $product_id The product id to look for.
- *
- * @return bool True if active subscription found.
- */
- private static function _has_active_subscription( $product_id ) {
- if ( ! isset( $auth ) ) {
- $auth = WC_Helper_Options::get( 'auth' );
- }
- if ( ! isset( $subscriptions ) ) {
- $subscriptions = WC_Helper::get_subscriptions();
- }
- if ( empty( $auth['site_id'] ) || empty( $subscriptions ) ) {
- return false;
- }
- // Check for an active subscription.
- foreach ( $subscriptions as $subscription ) {
- if ( $subscription['product_id'] != $product_id ) {
- continue;
- }
- if ( in_array( absint( $auth['site_id'] ), $subscription['connections'] ) ) {
- return true;
- }
- }
- return false;
- }
- /**
- * Get the number of products that have updates.
- *
- * @return int The number of products with updates.
- */
- public static function get_updates_count() {
- $cache_key = '_woocommerce_helper_updates_count';
- $count = get_transient( $cache_key );
- if ( false !== $count ) {
- return $count;
- }
- // Don't fetch any new data since this function in high-frequency.
- if ( ! get_transient( '_woocommerce_helper_subscriptions' ) ) {
- return 0;
- }
- if ( ! get_transient( '_woocommerce_helper_updates' ) ) {
- return 0;
- }
- $count = 0;
- $update_data = self::get_update_data();
- if ( empty( $update_data ) ) {
- set_transient( $cache_key, $count, 12 * HOUR_IN_SECONDS );
- return $count;
- }
- // Scan local plugins.
- foreach ( WC_Helper::get_local_woo_plugins() as $plugin ) {
- if ( empty( $update_data[ $plugin['_product_id'] ] ) ) {
- continue;
- }
- if ( version_compare( $plugin['Version'], $update_data[ $plugin['_product_id'] ]['version'], '<' ) ) {
- $count++;
- }
- }
- // Scan local themes.
- foreach ( WC_Helper::get_local_woo_themes() as $theme ) {
- if ( empty( $update_data[ $theme['_product_id'] ] ) ) {
- continue;
- }
- if ( version_compare( $theme['Version'], $update_data[ $theme['_product_id'] ]['version'], '<' ) ) {
- $count++;
- }
- }
- set_transient( $cache_key, $count, 12 * HOUR_IN_SECONDS );
- return $count;
- }
- /**
- * Return the updates count markup.
- *
- * @return string Updates count markup, empty string if no updates avairable.
- */
- public static function get_updates_count_html() {
- $count = self::get_updates_count();
- if ( ! $count ) {
- return '';
- }
- $count_html = sprintf( '<span class="update-plugins count-%d"><span class="update-count">%d</span></span>', $count, number_format_i18n( $count ) );
- return $count_html;
- }
- /**
- * Flushes cached update data.
- */
- public static function flush_updates_cache() {
- delete_transient( '_woocommerce_helper_updates' );
- delete_transient( '_woocommerce_helper_updates_count' );
- delete_site_transient( 'update_plugins' );
- delete_site_transient( 'update_themes' );
- }
- /**
- * Fires when a user successfully updated a theme or a plugin.
- */
- public static function upgrader_process_complete() {
- delete_transient( '_woocommerce_helper_updates_count' );
- }
- /**
- * Hooked into the upgrader_pre_download filter in order to better handle error messaging around expired
- * plugin updates. Initially we were using an empty string, but the error message that no_package
- * results in does not fit the cause.
- *
- * @since 4.1.0
- * @param bool $reply Holds the current filtered response.
- * @param string $package The path to the package file for the update.
- * @return false|WP_Error False to proceed with the update as normal, anything else to be returned instead of updating.
- */
- public static function block_expired_updates( $reply, $package ) {
- // Don't override a reply that was set already.
- if ( false !== $reply ) {
- return $reply;
- }
- // Only for packages with expired subscriptions.
- if ( 0 !== strpos( $package, 'woocommerce-com-expired-' ) ) {
- return false;
- }
- return new WP_Error(
- 'woocommerce_subscription_expired',
- sprintf(
- // translators: %s: URL of WooCommerce.com subscriptions tab.
- __( 'Please visit the <a href="%s" target="_blank">subscriptions page</a> and renew to continue receiving updates.', 'woocommerce' ),
- esc_url( admin_url( 'admin.php?page=wc-addons§ion=helper' ) )
- )
- );
- }
- }
- WC_Helper_Updater::load();
|