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