<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* BlackboxScriptHandler class file.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

declare( strict_types=1 );

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Internal\FraudProtection;

[7] Fix | Delete

[8] Fix | Delete

use Automattic\Jetpack\Constants;

[9] Fix | Delete

[10] Fix | Delete

defined( 'ABSPATH' ) || exit;

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Handles loading Blackbox JS telemetry script on payment method pages.

[14] Fix | Delete

*

[15] Fix | Delete

* Enqueues the external Blackbox JS SDK and a small initialization script

[16] Fix | Delete

* on checkout, pay-for-order, and add-payment-method pages. The init script

[17] Fix | Delete

* calls Blackbox.configure() with the site's API key and Jetpack blog ID.

[18] Fix | Delete

*

[19] Fix | Delete

* @since 10.6.0

[20] Fix | Delete

* @internal This class is part of the internal API and is subject to change without notice.

[21] Fix | Delete

*/

[22] Fix | Delete

class BlackboxScriptHandler {

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Blackbox JS SDK URL.

[26] Fix | Delete

*/

[27] Fix | Delete

private const BLACKBOX_JS_URL = 'https://blackbox-api.wp.com/v1/dist/v.js';

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* API key identifying WooCommerce as a Blackbox client.

[31] Fix | Delete

*/

[32] Fix | Delete

private const API_KEY = 'woocommerce';

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Register hooks for Blackbox script loading.

[36] Fix | Delete

*

[37] Fix | Delete

* Called from FraudProtectionController::on_init() which already checks

[38] Fix | Delete

* if the feature is enabled.

[39] Fix | Delete

*

[40] Fix | Delete

* @return void

[41] Fix | Delete

*/

[42] Fix | Delete

public function register(): void {

[43] Fix | Delete

add_action( 'wp_enqueue_scripts', array( $this, 'maybe_enqueue_scripts' ) );

[44] Fix | Delete

}

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Conditionally enqueue Blackbox scripts on payment method pages.

[48] Fix | Delete

*

[49] Fix | Delete

* Loads scripts on checkout (including custom pages with the checkout block),

[50] Fix | Delete

* pay-for-order, and add-payment-method pages.

[51] Fix | Delete

* Extensions can use the `woocommerce_fraud_protection_enqueue_blackbox_scripts`

[52] Fix | Delete

* filter to load scripts on additional pages (e.g., product pages for express payments).

[53] Fix | Delete

*

[54] Fix | Delete

* @return void

[55] Fix | Delete

*/

[56] Fix | Delete

public function maybe_enqueue_scripts(): void {

[57] Fix | Delete

global $wp;

[58] Fix | Delete

[59] Fix | Delete

$should_enqueue = is_checkout() ||

[60] Fix | Delete

has_block( 'woocommerce/checkout' ) ||

[61] Fix | Delete

is_checkout_pay_page() ||

[62] Fix | Delete

// Check add-payment-method query_var to avoid loading on regular payment methods page.

[63] Fix | Delete

( is_add_payment_method_page() && isset( $wp->query_vars['add-payment-method'] ) );

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Filter whether to enqueue Blackbox fraud protection scripts on the current page.

[67] Fix | Delete

*

[68] Fix | Delete

* By default, scripts are loaded on checkout, pay-for-order, and add-payment-method pages.

[69] Fix | Delete

* Extensions can return true to load scripts on additional pages where payment methods

[70] Fix | Delete

* are rendered (e.g., product pages for express checkout buttons).

[71] Fix | Delete

*

[72] Fix | Delete

* @since 10.6.0

[73] Fix | Delete

*

[74] Fix | Delete

* @param bool $should_enqueue Whether to enqueue Blackbox scripts on the current page.

[75] Fix | Delete

*/

[76] Fix | Delete

$should_enqueue = (bool) apply_filters( 'woocommerce_fraud_protection_enqueue_blackbox_scripts', $should_enqueue );

[77] Fix | Delete

[78] Fix | Delete

if ( ! $should_enqueue ) {

[79] Fix | Delete

return;

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

$blog_id = $this->get_blog_id();

[83] Fix | Delete

[84] Fix | Delete

if ( ! $blog_id ) {

[85] Fix | Delete

FraudProtectionController::log(

[86] Fix | Delete

'error',

[87] Fix | Delete

'Blackbox scripts not loaded: Jetpack blog ID not available. Is the site connected to Jetpack?'

[88] Fix | Delete

);

[89] Fix | Delete

return;

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

$this->enqueue_scripts( $blog_id );

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Enqueue the Blackbox SDK and initialization scripts.

[97] Fix | Delete

*

[98] Fix | Delete

* @param int $blog_id The Jetpack blog ID.

[99] Fix | Delete

* @return void

[100] Fix | Delete

*/

[101] Fix | Delete

private function enqueue_scripts( int $blog_id ): void {

[102] Fix | Delete

wp_enqueue_script(

[103] Fix | Delete

'wc-fraud-protection-blackbox',

[104] Fix | Delete

self::BLACKBOX_JS_URL,

[105] Fix | Delete

array(),

[106] Fix | Delete

null, // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion -- External SDK, version managed by Blackbox CDN.

[107] Fix | Delete

array( 'in_footer' => true )

[108] Fix | Delete

);

[109] Fix | Delete

[110] Fix | Delete

$suffix = Constants::is_true( 'SCRIPT_DEBUG' ) ? '' : '.min';

[111] Fix | Delete

[112] Fix | Delete

// Enqueue the Woo Fraud Protection init script.

[113] Fix | Delete

wp_enqueue_script(

[114] Fix | Delete

'wc-fraud-protection-blackbox-init',

[115] Fix | Delete

plugins_url( 'assets/js/frontend/fraud-protection/blackbox-init' . $suffix . '.js', WC_PLUGIN_FILE ),

[116] Fix | Delete

array( 'wc-fraud-protection-blackbox' ),

[117] Fix | Delete

WC_VERSION,

[118] Fix | Delete

array( 'in_footer' => true )

[119] Fix | Delete

);

[120] Fix | Delete

[121] Fix | Delete

wp_localize_script(

[122] Fix | Delete

'wc-fraud-protection-blackbox-init',

[123] Fix | Delete

'wcBlackboxConfig',

[124] Fix | Delete

array(

[125] Fix | Delete

'apiKey' => self::API_KEY,

[126] Fix | Delete

'blogId' => $blog_id,

[127] Fix | Delete

)

[128] Fix | Delete

);

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

/**

[132] Fix | Delete

* Get the Jetpack blog ID.

[133] Fix | Delete

*

[134] Fix | Delete

* @return int|false Blog ID or false if not available.

[135] Fix | Delete

*/

[136] Fix | Delete

private function get_blog_id() {

[137] Fix | Delete

if ( ! class_exists( \Jetpack_Options::class ) ) {

[138] Fix | Delete

return false;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

$blog_id = \Jetpack_Options::get_option( 'id' );

[142] Fix | Delete

[143] Fix | Delete

if ( ! is_numeric( $blog_id ) || (int) $blog_id <= 0 ) {

[144] Fix | Delete

return false;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

return (int) $blog_id;

[148] Fix | Delete

}

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete