DefaultPromotions.php
1 year ago
Init.php
1 year ago
WCPayPromotionDataSourcePoller.php
1 year ago
WCPaymentGatewayPreInstallWCPayPromotion.php
10 months ago
Init.php
192 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Handles WooPayments promotion. |
| 4 | */ |
| 5 | |
| 6 | namespace Automattic\WooCommerce\Internal\Admin\WCPayPromotion; |
| 7 | |
| 8 | defined( 'ABSPATH' ) || exit; |
| 9 | |
| 10 | use Automattic\WooCommerce\Admin\Features\PaymentGatewaySuggestions\EvaluateSuggestion; |
| 11 | use Automattic\WooCommerce\Internal\Admin\WCAdminAssets; |
| 12 | use Automattic\WooCommerce\Admin\RemoteSpecs\RemoteSpecsEngine; |
| 13 | use Automattic\WooCommerce\Utilities\FeaturesUtil; |
| 14 | |
| 15 | /** |
| 16 | * WooPayments Promotion engine. |
| 17 | * |
| 18 | * @deprecated 9.9.0 The WooPayments promotion engine is deprecated and will be removed in a future version of WooCommerce. |
| 19 | */ |
| 20 | class Init extends RemoteSpecsEngine { |
| 21 | |
| 22 | /** |
| 23 | * Possibly registers the pre-install WooPayments promoted gateway. |
| 24 | * |
| 25 | * @param array $gateways List of gateway classes. |
| 26 | * |
| 27 | * @return array List of gateway classes. |
| 28 | */ |
| 29 | public static function possibly_register_pre_install_wc_pay_promotion_gateway( $gateways ) { |
| 30 | if ( self::can_show_promotion() && ! WCPaymentGatewayPreInstallWCPayPromotion::is_dismissed() ) { |
| 31 | $gateways[] = 'Automattic\WooCommerce\Internal\Admin\WCPayPromotion\WCPaymentGatewayPreInstallWCPayPromotion'; |
| 32 | } |
| 33 | return $gateways; |
| 34 | } |
| 35 | |
| 36 | /** |
| 37 | * Checks if promoted gateway can be registered. |
| 38 | * |
| 39 | * @return boolean If promoted gateway should be registered. |
| 40 | */ |
| 41 | public static function can_show_promotion() { |
| 42 | // Don't show if WooPayments is enabled. |
| 43 | if ( class_exists( '\WC_Payments' ) ) { |
| 44 | return false; |
| 45 | } |
| 46 | |
| 47 | // Don't show if there is no WooPayments promotion spec. |
| 48 | $wc_pay_spec = self::get_wc_pay_promotion_spec(); |
| 49 | if ( ! $wc_pay_spec ) { |
| 50 | return false; |
| 51 | } |
| 52 | |
| 53 | return true; |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * By default, new payment gateways are put at the bottom of the list on the admin "Payments" settings screen. |
| 58 | * For visibility, we want WooPayments to be at the top of the list. |
| 59 | * |
| 60 | * @param array $ordering Existing ordering of the payment gateways. |
| 61 | * |
| 62 | * @return array Modified ordering. |
| 63 | */ |
| 64 | public static function set_gateway_top_of_list( $ordering ) { |
| 65 | $ordering = (array) $ordering; |
| 66 | $id = WCPaymentGatewayPreInstallWCPayPromotion::GATEWAY_ID; |
| 67 | // Only tweak the ordering if the list hasn't been reordered with WooPayments in it already. |
| 68 | if ( ! isset( $ordering[ $id ] ) || ! is_numeric( $ordering[ $id ] ) ) { |
| 69 | $is_empty = empty( $ordering ) || ( count( $ordering ) === 1 && in_array( $ordering[0], array( false, '' ) ) ); |
| 70 | $ordering[ $id ] = $is_empty ? 0 : ( min( array_map( 'intval', $ordering ) ) - 1 ); |
| 71 | } |
| 72 | |
| 73 | return $ordering; |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Get WooPayments promotion spec. |
| 78 | * |
| 79 | * @param boolean $fetch_from_remote Whether to fetch the spec from remote or not. |
| 80 | * |
| 81 | * @return object|false WooPayments promotion spec or false if there isn't one. |
| 82 | */ |
| 83 | public static function get_wc_pay_promotion_spec( $fetch_from_remote = true ) { |
| 84 | $promotions = $fetch_from_remote ? self::get_promotions() : self::get_cached_or_default_promotions(); |
| 85 | $wc_pay_promotion_spec = array_values( |
| 86 | array_filter( |
| 87 | $promotions, |
| 88 | function ( $promotion ) { |
| 89 | return isset( $promotion->plugins ) && in_array( 'woocommerce-payments', $promotion->plugins, true ); |
| 90 | } |
| 91 | ) |
| 92 | ); |
| 93 | |
| 94 | return current( $wc_pay_promotion_spec ); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Go through the specs and run them. |
| 99 | * |
| 100 | * @return array List of promotions. |
| 101 | */ |
| 102 | public static function get_promotions() { |
| 103 | $locale = get_user_locale(); |
| 104 | |
| 105 | $specs = self::get_specs(); |
| 106 | $results = EvaluateSuggestion::evaluate_specs( $specs, array( 'source' => 'wc-wcpay-promotions' ) ); |
| 107 | $specs_to_return = $results['suggestions']; |
| 108 | $specs_to_save = null; |
| 109 | |
| 110 | if ( empty( $specs_to_return ) ) { |
| 111 | // When specs are empty, replace it with defaults and save for 3 hours. |
| 112 | $specs_to_save = DefaultPromotions::get_all(); |
| 113 | $specs_to_return = EvaluateSuggestion::evaluate_specs( $specs_to_save )['suggestions']; |
| 114 | } elseif ( count( $results['errors'] ) > 0 ) { |
| 115 | // When specs are not empty but have errors, save for 3 hours. |
| 116 | $specs_to_save = $specs; |
| 117 | } |
| 118 | |
| 119 | if ( count( $results['errors'] ) > 0 ) { |
| 120 | self::log_errors( $results['errors'] ); |
| 121 | } |
| 122 | |
| 123 | if ( $specs_to_save ) { |
| 124 | WCPayPromotionDataSourcePoller::get_instance()->set_specs_transient( array( $locale => $specs_to_save ), 3 * HOUR_IN_SECONDS ); |
| 125 | } |
| 126 | |
| 127 | return $specs_to_return; |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Gets either cached or default promotions. |
| 132 | * |
| 133 | * @return array |
| 134 | */ |
| 135 | public static function get_cached_or_default_promotions() { |
| 136 | $specs = 'no' === get_option( 'woocommerce_show_marketplace_suggestions', 'yes' ) |
| 137 | ? DefaultPromotions::get_all() |
| 138 | : WCPayPromotionDataSourcePoller::get_instance()->get_cached_specs(); |
| 139 | |
| 140 | if ( ! is_array( $specs ) || 0 === count( $specs ) ) { |
| 141 | $specs = DefaultPromotions::get_all(); |
| 142 | } |
| 143 | $results = EvaluateSuggestion::evaluate_specs( $specs, array( 'source' => 'wc-wcpay-promotions' ) ); |
| 144 | return $results['suggestions']; |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Get merchant WooPay eligibility. |
| 149 | * |
| 150 | * @return boolean If merchant is eligible for WooPay. |
| 151 | */ |
| 152 | public static function is_woopay_eligible() { |
| 153 | $wcpay_promotion = self::get_wc_pay_promotion_spec( false ); |
| 154 | |
| 155 | return $wcpay_promotion && 'woocommerce_payments:woopay' === $wcpay_promotion->id; |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Delete the specs transient. |
| 160 | */ |
| 161 | public static function delete_specs_transient() { |
| 162 | WCPayPromotionDataSourcePoller::get_instance()->delete_specs_transient(); |
| 163 | } |
| 164 | |
| 165 | /** |
| 166 | * Get specs or fetch remotely if they don't exist. |
| 167 | * |
| 168 | * @return array List of specs. |
| 169 | */ |
| 170 | public static function get_specs() { |
| 171 | if ( get_option( 'woocommerce_show_marketplace_suggestions', 'yes' ) === 'no' ) { |
| 172 | return DefaultPromotions::get_all(); |
| 173 | } |
| 174 | |
| 175 | $specs = WCPayPromotionDataSourcePoller::get_instance()->get_specs_from_data_sources(); |
| 176 | // On empty remote specs, fallback to default ones. |
| 177 | if ( ! is_array( $specs ) || 0 === count( $specs ) ) { |
| 178 | $specs = DefaultPromotions::get_all(); |
| 179 | } |
| 180 | |
| 181 | return $specs; |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Loads the payment method promotions scripts and styles. |
| 186 | */ |
| 187 | public static function load_payment_method_promotions() { |
| 188 | WCAdminAssets::register_style( 'payment-method-promotions', 'style', array( 'wp-components' ) ); |
| 189 | WCAdminAssets::register_script( 'wp-admin-scripts', 'payment-method-promotions', true ); |
| 190 | } |
| 191 | } |
| 192 |