<?php
/**
 * WooCommerce Plugin Framework
 *
 * This source file is subject to the GNU General Public License v3.0
 * that is bundled with this package in the file license.txt.
 * It is also available through the world-wide-web at this URL:
 * http://www.gnu.org/licenses/gpl-3.0.html
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@skyverge.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade the plugin to newer
 * versions in the future. If you wish to customize the plugin for your
 * needs please refer to http://www.skyverge.com
 *
 * @package   SkyVerge/WooCommerce/Plugin/Classes
 * @author    SkyVerge
 * @copyright Copyright (c) 2013-2024, SkyVerge, Inc.
 * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
 */

namespace SkyVerge\WooCommerce\PluginFramework\v6_0_1;

use Automattic\WooCommerce\Utilities\OrderUtil;

defined( 'ABSPATH' ) or exit;

if ( ! class_exists( '\\SkyVerge\\WooCommerce\\PluginFramework\\v6_0_1\\SV_WC_Plugin_Compatibility' ) ) :


/**
 * WooCommerce Compatibility Utility Class
 *
 * The unfortunate purpose of this class is to provide a single point of
 * compatibility functions for dealing with supporting multiple versions
 * of WooCommerce and various extensions.
 *
 * The expected procedure is to remove methods from this class, using the
 * latest ones directly in code, as support for older versions of WooCommerce
 * are dropped.
 *
 * Current Compatibility
 * + Core 3.0.9 - 3.7.x
 * + Subscriptions 2.2.x
 *
 * // TODO: move to /compatibility
 *
 * @since 2.0.0
 */
#[\AllowDynamicProperties]
class SV_WC_Plugin_Compatibility {


	/**
	 * Retrieves a list of the latest available WooCommerce versions.
	 *
	 * Excludes betas, release candidates and development versions.
	 * Versions are sorted from most recent to least recent.
	 *
	 * @since 5.4.1
	 *
	 * @return string[] array of semver strings
	 */
	public static function get_latest_wc_versions() {

		$latest_wc_versions = get_transient( 'sv_wc_plugin_wc_versions' );

		if ( ! is_array( $latest_wc_versions ) ) {

			/** @link https://codex.wordpress.org/WordPress.org_API */
			$wp_org_request = wp_remote_get( 'https://api.wordpress.org/plugins/info/1.0/woocommerce.json', [ 'timeout' => 1 ] );

			if ( is_array( $wp_org_request ) && isset( $wp_org_request['body'] ) ) {

				$plugin_info = json_decode( $wp_org_request['body'], true );

				if ( is_array( $plugin_info ) && ! empty( $plugin_info['versions'] ) && is_array( $plugin_info['versions'] ) ) {

					$latest_wc_versions = [];

					// reverse array as WordPress supplies oldest version first, newest last
					foreach ( array_keys( array_reverse( $plugin_info['versions'] ) ) as $wc_version ) {

						// skip trunk, release candidates, betas and other non-final or irregular versions
						if (
							   is_string( $wc_version )
							&& '' !== $wc_version
							&& is_numeric( $wc_version[0] )
							&& false === strpos( $wc_version, '-' )
						) {
							$latest_wc_versions[] = $wc_version;
						}
					}

					set_transient( 'sv_wc_plugin_wc_versions', $latest_wc_versions, WEEK_IN_SECONDS );
				}
			}
		}

		return is_array( $latest_wc_versions ) ? $latest_wc_versions : [];
	}


	/**
	 * Gets the version of the currently installed WooCommerce.
	 *
	 * @since 3.0.0
	 *
	 * @return string|null Woocommerce version number or null if undetermined
	 */
	public static function get_wc_version() {

		return defined( 'WC_VERSION' ) && WC_VERSION ? WC_VERSION : null;
	}


	/**
	 * Determines if the installed WooCommerce version matches a specific version.
	 *
	 * @since 5.5.0
	 *
	 * @param string $version semver
	 * @return bool
	 */
	public static function is_wc_version( $version ) {

		$wc_version = self::get_wc_version();

		// accounts for semver cases like 3.0 being equal to 3.0.0
		return $wc_version === $version || ( $wc_version && version_compare( $wc_version, $version, '=' ) );
	}


	/**
	 * Determines if the installed version of WooCommerce is equal or greater than a given version.
	 *
	 * @since 4.7.3
	 *
	 * @param string $version version number to compare
	 * @return bool
	 */
	public static function is_wc_version_gte( $version ) {

		$wc_version = self::get_wc_version();

		return $wc_version && version_compare( $wc_version, $version, '>=' );
	}


	/**
	 * Determines if the installed version of WooCommerce is lower than a given version.
	 *
	 * @since 4.7.3
	 *
	 * @param string $version version number to compare
	 * @return bool
	 */
	public static function is_wc_version_lt( $version ) {

		$wc_version = self::get_wc_version();

		return $wc_version && version_compare( $wc_version, $version, '<' );
	}


	/**
	 * Determines if the installed version of WooCommerce is greater than a given version.
	 *
	 * @since 2.0.0
	 *
	 * @param string $version the version to compare
	 * @return bool
	 */
	public static function is_wc_version_gt( $version ) {

		$wc_version = self::get_wc_version();

		return $wc_version && version_compare( $wc_version, $version, '>' );
	}


	/**
	 * Determines whether the enhanced admin is available.
	 *
	 * This checks both for WooCommerce v4.0+ and the underlying package availability.
	 *
	 * @since 5.6.0
	 *
	 * @return bool
	 */
	public static function is_enhanced_admin_available() : bool
	{
		return self::is_wc_version_gte( '4.0' ) && function_exists( 'wc_admin_url' );
	}


	/** WordPress core ******************************************************/


	/**
	 * Normalizes a WooCommerce page screen ID.
	 *
	 * Needed because WordPress uses a menu title (which is translatable), not slug, to generate screen ID.
	 * See details in: https://core.trac.wordpress.org/ticket/21454
	 * TODO: Add WP version check when https://core.trac.wordpress.org/ticket/18857 is addressed {BR 2016-12-12}
	 *
	 * @since 4.6.0
	 *
	 * @param string $slug slug for the screen ID to normalize (minus `woocommerce_page_`)
	 * @return string normalized screen ID
	 */
	public static function normalize_wc_screen_id( $slug = 'wc-settings' ) {

		// The textdomain usage is intentional here, we need to match the menu title.
		$prefix = sanitize_title( __( 'WooCommerce', 'woocommerce' ) );

		return $prefix . '_page_' . $slug;
	}


	/**
	 * Converts a shorthand byte value to an integer byte value.
	 *
	 * Wrapper for wp_convert_hr_to_bytes(), moved to load.php in WordPress 4.6 from media.php
	 *
	 * Based on ActionScheduler's compat wrapper for the same function:
	 * ActionScheduler_Compatibility::convert_hr_to_bytes()
	 *
	 * @link https://secure.php.net/manual/en/function.ini-get.php
	 * @link https://secure.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
	 *
	 * @since 5.3.1
	 *
	 * @param string $value A (PHP ini) byte value, either shorthand or ordinary.
	 * @return int An integer byte value.
	 */
	public static function convert_hr_to_bytes( $value ) {

		if ( function_exists( 'wp_convert_hr_to_bytes' ) ) {

			return wp_convert_hr_to_bytes( $value );
		}

		$value = strtolower( trim( $value ) );
		$bytes = (int) $value;

		if ( false !== strpos( $value, 'g' ) ) {

			$bytes *= GB_IN_BYTES;

		} elseif ( false !== strpos( $value, 'm' ) ) {

			$bytes *= MB_IN_BYTES;

		} elseif ( false !== strpos( $value, 'k' ) ) {

			$bytes *= KB_IN_BYTES;
		}

		// deal with large (float) values which run into the maximum integer size
		return min( $bytes, PHP_INT_MAX );
	}


	/** Subscriptions *********************************************************/


	/**
	 * Determines if the installed version of WooCommerce Subscriptions matches or exceeds a given version.
	 *
	 * @since 5.5.0
	 *
	 * @param string $version version number to compare
	 * @return bool
	 */
	public static function is_wc_subscriptions_version_gte( $version ) {

		$subscriptions_version = self::get_wc_subscriptions_version();

		return $subscriptions_version && version_compare( $subscriptions_version, $version, '>=' );
	}

	/**
	 * Determines if the installed version of WooCommerce Subscriptions exceeds a given version.
	 *
	 * @since 5.5.0
	 *
	 * @param string $version version number to compare
	 * @return bool
	 */
	public static function is_wc_subscriptions_version_gt( $version ) {

		$subscriptions_version = self::get_wc_subscriptions_version();

		return $subscriptions_version && version_compare( $subscriptions_version, $version, '>' );
	}


	/**
	 * Determines if the installed version of WooCommerce Subscriptions is lower than a given version.
	 *
	 * @since 5.5.0
	 *
	 * @param string $version version number to compare
	 * @return bool
	 */
	public static function is_wc_subscriptions_version_lt( $version ) {

		$subscriptions_version = self::get_wc_subscriptions_version();

		return $subscriptions_version && version_compare( $subscriptions_version, $version, '<' );
	}


	/**
	 * Gets the version of the currently installed WooCommerce Subscriptions.
	 *
	 * @since 4.1.0
	 *
	 * @return string|null WooCommerce Subscriptions version number or null if not found
	 */
	protected static function get_wc_subscriptions_version() : ?string {

		$version = null;

		if ( class_exists( 'WC_Subscriptions' ) && ! empty( \WC_Subscriptions::$version ) ) {
			$version = \WC_Subscriptions::$version;
		} elseif ( class_exists( 'WC_Subscriptions_Core_Plugin' ) ) {
			 if ( is_callable( [ \WC_Subscriptions_Core_Plugin::class, 'instance' ] ) ) {

				 $instance = \WC_Subscriptions_Core_Plugin::instance();

				 if ( is_object( $instance ) && method_exists( $instance, 'get_library_version' ) ) {
					 $version = $instance->get_library_version();
				 }
			 }
		}

		/**
		 * Filters the WooCommerce Subscriptions version when fetched by the framework.
		 *
		 * This accounts for cases where the version is not found by the framework as Subscriptions may be embedded as a core library by third party code.
		 *
		 * @param string|null $version WooCommerce Subscriptions version
		 */
		return apply_filters( 'sv_wc_plugin_framework_wc_subscriptions_version', $version );
	}


	/**
	 * Determines if the installed WooCommerce Subscriptions version matches a specific version.
	 *
	 * @since 5.5.0
	 *
	 * @param string $version semver
	 * @return bool
	 */
	protected static function is_wc_subscriptions_version( $version ) {

		$subscriptions_version = self::get_wc_subscriptions_version();

		// accounts for semver cases like 2.2 being equal to 2.2.0
		return $version === $subscriptions_version || ( $subscriptions_version && version_compare( $version, $subscriptions_version, '=' ) );
	}


	/**
	 * Determines whether HPOS is enabled.
	 *
	 * @link https://woocommerce.com/document/high-performance-order-storage/
	 * @link https://github.com/woocommerce/woocommerce/wiki/High-Performance-Order-Storage-Upgrade-Recipe-Book#detecting-whether-hpos-tables-are-being-used-in-the-store
	 *
	 * @since 5.11.0
	 *
	 * @return bool
	 */
	public static function is_hpos_enabled() : bool {

		return is_callable( OrderUtil::class . '::' . 'custom_orders_table_usage_is_enabled' )
			&& OrderUtil::custom_orders_table_usage_is_enabled();
	}


}


endif;
