관리-도구
편집 파일: class-kkart-helper-updater.php
<?php /** * The update helper for Kkart.com plugins. * * @class KKART_Helper_Updater * @package Kkart\Admin\Helper */ if ( ! defined( 'ABSPATH' ) ) { exit; } /** * KKART_Helper_Updater Class * * Contains the logic to fetch available updates and hook into Core's update * routines to serve Kkart.com-provided packages. */ class KKART_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 ( KKART_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' => 'kkart-com-' . $plugin['_product_id'], 'slug' => 'kkart-com-' . $data['slug'], 'plugin' => $filename, 'new_version' => $data['version'], 'url' => $data['url'], 'package' => $data['package'], 'upgrade_notice' => $data['upgrade_notice'], ); // 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'] = 'kkart-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 Kkart.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 ( KKART_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 ( KKART_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 ( KKART_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 ( KKART_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 = KKART_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( 'kkart_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/kkart', 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 = '_kkart_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 = KKART_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 = KKART_Helper_Options::get( 'auth' ); } if ( ! isset( $subscriptions ) ) { $subscriptions = KKART_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 = '_kkart_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( '_kkart_helper_subscriptions' ) ) { return 0; } if ( ! get_transient( '_kkart_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 ( KKART_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 ( KKART_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( '_kkart_helper_updates' ); delete_transient( '_kkart_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( '_kkart_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, 'kkart-com-expired-' ) ) { return false; } return new WP_Error( 'kkart_subscription_expired', sprintf( // translators: %s: URL of Kkart.com subscriptions tab. __( 'Please visit the <a href="%s" target="_blank">subscriptions page</a> and renew to continue receiving updates.', 'kkart' ), esc_url( admin_url( 'admin.php?page=kkart-addons§ion=helper' ) ) ) ); } } KKART_Helper_Updater::load();