<?php

[0] Fix | Delete

declare( strict_types=1 );

[1] Fix | Delete

[2] Fix | Delete

namespace Automattic\WooCommerce\Internal\Admin\Settings;

[3] Fix | Delete

[4] Fix | Delete

use Automattic\WooCommerce\Internal\Admin\Settings\PaymentsProviders\WooPayments\WooPaymentsService;

[5] Fix | Delete

use Automattic\WooCommerce\Internal\Logging\SafeGlobalFunctionProxy;

[6] Fix | Delete

use Throwable;

[7] Fix | Delete

use WC_Gateway_BACS;

[8] Fix | Delete

use WC_Gateway_Cheque;

[9] Fix | Delete

use WC_Gateway_COD;

[10] Fix | Delete

[11] Fix | Delete

defined( 'ABSPATH' ) || exit;

[12] Fix | Delete

/**

[13] Fix | Delete

* Payments settings controller class.

[14] Fix | Delete

*

[15] Fix | Delete

* Use this class for hooks and actions related to the Payments settings page.

[16] Fix | Delete

*

[17] Fix | Delete

* @internal

[18] Fix | Delete

*/

[19] Fix | Delete

class PaymentsController {

[20] Fix | Delete

[21] Fix | Delete

const TRANSIENT_HAS_PROVIDERS_WITH_INCENTIVE_KEY = 'woocommerce_admin_settings_payments_has_providers_with_incentive';

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* The payment service.

[25] Fix | Delete

*

[26] Fix | Delete

* @var Payments

[27] Fix | Delete

*/

[28] Fix | Delete

private Payments $payments;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Register hooks.

[32] Fix | Delete

*/

[33] Fix | Delete

public function register() {

[34] Fix | Delete

add_action( 'admin_menu', array( $this, 'add_menu' ) );

[35] Fix | Delete

add_filter( 'admin_body_class', array( $this, 'add_body_classes' ), 20 );

[36] Fix | Delete

add_filter( 'woocommerce_admin_shared_settings', array( $this, 'preload_settings' ) );

[37] Fix | Delete

add_filter( 'woocommerce_admin_allowed_promo_notes', array( $this, 'add_allowed_promo_notes' ) );

[38] Fix | Delete

add_filter( 'woocommerce_get_sections_checkout', array( $this, 'handle_sections' ), 20 );

[39] Fix | Delete

add_action( 'woocommerce_admin_payments_extension_suggestion_incentive_dismissed', array( $this, 'handle_incentive_dismissed' ) );

[40] Fix | Delete

}

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Initialize the class instance.

[44] Fix | Delete

*

[45] Fix | Delete

* @param Payments $payments The payments service.

[46] Fix | Delete

*

[47] Fix | Delete

* @internal

[48] Fix | Delete

*/

[49] Fix | Delete

final public function init( Payments $payments ): void {

[50] Fix | Delete

$this->payments = $payments;

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Adds the Payments top-level menu item.

[55] Fix | Delete

*/

[56] Fix | Delete

public function add_menu() {

[57] Fix | Delete

global $menu;

[58] Fix | Delete

[59] Fix | Delete

// When the WooPayments account is onboarded, WooPayments will own the Payments menu item since it is the native Woo payments solution.

[60] Fix | Delete

if ( $this->is_woopayments_account_onboarded() ) {

[61] Fix | Delete

return;

[62] Fix | Delete

} else {

[63] Fix | Delete

// Otherwise, remove the Payments menu item linking to the Connect page to avoid Payments menu item duplication.

[64] Fix | Delete

remove_menu_page( 'wc-admin&path=/payments/connect' );

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

$menu_title = esc_html__( 'Payments', 'woocommerce' );

[68] Fix | Delete

$menu_icon = 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NTIiIGhlaWdodD0iNjg0Ij48cGF0aCBmaWxsPSIjYTJhYWIyIiBkPSJNODIgODZ2NTEyaDY4NFY4NlptMCA1OThjLTQ4IDAtODQtMzgtODQtODZWODZDLTIgMzggMzQgMCA4MiAwaDY4NGM0OCAwIDg0IDM4IDg0IDg2djUxMmMwIDQ4LTM2IDg2LTg0IDg2em0zODQtNTU2djQ0aDg2djg0SDM4MnY0NGgxMjhjMjQgMCA0MiAxOCA0MiA0MnYxMjhjMCAyNC0xOCA0Mi00MiA0MmgtNDR2NDRoLTg0di00NGgtODZ2LTg0aDE3MHYtNDRIMzM4Yy0yNCAwLTQyLTE4LTQyLTQyVjIxNGMwLTI0IDE4LTQyIDQyLTQyaDQ0di00NHoiLz48L3N2Zz4=';

[69] Fix | Delete

// Link to the Payments settings page.

[70] Fix | Delete

$menu_path = 'admin.php?page=wc-settings&tab=checkout&from=' . Payments::FROM_PAYMENTS_MENU_ITEM;

[71] Fix | Delete

[72] Fix | Delete

add_menu_page(

[73] Fix | Delete

$menu_title,

[74] Fix | Delete

$menu_title,

[75] Fix | Delete

'manage_woocommerce', // Capability required to see the menu item.

[76] Fix | Delete

$menu_path,

[77] Fix | Delete

null,

[78] Fix | Delete

$menu_icon,

[79] Fix | Delete

56, // Position after WooCommerce Product menu item.

[80] Fix | Delete

);

[81] Fix | Delete

[82] Fix | Delete

// If there are providers with an active incentive, add a notice badge to the Payments menu item.

[83] Fix | Delete

if ( $this->store_has_providers_with_incentive() ) {

[84] Fix | Delete

$badge = ' <span class="wcpay-menu-badge awaiting-mod count-1"><span class="plugin-count">1</span></span>';

[85] Fix | Delete

foreach ( $menu as $index => $menu_item ) {

[86] Fix | Delete

// Only add the badge markup if not already present, and the menu item is the Payments menu item.

[87] Fix | Delete

if ( 0 === strpos( $menu_item[0], $menu_title )

[88] Fix | Delete

&& $menu_path === $menu_item[2]

[89] Fix | Delete

&& false === strpos( $menu_item[0], $badge ) ) {

[90] Fix | Delete

[91] Fix | Delete

$menu[ $index ][0] .= $badge; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited

[92] Fix | Delete

[93] Fix | Delete

// One menu item with a badge is more than enough.

[94] Fix | Delete

break;

[95] Fix | Delete

}

[96] Fix | Delete

}

[97] Fix | Delete

}

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Adds body classes when in the Payments Settings admin area.

[102] Fix | Delete

*

[103] Fix | Delete

* @param string $classes The existing body classes for the admin area.

[104] Fix | Delete

*

[105] Fix | Delete

* @return string The modified body classes for the admin area.

[106] Fix | Delete

*/

[107] Fix | Delete

public function add_body_classes( $classes = '' ) {

[108] Fix | Delete

global $current_tab;

[109] Fix | Delete

[110] Fix | Delete

// Bail if the type is invalid.

[111] Fix | Delete

if ( ! is_string( $classes ) ) {

[112] Fix | Delete

return $classes;

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

if ( 'checkout' === $current_tab && ! str_contains( 'woocommerce-settings-payments-tab', $classes ) ) {

[116] Fix | Delete

$classes = "$classes woocommerce-settings-payments-tab";

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

return $classes;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

/**

[123] Fix | Delete

* Preload settings to make them available to the Payments settings page frontend logic.

[124] Fix | Delete

*

[125] Fix | Delete

* Added keys will be available in the window.wcSettings.admin object.

[126] Fix | Delete

*

[127] Fix | Delete

* @param array $settings The settings array.

[128] Fix | Delete

*

[129] Fix | Delete

* @return array Settings array with additional settings added.

[130] Fix | Delete

*/

[131] Fix | Delete

public function preload_settings( $settings = array() ) {

[132] Fix | Delete

// We only preload settings in the WP admin.

[133] Fix | Delete

if ( ! is_admin() ) {

[134] Fix | Delete

return $settings;

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

// Reset the received value if the type is invalid.

[138] Fix | Delete

if ( ! is_array( $settings ) ) {

[139] Fix | Delete

$settings = array();

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

// Add the business location country to the settings.

[143] Fix | Delete

if ( ! isset( $settings[ Payments::PAYMENTS_NOX_PROFILE_KEY ] ) ) {

[144] Fix | Delete

$settings[ Payments::PAYMENTS_NOX_PROFILE_KEY ] = array();

[145] Fix | Delete

}

[146] Fix | Delete

$settings[ Payments::PAYMENTS_NOX_PROFILE_KEY ]['business_country_code'] = $this->payments->get_country();

[147] Fix | Delete

[148] Fix | Delete

return $settings;

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* Adds promo note IDs to the list of allowed ones.

[153] Fix | Delete

*

[154] Fix | Delete

* @param array $promo_notes Allowed promo note IDs.

[155] Fix | Delete

*

[156] Fix | Delete

* @return array The updated list of allowed promo note IDs.

[157] Fix | Delete

*/

[158] Fix | Delete

public function add_allowed_promo_notes( $promo_notes = array() ): array {

[159] Fix | Delete

// Reset the value if the type is invalid.

[160] Fix | Delete

if ( ! is_array( $promo_notes ) ) {

[161] Fix | Delete

$promo_notes = array();

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

try {

[165] Fix | Delete

$providers = $this->payments->get_payment_providers( $this->payments->get_country(), false );

[166] Fix | Delete

} catch ( Throwable $e ) {

[167] Fix | Delete

// Catch everything since we don't want to break all the WP admin pages.

[168] Fix | Delete

// Log so we can investigate.

[169] Fix | Delete

SafeGlobalFunctionProxy::wc_get_logger()->error(

[170] Fix | Delete

'Failed to get payment providers: ' . $e->getMessage(),

[171] Fix | Delete

array(

[172] Fix | Delete

'source' => 'settings-payments',

[173] Fix | Delete

)

[174] Fix | Delete

);

[175] Fix | Delete

[176] Fix | Delete

return $promo_notes;

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

// Add all incentive promo IDs to the allowed promo notes list.

[180] Fix | Delete

foreach ( $providers as $provider ) {

[181] Fix | Delete

if ( ! empty( $provider['_incentive']['promo_id'] ) ) {

[182] Fix | Delete

$promo_notes[] = $provider['_incentive']['promo_id'];

[183] Fix | Delete

}

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

return $promo_notes;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* Alter the Payments tab sections under certain conditions.

[191] Fix | Delete

*

[192] Fix | Delete

* @param array $sections The payments/checkout tab sections.

[193] Fix | Delete

*

[194] Fix | Delete

* @return array The filtered sections.

[195] Fix | Delete

*/

[196] Fix | Delete

public function handle_sections( $sections = array() ): array {

[197] Fix | Delete

global $current_section;

[198] Fix | Delete

[199] Fix | Delete

// Reset the value if the type is invalid.

[200] Fix | Delete

if ( ! is_array( $sections ) ) {

[201] Fix | Delete

$sections = array();

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

// Bail if the current section global is empty or of the wrong type.

[205] Fix | Delete

if ( empty( $current_section ) || ! is_string( $current_section ) ) {

[206] Fix | Delete

return $sections;

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

// For WooPayments and offline payment methods settings pages, we don't want any section navigation.

[210] Fix | Delete

if ( in_array( $current_section, array( WooPaymentsService::GATEWAY_ID, WC_Gateway_BACS::ID, WC_Gateway_Cheque::ID, WC_Gateway_COD::ID ), true ) ) {

[211] Fix | Delete

return array();

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

return $sections;

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

/**

[218] Fix | Delete

* Handle the payments extension suggestion incentive dismissed event.

[219] Fix | Delete

*

[220] Fix | Delete

* @return void

[221] Fix | Delete

*/

[222] Fix | Delete

public function handle_incentive_dismissed(): void {

[223] Fix | Delete

// Clear the transient to force a new check for providers with an incentive.

[224] Fix | Delete

delete_transient( self::TRANSIENT_HAS_PROVIDERS_WITH_INCENTIVE_KEY );

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

/**

[228] Fix | Delete

* Check if the store has any enabled gateways (including offline payment methods).

[229] Fix | Delete

*

[230] Fix | Delete

* @return bool True if the store has any enabled gateways, false otherwise.

[231] Fix | Delete

*/

[232] Fix | Delete

private function store_has_enabled_gateways(): bool {

[233] Fix | Delete

$gateways = WC()->payment_gateways->get_available_payment_gateways();

[234] Fix | Delete

$enabled_gateways = array_filter(

[235] Fix | Delete

$gateways,

[236] Fix | Delete

function ( $gateway ) {

[237] Fix | Delete

return 'yes' === $gateway->enabled;

[238] Fix | Delete

}

[239] Fix | Delete

);

[240] Fix | Delete

[241] Fix | Delete

return ! empty( $enabled_gateways );

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

/**

[245] Fix | Delete

* Check if the store has any payment providers that have an active incentive.

[246] Fix | Delete

*

[247] Fix | Delete

* @return bool True if the store has providers with an active incentive.

[248] Fix | Delete

*/

[249] Fix | Delete

private function store_has_providers_with_incentive(): bool {

[250] Fix | Delete

// First, try to use the transient value.

[251] Fix | Delete

$transient = get_transient( self::TRANSIENT_HAS_PROVIDERS_WITH_INCENTIVE_KEY );

[252] Fix | Delete

if ( false !== $transient ) {

[253] Fix | Delete

return filter_var( $transient, FILTER_VALIDATE_BOOLEAN );

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

try {

[257] Fix | Delete

$providers = $this->payments->get_payment_providers( $this->payments->get_country(), false );

[258] Fix | Delete

} catch ( Throwable $e ) {

[259] Fix | Delete

// Catch everything since we don't want to break all the WP admin pages.

[260] Fix | Delete

// Log so we can investigate.

[261] Fix | Delete

SafeGlobalFunctionProxy::wc_get_logger()->error(

[262] Fix | Delete

'Failed to get payment providers: ' . $e->getMessage(),

[263] Fix | Delete

array(

[264] Fix | Delete

'source' => 'settings-payments',

[265] Fix | Delete

)

[266] Fix | Delete

);

[267] Fix | Delete

[268] Fix | Delete

// In case of an error, default to false.

[269] Fix | Delete

// Set the transient to avoid repeated errors.

[270] Fix | Delete

set_transient( self::TRANSIENT_HAS_PROVIDERS_WITH_INCENTIVE_KEY, 'no', HOUR_IN_SECONDS );

[271] Fix | Delete

return false;

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete

$has_providers_with_incentive = false;

[275] Fix | Delete

// Go through the providers and check if any of them have a "prominently" visible incentive (i.e., modal or banner).

[276] Fix | Delete

foreach ( $providers as $provider ) {

[277] Fix | Delete

if ( empty( $provider['_incentive'] ) ) {

[278] Fix | Delete

continue;

[279] Fix | Delete

}

[280] Fix | Delete

[281] Fix | Delete

$dismissals = $provider['_incentive']['_dismissals'] ?? array();

[282] Fix | Delete

[283] Fix | Delete

// If there are no dismissals at all, the incentive is prominently visible.

[284] Fix | Delete

if ( empty( $dismissals ) ) {

[285] Fix | Delete

$has_providers_with_incentive = true;

[286] Fix | Delete

break;

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

// First, we check to see if the incentive was dismissed in the banner context.

[290] Fix | Delete

// The banner context has the lowest priority, so if it was dismissed, we don't need to check the modal context.

[291] Fix | Delete

// If the banner is dismissed, there is no prominent incentive.

[292] Fix | Delete

$is_dismissed_banner = ! empty(

[293] Fix | Delete

array_filter(

[294] Fix | Delete

$dismissals,

[295] Fix | Delete

function ( $dismissal ) {

[296] Fix | Delete

return isset( $dismissal['context'] ) && 'wc_settings_payments__banner' === $dismissal['context'];

[297] Fix | Delete

}

[298] Fix | Delete

)

[299] Fix | Delete

);

[300] Fix | Delete

if ( $is_dismissed_banner ) {

[301] Fix | Delete

continue;

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

// In case an incentive uses the modal surface also (like the WooPayments Switch incentive),

[305] Fix | Delete

// we rely on the fact that the modal falls back to the banner, once dismissed, after 30 days.

[306] Fix | Delete

// @see here's its frontend "brother" in client/admin/client/settings-payments/settings-payments-main.tsx.

[307] Fix | Delete

$is_dismissed_modal = ! empty(

[308] Fix | Delete

array_filter(

[309] Fix | Delete

$dismissals,

[310] Fix | Delete

function ( $dismissal ) {

[311] Fix | Delete

return isset( $dismissal['context'] ) && 'wc_settings_payments__modal' === $dismissal['context'];

[312] Fix | Delete

}

[313] Fix | Delete

)

[314] Fix | Delete

);

[315] Fix | Delete

// If there are no modal dismissals, the incentive is still visible.

[316] Fix | Delete

if ( ! $is_dismissed_modal ) {

[317] Fix | Delete

$has_providers_with_incentive = true;

[318] Fix | Delete

break;

[319] Fix | Delete

}

[320] Fix | Delete

[321] Fix | Delete

$is_dismissed_modal_more_than_30_days_ago = ! empty(

[322] Fix | Delete

array_filter(

[323] Fix | Delete

$dismissals,

[324] Fix | Delete

function ( $dismissal ) {

[325] Fix | Delete

return isset( $dismissal['context'], $dismissal['timestamp'] ) &&

[326] Fix | Delete

'wc_settings_payments__modal' === $dismissal['context'] &&

[327] Fix | Delete

$dismissal['timestamp'] < strtotime( '-30 days' );

[328] Fix | Delete

}

[329] Fix | Delete

)

[330] Fix | Delete

);

[331] Fix | Delete

// If the modal was dismissed less than 30 days ago, there is no prominent incentive (aka the banner is not shown).

[332] Fix | Delete

if ( ! $is_dismissed_modal_more_than_30_days_ago ) {

[333] Fix | Delete

continue;

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

// The modal was dismissed more than 30 days ago, so the banner is visible.

[337] Fix | Delete

$has_providers_with_incentive = true;

[338] Fix | Delete

break;

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

// Save the value in a transient to avoid unnecessary processing throughout the WP admin.

[342] Fix | Delete

// Incentives don't change frequently, so it is safe to cache the value for 1 hour.

[343] Fix | Delete

set_transient( self::TRANSIENT_HAS_PROVIDERS_WITH_INCENTIVE_KEY, $has_providers_with_incentive ? 'yes' : 'no', HOUR_IN_SECONDS );

[344] Fix | Delete

[345] Fix | Delete

return $has_providers_with_incentive;

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

/**

[349] Fix | Delete

* Check if the WooPayments account is onboarded.

[350] Fix | Delete

*

[351] Fix | Delete

* @return boolean

[352] Fix | Delete

*/

[353] Fix | Delete

private function is_woopayments_account_onboarded(): bool {

[354] Fix | Delete

// Sanity check: the WooPayments extension must be active.

[355] Fix | Delete

if ( ! class_exists( '\WC_Payments' ) ) {

[356] Fix | Delete

return false;

[357] Fix | Delete

}

[358] Fix | Delete

[359] Fix | Delete

$account_data = get_option( 'wcpay_account_data', array() );

[360] Fix | Delete

[361] Fix | Delete

// The account ID must be present.

[362] Fix | Delete

if ( empty( $account_data['data']['account_id'] ) ) {

[363] Fix | Delete

return false;

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete

// We consider the store to have an onboarded WooPayments account if account data in the WooPayments account cache

[367] Fix | Delete

// contains a details_submitted = true entry. This implies that WooPayments is also connected.

[368] Fix | Delete

if ( empty( $account_data['data']['details_submitted'] ) ) {

[369] Fix | Delete

return false;

[370] Fix | Delete

}

[371] Fix | Delete

[372] Fix | Delete

return filter_var( $account_data['data']['details_submitted'], FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE ) ?? false;

[373] Fix | Delete

}

[374] Fix | Delete

}

[375] Fix | Delete

[376] Fix | Delete