auto-patch 638-dev-dev01-2024-05-14T20_44_36

wp/wp-content/plugins/woocommerce/src/Internal/ComingSoon/ComingSoonCacheInvalidator.php

@@ -0,0 +1,43 @@
+<?php
+namespace Automattic\WooCommerce\Internal\ComingSoon;
+
+/**
+ * Adds hooks to invalidate caches when the coming soon settings are changed.
+ */
+class ComingSoonCacheInvalidator {
+
+	/**
+	 * Sets up the hooks.
+	 *
+	 * @internal
+	 */
+	final public function init() {
+		add_action( 'update_option_woocommerce_coming_soon', array( $this, 'invalidate_caches' ) );
+		add_action( 'update_option_woocommerce_store_pages_only', array( $this, 'invalidate_caches' ) );
+	}
+
+	/**
+	 * Invalidate the WordPress object cache and other known caches.
+	 *
+	 * @internal
+	 */
+	public function invalidate_caches() {
+		// Standard WordPress object cache invalidation.
+		wp_cache_flush();
+
+		/**
+		 * Temporary solution to invalidate the WordPress.com Edge Cache. We can trigger
+		 * invalidation by publishing any post. It should be refactored with a supported integration.
+		 */
+		$cart_page_id = get_option( 'woocommerce_cart_page_id' ) ?? null;
+		if ( $cart_page_id ) {
+			// Re-publish the coming soon page. Has the side-effect of invalidating the Edge Cache.
+			wp_update_post(
+				array(
+					'ID'          => $cart_page_id,
+					'post_status' => 'publish',
+				)
+			);
+		}
+	}
+}

wp/wp-content/plugins/woocommerce/src/Internal/ComingSoon/ComingSoonHelper.php

@@ -0,0 +1,71 @@
+<?php
+namespace Automattic\WooCommerce\Internal\ComingSoon;
+
+use Automattic\WooCommerce\Admin\WCAdminHelper;
+
+/**
+ * Provides helper methods for coming soon functionality.
+ */
+class ComingSoonHelper {
+
+	/**
+	 * Returns true when the entire site is live.
+	 */
+	public function is_site_live(): bool {
+		return 'yes' !== get_option( 'woocommerce_coming_soon' );
+	}
+
+	/**
+	 * Returns true when the entire site is coming soon mode.
+	 */
+	public function is_site_coming_soon(): bool {
+		return 'yes' === get_option( 'woocommerce_coming_soon' ) && 'yes' !== get_option( 'woocommerce_store_pages_only' );
+	}
+
+	/**
+	 * Returns true when only the store pages are in coming soon mode.
+	 */
+	public function is_store_coming_soon(): bool {
+		return 'yes' === get_option( 'woocommerce_coming_soon' ) && 'yes' === get_option( 'woocommerce_store_pages_only' );
+	}
+
+	/**
+	 * Returns true when the provided URL is behind a coming soon screen.
+	 *
+	 * @param string $url The URL to check.
+	 */
+	public function is_url_coming_soon( string $url ): bool {
+		// Early exit if coming soon mode not active.
+		if ( $this->is_site_live() ) {
+			return false;
+		}
+
+		if ( $this->is_site_coming_soon() ) {
+			return true;
+		}
+
+		// Check the URL is a store page when in "store coming soon" mode.
+		if ( $this->is_store_coming_soon() && WCAdminHelper::is_store_page( $url ) ) {
+			return true;
+		}
+
+		// Default to false.
+		return false;
+	}
+
+	/**
+	 * Builds the relative URL from the WP instance.
+	 *
+	 * @internal
+	 * @link https://wordpress.stackexchange.com/a/274572
+	 * @param \WP $wp WordPress environment instance.
+	 */
+	public function get_url_from_wp( \WP $wp ) {
+		// Special case for plain permalinks.
+		if ( empty( get_option( 'permalink_structure' ) ) ) {
+			return '/' . add_query_arg( $wp->query_vars, $wp->request );
+		}
+
+		return trailingslashit( '/' . $wp->request );
+	}
+}

wp/wp-content/plugins/woocommerce/src/Internal/ComingSoon/ComingSoonRequestHandler.php

@@ -0,0 +1,146 @@
+<?php
+namespace Automattic\WooCommerce\Internal\ComingSoon;
+
+use Automattic\WooCommerce\Admin\Features\Features;
+
+/**
+ * Handles the parse_request hook to determine whether the current page needs
+ * to be replaced with a comiing soon screen.
+ */
+class ComingSoonRequestHandler {
+
+	/**
+	 * Coming soon helper.
+	 *
+	 * @var ComingSoonHelper
+	 */
+	private $coming_soon_helper = null;
+
+	/**
+	 * Sets up the hook.
+	 *
+	 * @internal
+	 *
+	 * @param ComingSoonHelper $coming_soon_helper Dependency.
+	 */
+	final public function init( ComingSoonHelper $coming_soon_helper ) {
+		$this->coming_soon_helper = $coming_soon_helper;
+		add_filter( 'template_include', array( $this, 'handle_template_include' ) );
+		add_action( 'wp_enqueue_scripts', array( $this, 'deregister_unnecessary_styles' ), 100 );
+	}
+
+	/**
+	 * Deregisters unnecessary styles for the coming soon page.
+	 *
+	 * @return void
+	 */
+	public function deregister_unnecessary_styles() {
+		global $wp;
+
+		if ( ! $this->should_show_coming_soon( $wp ) ) {
+			return;
+		}
+
+		if ( $this->coming_soon_helper->is_site_coming_soon() ) {
+			global $wp_styles;
+
+			foreach ( $wp_styles->registered as $handle => $registered_style ) {
+				// Deregister all styles except for block styles.
+				if (
+					strpos( $handle, 'wp-block' ) !== 0 &&
+					strpos( $handle, 'core-block' ) !== 0
+				) {
+					wp_deregister_style( $handle );
+				}
+			}
+		}
+	}
+
+	/**
+	 * Replaces the page template with a 'coming soon' when the site is in coming soon mode.
+	 *
+	 * @internal
+	 *
+	 * @param string $template The path to the previously determined template.
+	 * @return string|null The path to the 'coming soon' template or null to prevent further template loading in FSE themes.
+	 */
+	public function handle_template_include( $template ) {
+		global $wp;
+
+		if ( ! $this->should_show_coming_soon( $wp ) ) {
+			return $template;
+		}
+
+		// A coming soon page needs to be displayed. Don't cache this response.
+		nocache_headers();
+
+		// Optimize search engine by returning 503 status code and set retry-after header to 12 hours.
+		status_header( 503 );
+		header( 'Retry-After: ' . 12 * HOUR_IN_SECONDS );
+
+		add_theme_support( 'block-templates' );
+		wp_dequeue_style( 'global-styles' );
+		$coming_soon_template = get_query_template( 'coming-soon' );
+
+		if ( ! wc_current_theme_is_fse_theme() && $this->coming_soon_helper->is_store_coming_soon() ) {
+			get_header();
+		}
+
+		include $coming_soon_template;
+
+		if ( ! wc_current_theme_is_fse_theme() && $this->coming_soon_helper->is_store_coming_soon() ) {
+			get_footer();
+		}
+
+		if ( wc_current_theme_is_fse_theme() ) {
+			// Since we've already rendered a template, return null to ensure no other template is rendered.
+			return null;
+		} else {
+			// In non-FSE themes, other templates will still be rendered.
+			// We need to exit to prevent further processing.
+			exit();
+		}
+	}
+
+	/**
+	 * Determines whether the coming soon screen should be shown.
+	 *
+	 * @param \WP $wp Current WordPress environment instance.
+	 *
+	 * @return bool
+	 */
+	private function should_show_coming_soon( \WP &$wp ) {
+		// Early exit if LYS feature is disabled.
+		if ( ! Features::is_enabled( 'launch-your-store' ) ) {
+			return false;
+		}
+
+		// Early exit if the user is logged in as administrator / shop manager.
+		if ( current_user_can( 'manage_woocommerce' ) ) {
+			return false;
+		}
+
+		// Do not show coming soon on 404 pages when restrict to store pages only.
+		if ( $this->coming_soon_helper->is_store_coming_soon() && is_404() ) {
+			return false;
+		}
+
+		// Early exit if the URL doesn't need a coming soon screen.
+		$url = $this->coming_soon_helper->get_url_from_wp( $wp );
+
+		if ( ! $this->coming_soon_helper->is_url_coming_soon( $url ) ) {
+			return false;
+		}
+
+		// Exclude users with a private link.
+		if ( isset( $_GET['woo-share'] ) && get_option( 'woocommerce_share_key' ) === $_GET['woo-share'] ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			// Persist the share link with a cookie for 90 days.
+			setcookie( 'woo-share', sanitize_text_field( wp_unslash( $_GET['woo-share'] ) ), time() + 60 * 60 * 24 * 90, '/' ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			return false;
+		}
+		if ( isset( $_COOKIE['woo-share'] ) && get_option( 'woocommerce_share_key' ) === $_COOKIE['woo-share'] ) {
+			return false;
+		}
+		return true;
+	}
+}