ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / lab2454c / carbonbullion.com / wp-content / plugins / woocommerce / includes / admin

<?php
/**
 * Addons Page
 *
 * @package  WooCommerce\Admin
 * @version  2.5.0
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * WC_Admin_Marketplace_Promotions class.
 */
class WC_Admin_Marketplace_Promotions {

const TRANSIENT_NAME            = 'woocommerce_marketplace_promotions';
	const SCHEDULED_ACTION_HOOK     = 'woocommerce_marketplace_fetch_promotions';
	const PROMOTIONS_API_URL        = 'https://woocommerce.com/wp-json/wccom-extensions/3.0/promotions';
	const SCHEDULED_ACTION_INTERVAL = 12 * HOUR_IN_SECONDS;

/**
	 * The user's locale, for example en_US.
	 *
	 * @var string
	 */
	public static string $locale;

/**
	 * On all admin pages, schedule an action to fetch promotions data.
	 * Shows notice and adds menu badge to WooCommerce Extensions item
	 * if the promotions API requests them.
	 *
	 * WC_Admin calls this method when it is instantiated during
	 * is_admin requests.
	 *
	 * @return void
	 */
	public static function init() {
		/**
		 * Filter to suppress the requests for and showing of marketplace promotions.
		 *
		 * @since 8.8
		 */
		if ( apply_filters( 'woocommerce_marketplace_suppress_promotions', false ) ) {
			return;
		}

register_deactivation_hook( WC_PLUGIN_FILE, array( __CLASS__, 'clear_scheduled_event' ) );

// Add the callback for our scheduled action.
		if ( ! has_action( self::SCHEDULED_ACTION_HOOK, array( __CLASS__, 'fetch_marketplace_promotions' ) ) ) {
			add_action( self::SCHEDULED_ACTION_HOOK, array( __CLASS__, 'fetch_marketplace_promotions' ) );
		}

if ( is_admin() ) {
			add_action( 'init', array( __CLASS__, 'schedule_promotion_fetch' ), 12 );
		}

if (
			defined( 'DOING_AJAX' ) && DOING_AJAX
			|| defined( 'DOING_CRON' ) && DOING_CRON
			|| defined( 'WP_CLI' ) && WP_CLI
		) {
			return;
		}

self::$locale = ( self::$locale ?? get_user_locale() ) ?? 'en_US';
		self::maybe_show_bubble_promotions();
	}

/**
	 * Schedule the action to fetch promotions data.
	 */
	public static function schedule_promotion_fetch() {
		// Schedule the action twice a day using Action Scheduler.
		if (
			function_exists( 'as_has_scheduled_action' )
			&& function_exists( 'as_schedule_recurring_action' )
			&& false === as_has_scheduled_action( self::SCHEDULED_ACTION_HOOK )
		) {
			as_schedule_recurring_action( time(), self::SCHEDULED_ACTION_INTERVAL, self::SCHEDULED_ACTION_HOOK );
		}
	}

/**
	 * Get promotions to show in the Woo in-app marketplace and load them into a transient
	 * with a 12-hour life. Run as a recurring scheduled action.
	 *
	 * @return void
	 */
	public static function fetch_marketplace_promotions() {
		// Fetch promotions from the API.
		$fetch_options  = array(
			'auth'    => true,
			'country' => true,
		);
		$raw_promotions = WC_Admin_Addons::fetch( self::PROMOTIONS_API_URL, $fetch_options );

// phpcs:disable WordPress.NamingConventions.ValidHookName.UseUnderscores
		if ( is_wp_error( $raw_promotions ) ) {
			/**
			 * Allows connection error to be handled.
			 *
			 * @since 8.7
			 */
			do_action( 'woocommerce_page_wc-addons_connection_error', $raw_promotions->get_error_message() );
		}

$response_code = (int) wp_remote_retrieve_response_code( $raw_promotions );
		if ( 200 !== $response_code ) {
			/**
			 * Allows connection error to be handled.
			 *
			 * @since 8.7
			 */
			do_action( 'woocommerce_page_wc-addons_connection_error', $response_code );
		}

$promotions = json_decode( wp_remote_retrieve_body( $raw_promotions ), true );
		if ( ! is_array( $promotions ) ) {
			$promotions = array();

/**
			 * Allows connection error to be handled.
			 *
			 * @since 8.7
			 */
			do_action( 'woocommerce_page_wc-addons_connection_error', 'Malformed response' );
		}
		// phpcs:enable WordPress.NamingConventions.ValidHookName.UseUnderscores

// Filter out any expired promotions.
		$active_promotions = self::get_active_promotions( $promotions );
		set_transient( self::TRANSIENT_NAME, $active_promotions, 12 * HOUR_IN_SECONDS );
	}

/**
	 * If there's an active promotion of the format `menu_bubble`,
	 * add a filter to show a bubble on the Extensions item in the
	 * WooCommerce menu.
	 *
	 * @return void
	 * @throws Exception  If we are unable to create a DateTime from the date_to_gmt.
	 */
	private static function maybe_show_bubble_promotions() {
		$promotions = get_transient( self::TRANSIENT_NAME );
		if ( ! $promotions ) {
			return;
		}

$bubble_promotions = self::get_promotions_of_format( $promotions, 'menu_bubble' );
		if ( empty( $bubble_promotions ) ) {
			return;
		}

$now_date_time = new DateTime( 'now', new DateTimeZone( 'UTC' ) );

// Let's make absolutely sure the promotion is still active.
		foreach ( $bubble_promotions as $promotion ) {
			if ( ! isset( $promotion['date_to_gmt'] ) ) {
				continue;
			}

try {
				$date_to_gmt = new DateTime( $promotion['date_to_gmt'], new DateTimeZone( 'UTC' ) );
			} catch ( \Exception $ex ) {
				continue;
			}

if ( $now_date_time < $date_to_gmt ) {
				add_filter(
					'woocommerce_marketplace_menu_items',
					function ( $marketplace_pages ) use ( $promotion ) {
						return self::filter_marketplace_menu_items( $marketplace_pages, $promotion );
					}
				);

break;
			}
		}
	}

/**
	 * From the array of promotions, select those of a given format.
	 *
	 * @param ? array  $promotions  Array of data about promotions of all formats.
	 * @param ? string $format      Format we want to filter for.
	 *
	 * @return array
	 */
	private static function get_promotions_of_format( $promotions = array(), $format = '' ): array {
		if ( empty( $promotions ) || empty( $format ) ) {
			return array();
		}

return array_filter(
			$promotions,
			function( $promotion ) use ( $format ) {
				return isset( $promotion['format'] ) && $format === $promotion['format'];
			}
		);
	}

/**
	 * Find promotions that are still active – they have a date range that
	 * includes the current date.
	 *
	 * @param ?array $promotions  Data about current promotions.
	 *
	 * @return array
	 */
	private static function get_active_promotions( $promotions = array() ) {
		$now_date_time     = new DateTime( 'now', new DateTimeZone( 'UTC' ) );
		$active_promotions = array();

foreach ( $promotions as $promotion ) {
			if ( ! isset( $promotion['date_from_gmt'] ) || ! isset( $promotion['date_to_gmt'] ) ) {
				continue;
			}

try {
				$date_from_gmt = new DateTime( $promotion['date_from_gmt'], new DateTimeZone( 'UTC' ) );
				$date_to_gmt   = new DateTime( $promotion['date_to_gmt'], new DateTimeZone( 'UTC' ) );
			} catch ( \Exception $ex ) {
				continue;
			}

if ( $now_date_time >= $date_from_gmt && $now_date_time <= $date_to_gmt ) {
				$active_promotions[] = $promotion;
			}
		}

// Sort promotions so the ones starting more recently are at the top.
		usort(
			$active_promotions,
			function ( $a, $b ) {
				return $b['date_from_gmt'] <=> $a['date_from_gmt'];
			}
		);

return $active_promotions;
	}

/**
	 * Callback for the `woocommerce_marketplace_menu_items` filter
	 * in `Automattic\WooCommerce\Internal\Admin\Marketplace::get_marketplace_pages`.
	 * At the moment, the Extensions page is the only page in `$menu_items`.
	 * Adds a bubble to the menu item.
	 *
	 * @param array  $menu_items  Arrays representing items in nav menu.
	 * @param ?array $promotion   Data about a promotion from the WooCommerce.com API.
	 *
	 * @return array
	 */
	public static function filter_marketplace_menu_items( $menu_items, $promotion = array() ): array {
		if ( ! isset( $promotion['menu_item_id'] ) || ! isset( $promotion['content'] ) ) {
			return $menu_items;
		}
		foreach ( $menu_items as $index => $menu_item ) {
			if (
				'woocommerce' === $menu_item['parent']
				&& $promotion['menu_item_id'] === $menu_item['id']
			) {
				$bubble_text                   = $promotion['content'][ self::$locale ] ?? ( $promotion['content']['en_US'] ?? __( 'Sale', 'woocommerce' ) );
				$menu_items[ $index ]['title'] = $menu_item['title'] . self::append_bubble( $bubble_text );

break;
			}
		}

return $menu_items;
	}

/**
	 * Return the markup for a menu item bubble with a given text and optional additional attributes.
	 *
	 * @param string $bubble_text Text of bubble.
	 * @param array  $attributes Optional. Additional attributes for the bubble, such as class or style.
	 *
	 * @return string
	 */
	private static function append_bubble( $bubble_text, $attributes = array() ) {
		$default_attributes = array(
			'class' => 'awaiting-mod update-plugins remaining-tasks-badge woocommerce-task-list-remaining-tasks-badge',
			'style' => '',
		);

$attributes = wp_parse_args( $attributes, $default_attributes );
		$class_attr = ! empty( $attributes['class'] ) ? sprintf( 'class="%s"', esc_attr( $attributes['class'] ) ) : '';
		$style_attr = ! empty( $attributes['style'] ) ? sprintf( 'style="%s"', esc_attr( $attributes['style'] ) ) : '';

$bubble_html = sprintf( ' <span %s %s>%s</span>', $class_attr, $style_attr, esc_html( $bubble_text ) );

return $bubble_html;
	}

/**
	 * When WooCommerce is deactivated, clear the scheduled action.
	 *
	 * @return void
	 */
	public static function clear_scheduled_event() {
		if ( function_exists( 'as_unschedule_all_actions' ) ) {
			as_unschedule_all_actions( self::SCHEDULED_ACTION_HOOK );
		}
	}
}

// Fetch list of promotions from WooCommerce.com for WooCommerce admin UI.
if ( ! has_action( 'init', array( 'WC_Admin_Marketplace_Promotions', 'init' ) ) ) {
	add_action( 'init', array( 'WC_Admin_Marketplace_Promotions', 'init' ), 11 );
}

[-] class-wc-admin-exporters.php [edit]
[-] class-wc-admin-pointers.php [edit]
[-] class-wc-admin-api-keys.php [edit]
[-] class-wc-admin-help.php [edit]
[-] class-wc-admin-notices.php [edit]
[+] ..
[-] class-wc-admin-webhooks.php [edit]
[-] class-wc-admin.php [edit]
[-] class-wc-admin-upload-downloadable-product.php [edit]
[-] class-wc-admin-profile.php [edit]
[-] class-wc-admin-meta-boxes.php [edit]
[-] class-wc-admin-customize.php [edit]
[+] notes
[+] marketplace-suggestions
[-] wc-meta-box-functions.php [edit]
[+] importers
[-] class-wc-admin-api-keys-table-list.php [edit]
[-] class-wc-admin-post-types.php [edit]
[-] class-wc-admin-menus.php [edit]
[+] meta-boxes
[-] class-wc-admin-dashboard.php [edit]
[-] class-wc-admin-setup-wizard.php [edit]
[+] list-tables
[-] wc-admin-functions.php [edit]
[+] helper
[+] plugin-updates
[-] class-wc-admin-webhooks-table-list.php [edit]
[-] class-wc-admin-dashboard-setup.php [edit]
[-] class-wc-admin-status.php [edit]
[+] settings
[-] class-wc-admin-addons.php [edit]
[-] class-wc-admin-marketplace-promotions.php [edit]
[-] class-wc-admin-settings.php [edit]
[-] class-wc-admin-permalink-settings.php [edit]
[+] views
[-] class-wc-admin-reports.php [edit]
[-] class-wc-admin-duplicate-product.php [edit]
[-] class-wc-admin-taxonomies.php [edit]
[-] class-wc-admin-importers.php [edit]
[-] class-wc-admin-log-table-list.php [edit]
[+] reports
[-] class-wc-admin-attributes.php [edit]
[-] class-wc-admin-assets.php [edit]