Astra_Theme_Background_Updater
Description
Source
File: inc/theme-update/class-astra-theme-background-updater.php
class Astra_Theme_Background_Updater { /** * Background update class. * * @var object */ private static $background_updater; /** * DB updates and callbacks that need to be run per version. * * @var array */ private static $db_updates = array( '2.1.3' => array( 'astra_submenu_below_header', ), '2.2.0' => array( 'astra_page_builder_button_color_compatibility', 'astra_vertical_horizontal_padding_migration', ), '2.3.0' => array( 'astra_header_button_new_options', ), '2.3.3' => array( 'astra_elementor_default_color_typo_comp', ), '2.3.4' => array( 'astra_breadcrumb_separator_fix', ), '2.4.0' => array( 'astra_responsive_base_background_option', 'astra_update_theme_tablet_breakpoint', ), '2.4.4' => array( 'astra_gtn_full_wide_image_group_css', ), '2.5.0' => array( 'astra_global_button_woo_css', 'astra_gtn_full_wide_group_cover_css', ), '2.5.2' => array( 'astra_footer_widget_bg', ), '2.6.0' => array( 'astra_bg_control_migration', 'astra_bg_responsive_control_migration', 'astra_gutenberg_core_blocks_design_compatibility', ), '2.6.1' => array( 'astra_gutenberg_media_text_block_css_compatibility', ), '3.0.0' => array( 'astra_header_builder_compatibility', ), '3.0.1' => array( 'astra_clear_assets_cache', ), '3.3.0' => array( 'astra_gutenberg_pattern_compatibility', 'astra_icons_svg_compatibility', 'astra_check_flex_based_css', ), '3.4.0' => array( 'astra_update_cart_style', ), '3.5.0' => array( 'astra_update_related_posts_grid_layout', 'astra_site_title_tagline_responsive_control_migration', ), '3.6.0' => array( 'astra_headings_font_support', 'astra_remove_logo_max_width', 'astra_transparent_header_default_value', ), '3.6.3' => array( 'astra_button_default_values_updated', ), '3.6.4' => array( 'astra_update_underline_link_setting', ), '3.6.5' => array( 'astra_support_block_editor', ), '3.6.7' => array( 'astra_fix_footer_widget_right_margin_case', 'astra_remove_elementor_toc_margin', ), '3.6.8' => array( 'astra_set_removal_widget_design_options_flag', ), '3.6.9' => array( 'astra_zero_font_size_comp', 'astra_unset_builder_elements_underline', 'astra_remove_responsive_account_menu_colors_support', ), '3.7.0' => array( 'astra_global_color_compatibility', ), ); /** * Constructor */ public function __construct() { // Theme Updates. if ( is_admin() ) { add_action( 'admin_init', array( $this, 'install_actions' ) ); } else { add_action( 'wp', array( $this, 'install_actions' ) ); } // Core Helpers - Batch Processing. require_once ASTRA_THEME_DIR . 'inc/lib/batch-processing/class-astra-wp-async-request.php';// phpcs:ignore: WPThemeReview.CoreFunctionality.FileInclude.FileIncludeFound require_once ASTRA_THEME_DIR . 'inc/lib/batch-processing/class-astra-wp-background-process.php';// phpcs:ignore: WPThemeReview.CoreFunctionality.FileInclude.FileIncludeFound require_once ASTRA_THEME_DIR . 'inc/theme-update/class-astra-theme-wp-background-process.php';// phpcs:ignore: WPThemeReview.CoreFunctionality.FileInclude.FileIncludeFound self::$background_updater = new Astra_Theme_WP_Background_Process(); } /** * Check Cron Status * * Gets the current cron status by performing a test spawn. Cached for one hour when all is well. * * @since 2.3.0 * * @return bool true if there is a problem spawning a call to WP-Cron system, else false. */ public function test_cron() { global $wp_version; if ( defined( 'DISABLE_WP_CRON' ) && DISABLE_WP_CRON ) { return true; } if ( defined( 'ALTERNATE_WP_CRON' ) && ALTERNATE_WP_CRON ) { return true; } $cached_status = get_transient( 'astra-theme-cron-test-ok' ); if ( $cached_status ) { return false; } $sslverify = version_compare( $wp_version, 4.0, '<' ); $doing_wp_cron = sprintf( '%.22F', microtime( true ) ); $cron_request = apply_filters( 'cron_request', array( 'url' => site_url( 'wp-cron.php?doing_wp_cron=' . $doing_wp_cron ), 'args' => array( 'timeout' => 3, 'blocking' => true, 'sslverify' => apply_filters( 'https_local_ssl_verify', $sslverify ), ), ) ); $result = wp_remote_post( $cron_request['url'], $cron_request['args'] ); if ( wp_remote_retrieve_response_code( $result ) >= 300 ) { return true; } else { set_transient( 'astra-theme-cron-test-ok', 1, 3600 ); return false; } return $migration_fallback; } /** * Install actions when a update button is clicked within the admin area. * * This function is hooked into admin_init to affect admin and wp to affect the frontend. */ public function install_actions() { do_action( 'astra_update_initiated', self::$background_updater ); if ( true === $this->is_new_install() ) { self::update_db_version(); return; } $fallback = $this->test_cron(); $db_migrated = $this->check_if_data_migrated(); /** @psalm-suppress InvalidArgument */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort $is_queue_running = astra_get_option( 'is_theme_queue_running', false ); $fallback = ( $db_migrated ) ? $db_migrated : $fallback; if ( $this->needs_db_update() && ! $is_queue_running ) { $this->update( $fallback ); } else { if ( ! $is_queue_running ) { self::update_db_version(); } } } /** * Is this a brand new theme install? * * @since 2.1.3 * @return boolean */ public function is_new_install() { // Get auto saved version number. /** @psalm-suppress InvalidArgument */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort $saved_version = astra_get_option( 'theme-auto-version', false ); if ( false === $saved_version ) { return true; } return false; } /** * Is a DB update needed? * * @since 2.1.3 * @return boolean */ private function needs_db_update() { $current_theme_version = astra_get_option( 'theme-auto-version', null ); $updates = $this->get_db_update_callbacks(); if ( empty( $updates ) ) { return false; } return ! is_null( $current_theme_version ) && version_compare( $current_theme_version, max( array_keys( $updates ) ), '<' ); } /** * Get list of DB update callbacks. * * @since 2.1.3 * @return array */ public function get_db_update_callbacks() { return self::$db_updates; } /** * Check if database is migrated * * @since 2.3.1 * * @return true If the database migration should not be run through CRON. */ public function check_if_data_migrated() { $fallback = false; $is_db_version_updated = $this->is_db_version_updated(); if ( ! $is_db_version_updated ) { $db_migrated = get_transient( 'astra-theme-db-migrated' ); if ( ! $db_migrated ) { $db_migrated = array(); } array_push( $db_migrated, $is_db_version_updated ); set_transient( 'astra-theme-db-migrated', $db_migrated, 3600 ); $db_migrate_count = count( $db_migrated ); if ( $db_migrate_count >= 5 ) { astra_delete_option( 'is_theme_queue_running' ); $fallback = true; } } return $fallback; } /** * Checks if astra addon version is updated in the database * * @since 2.3.1 * * @return true if astra addon version is updated. */ public function is_db_version_updated() { // Get auto saved version number. /** @psalm-suppress InvalidArgument */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort $saved_version = astra_get_option( 'theme-auto-version', false ); return version_compare( $saved_version, ASTRA_THEME_VERSION, '=' ); } /** * Push all needed DB updates to the queue for processing. * * @param bool $fallback Fallback migration. * * @return void */ private function update( $fallback ) { $current_db_version = astra_get_option( 'theme-auto-version' ); if ( count( $this->get_db_update_callbacks() ) > 0 ) { foreach ( $this->get_db_update_callbacks() as $version => $update_callbacks ) { if ( version_compare( $current_db_version, $version, '<' ) ) { foreach ( $update_callbacks as $update_callback ) { if ( $fallback ) { call_user_func( $update_callback ); } else { self::$background_updater->push_to_queue( $update_callback ); } } } } if ( $fallback ) { self::update_db_version(); } else { astra_update_option( 'is_theme_queue_running', true ); self::$background_updater->push_to_queue( 'update_db_version' ); } } else { self::$background_updater->push_to_queue( 'update_db_version' ); } self::$background_updater->save()->dispatch(); } /** * Update DB version to current. * * @param string|null $version New Astra theme version or null. */ public static function update_db_version( $version = null ) { do_action( 'astra_theme_update_before' ); // Get auto saved version number. /** @psalm-suppress InvalidArgument */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort $saved_version = astra_get_option( 'theme-auto-version', false ); if ( false === $saved_version ) { $saved_version = ASTRA_THEME_VERSION; // Update auto saved version number. astra_update_option( 'theme-auto-version', ASTRA_THEME_VERSION ); } // If equals then return. if ( version_compare( $saved_version, ASTRA_THEME_VERSION, '=' ) ) { astra_update_option( 'is_theme_queue_running', false ); return; } // Not have stored? if ( empty( $saved_version ) ) { // Get old version. $theme_version = get_option( '_astra_auto_version', ASTRA_THEME_VERSION ); // Remove option. delete_option( '_astra_auto_version' ); } else { // Get latest version. $theme_version = ASTRA_THEME_VERSION; } // Update auto saved version number. astra_update_option( 'theme-auto-version', $theme_version ); astra_update_option( 'is_theme_queue_running', false ); // Update variables. Astra_Theme_Options::refresh(); delete_transient( 'astra-addon-db-migrated' ); do_action( 'astra_theme_update_after' ); } }
Expand full source code Collapse full source code View on Trac
Methods
- __construct — Constructor
- check_if_data_migrated — Check if database is migrated
- get_db_update_callbacks — Get list of DB update callbacks.
- install_actions — Install actions when a update button is clicked within the admin area.
- is_db_version_updated — Checks if astra addon version is updated in the database
- is_new_install — Is this a brand new theme install?
- needs_db_update — Is a DB update needed?
- test_cron — Check Cron Status
- update — Push all needed DB updates to the queue for processing.
- update_db_version — Update DB version to current.