woocommerce-paypal-payments/modules/ppcp-button/src/Assets/class-smartbutton.php

<?php
/**
 * Registers and configures the necessary Javascript for the button, credit messaging and DCC fields.
 *
 * @package WooCommerce\PayPalCommerce\Button\Assets
 */

declare(strict_types=1);

namespace WooCommerce\PayPalCommerce\Button\Assets;

use WooCommerce\PayPalCommerce\ApiClient\Endpoint\IdentityToken;
use WooCommerce\PayPalCommerce\ApiClient\Factory\PayerFactory;
use WooCommerce\PayPalCommerce\ApiClient\Helper\DccApplies;
use WooCommerce\PayPalCommerce\ApiClient\Repository\PayeeRepository;
use WooCommerce\PayPalCommerce\Button\Endpoint\ApproveOrderEndpoint;
use WooCommerce\PayPalCommerce\Button\Endpoint\ChangeCartEndpoint;
use WooCommerce\PayPalCommerce\Button\Endpoint\CreateOrderEndpoint;
use WooCommerce\PayPalCommerce\Button\Endpoint\DataClientIdEndpoint;
use WooCommerce\PayPalCommerce\Button\Endpoint\RequestData;
use WooCommerce\PayPalCommerce\Button\Helper\MessagesApply;
use WooCommerce\PayPalCommerce\Onboarding\Environment;
use WooCommerce\PayPalCommerce\Session\SessionHandler;
use WooCommerce\PayPalCommerce\Subscription\Helper\SubscriptionHelper;
use WooCommerce\PayPalCommerce\WcGateway\Settings\Settings;

/**
 * Class SmartButton
 */
class SmartButton implements SmartButtonInterface {

	/**
	 * The URL to the module.
	 *
	 * @var string
	 */
	private $module_url;

	/**
	 * The Session Handler.
	 *
	 * @var SessionHandler
	 */
	private $session_handler;

	/**
	 * The settings.
	 *
	 * @var Settings
	 */
	private $settings;

	/**
	 * The Payee Repository.
	 *
	 * @var PayeeRepository
	 */
	private $payee_repository;

	/**
	 * The Identity Token.
	 *
	 * @var IdentityToken
	 */
	private $identity_token;

	/**
	 * The Payer Factory.
	 *
	 * @var PayerFactory
	 */
	private $payer_factory;

	/**
	 * The client ID.
	 *
	 * @var string
	 */
	private $client_id;

	/**
	 * The Request Data.
	 *
	 * @var RequestData
	 */
	private $request_data;

	/**
	 * The DCC Applies helper.
	 *
	 * @var DccApplies
	 */
	private $dcc_applies;

	/**
	 * The Subscription Helper.
	 *
	 * @var SubscriptionHelper
	 */
	private $subscription_helper;

	/**
	 * The Messages apply helper.
	 *
	 * @var MessagesApply
	 */
	private $messages_apply;

	/**
	 * The environment object.
	 *
	 * @var Environment
	 */
	private $environment;

	/**
	 * SmartButton constructor.
	 *
	 * @param string             $module_url The URL to the module.
	 * @param SessionHandler     $session_handler The Session Handler.
	 * @param Settings           $settings The Settings.
	 * @param PayeeRepository    $payee_repository The Payee Repository.
	 * @param IdentityToken      $identity_token The Identity Token.
	 * @param PayerFactory       $payer_factory The Payer factory.
	 * @param string             $client_id The client ID.
	 * @param RequestData        $request_data The Request Data helper.
	 * @param DccApplies         $dcc_applies The DCC applies helper.
	 * @param SubscriptionHelper $subscription_helper The subscription helper.
	 * @param MessagesApply      $messages_apply The Messages apply helper.
	 * @param Environment        $environment The environment object.
	 */
	public function __construct(
		string $module_url,
		SessionHandler $session_handler,
		Settings $settings,
		PayeeRepository $payee_repository,
		IdentityToken $identity_token,
		PayerFactory $payer_factory,
		string $client_id,
		RequestData $request_data,
		DccApplies $dcc_applies,
		SubscriptionHelper $subscription_helper,
		MessagesApply $messages_apply,
		Environment $environment
	) {

		$this->module_url          = $module_url;
		$this->session_handler     = $session_handler;
		$this->settings            = $settings;
		$this->payee_repository    = $payee_repository;
		$this->identity_token      = $identity_token;
		$this->payer_factory       = $payer_factory;
		$this->client_id           = $client_id;
		$this->request_data        = $request_data;
		$this->dcc_applies         = $dcc_applies;
		$this->subscription_helper = $subscription_helper;
		$this->messages_apply      = $messages_apply;
		$this->environment         = $environment;
	}

	/**
	 * Registers the necessary action hooks to render the HTML depending on the settings.
	 *
	 * @return bool
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException When a setting was not found.
	 */
	public function render_wrapper(): bool {

		if ( ! $this->can_save_vault_token() && $this->has_subscriptions() ) {
			return false;
		}

		if ( $this->settings->has( 'enabled' ) && $this->settings->get( 'enabled' ) ) {
			$this->render_button_wrapper_registrar();
			$this->render_message_wrapper_registrar();
		}

		if (
			$this->settings->has( 'dcc_enabled' )
			&& $this->settings->get( 'dcc_enabled' )
			&& ! $this->session_handler->order()
		) {
			add_action(
				'woocommerce_review_order_after_submit',
				array(
					$this,
					'dcc_renderer',
				),
				11
			);

			add_action(
				'woocommerce_pay_order_after_submit',
				array(
					$this,
					'dcc_renderer',
				),
				11
			);
		}
		return true;
	}

	/**
	 * Registers the hooks to render the credit messaging HTML depending on the settings.
	 *
	 * @return bool
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException When a setting was not found.
	 */
	private function render_message_wrapper_registrar(): bool {

		$not_enabled_on_cart = $this->settings->has( 'message_cart_enabled' ) &&
			! $this->settings->get( 'message_cart_enabled' );
		if (
			is_cart()
			&& ! $not_enabled_on_cart
		) {
			add_action(
				'woocommerce_proceed_to_checkout',
				array(
					$this,
					'message_renderer',
				),
				19
			);
		}

		$not_enabled_on_product_page = $this->settings->has( 'message_product_enabled' ) &&
			! $this->settings->get( 'message_product_enabled' );
		if (
			( is_product() || wc_post_content_has_shortcode( 'product_page' ) )
			&& ! $not_enabled_on_product_page
		) {
			add_action(
				'woocommerce_single_product_summary',
				array(
					$this,
					'message_renderer',
				),
				30
			);
		}

		$not_enabled_on_checkout = $this->settings->has( 'message_enabled' ) &&
			! $this->settings->get( 'message_enabled' );
		if ( ! $not_enabled_on_checkout ) {
			add_action(
				'woocommerce_review_order_after_submit',
				array(
					$this,
					'message_renderer',
				),
				11
			);
			add_action(
				'woocommerce_pay_order_after_submit',
				array(
					$this,
					'message_renderer',
				),
				11
			);
		}
		return true;
	}

	/**
	 * Registers the hooks where to render the button HTML according to the settings.
	 *
	 * @return bool
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException When a setting was not found.
	 */
	private function render_button_wrapper_registrar(): bool {

		$not_enabled_on_cart = $this->settings->has( 'button_cart_enabled' ) &&
			! $this->settings->get( 'button_cart_enabled' );
		if (
			is_cart()
			&& ! $not_enabled_on_cart
		) {
			add_action(
				'woocommerce_proceed_to_checkout',
				array(
					$this,
					'button_renderer',
				),
				20
			);
		}

		$not_enabled_on_product_page = $this->settings->has( 'button_single_product_enabled' ) &&
			! $this->settings->get( 'button_single_product_enabled' );
		if (
			( is_product() || wc_post_content_has_shortcode( 'product_page' ) )
			&& ! $not_enabled_on_product_page
		) {
			add_action(
				'woocommerce_single_product_summary',
				array(
					$this,
					'button_renderer',
				),
				31
			);
		}

		$not_enabled_on_minicart = $this->settings->has( 'button_mini_cart_enabled' ) &&
			! $this->settings->get( 'button_mini_cart_enabled' );
		if (
			! $not_enabled_on_minicart
		) {
			add_action(
				'woocommerce_widget_shopping_cart_after_buttons',
				static function () {
					echo '<p
                                id="ppc-button-minicart"
                                class="woocommerce-mini-cart__buttons buttons"
                          ></p>';
				},
				30
			);
		}

		add_action( 'woocommerce_review_order_after_submit', array( $this, 'button_renderer' ), 10 );
		add_action( 'woocommerce_pay_order_after_submit', array( $this, 'button_renderer' ), 10 );

		return true;
	}

	/**
	 * Enqueues the script.
	 *
	 * @return bool
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException When a setting was not found.
	 */
	public function enqueue(): bool {
		$buttons_enabled = $this->settings->has( 'enabled' ) && $this->settings->get( 'enabled' );
		if ( ! is_checkout() && ! $buttons_enabled ) {
			return false;
		}
		if ( ! $this->can_save_vault_token() && $this->has_subscriptions() ) {
			return false;
		}

		$load_script = false;
		if ( is_checkout() && $this->settings->has( 'dcc_enabled' ) && $this->settings->get( 'dcc_enabled' ) ) {
			$load_script = true;
		}
		if ( $this->load_button_component() ) {
			$load_script = true;
		}

		if ( in_array( $this->context(), array( 'pay-now', 'checkout' ), true ) && $this->can_render_dcc() ) {
			wp_enqueue_style(
				'ppcp-hosted-fields',
				$this->module_url . '/assets/css/hosted-fields.css',
				array(),
				1
			);
		}
		if ( $load_script ) {
			wp_enqueue_script(
				'ppcp-smart-button',
				$this->module_url . '/assets/js/button.js',
				array( 'jquery' ),
				1,
				true
			);

			wp_localize_script(
				'ppcp-smart-button',
				'PayPalCommerceGateway',
				$this->localize_script()
			);
		}
		return true;
	}

	/**
	 * Renders the HTML for the buttons.
	 */
	public function button_renderer() {
		$product = wc_get_product();
		if (
			! is_checkout() && is_a( $product, \WC_Product::class )
			&& (
				$product->is_type( array( 'external', 'grouped' ) )
				|| ! $product->is_in_stock()
			)
		) {
			return;
		}

		echo '<div id="ppc-button"></div>';
	}

	/**
	 * Renders the HTML for the credit messaging.
	 */
	public function message_renderer() {

		echo '<div id="ppcp-messages"></div>';
	}

	/**
	 * The values for the credit messaging.
	 *
	 * @return array
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException When a setting was not found.
	 */
	private function message_values(): array {

		if (
			$this->settings->has( 'disable_funding' )
			&& in_array( 'credit', (array) $this->settings->get( 'disable_funding' ), true )
		) {
			return array();
		}
		$placement     = 'product';
		$product       = wc_get_product();
		$amount        = ( is_a( $product, \WC_Product::class ) ) ? wc_get_price_including_tax( $product ) : 0;
		$layout        = $this->settings->has( 'message_product_layout' ) ?
			$this->settings->get( 'message_product_layout' ) : 'text';
		$logo_type     = $this->settings->has( 'message_product_logo' ) ?
			$this->settings->get( 'message_product_logo' ) : 'primary';
		$logo_position = $this->settings->has( 'message_product_position' ) ?
			$this->settings->get( 'message_product_position' ) : 'left';
		$text_color    = $this->settings->has( 'message_product_color' ) ?
			$this->settings->get( 'message_product_color' ) : 'black';
		$style_color   = $this->settings->has( 'message_product_flex_color' ) ?
			$this->settings->get( 'message_product_flex_color' ) : 'blue';
		$ratio         = $this->settings->has( 'message_product_flex_ratio' ) ?
			$this->settings->get( 'message_product_flex_ratio' ) : '1x1';
		$should_show   = $this->settings->has( 'message_product_enabled' )
			&& $this->settings->get( 'message_product_enabled' );
		if ( is_checkout() ) {
			$placement     = 'payment';
			$amount        = WC()->cart->get_total( 'raw' );
			$layout        = $this->settings->has( 'message_layout' ) ?
				$this->settings->get( 'message_layout' ) : 'text';
			$logo_type     = $this->settings->has( 'message_logo' ) ?
				$this->settings->get( 'message_logo' ) : 'primary';
			$logo_position = $this->settings->has( 'message_position' ) ?
				$this->settings->get( 'message_position' ) : 'left';
			$text_color    = $this->settings->has( 'message_color' ) ?
				$this->settings->get( 'message_color' ) : 'black';
			$style_color   = $this->settings->has( 'message_flex_color' ) ?
				$this->settings->get( 'message_flex_color' ) : 'blue';
			$ratio         = $this->settings->has( 'message_flex_ratio' ) ?
				$this->settings->get( 'message_flex_ratio' ) : '1x1';
			$should_show   = $this->settings->has( 'message_enabled' )
				&& $this->settings->get( 'message_enabled' );
		}
		if ( is_cart() ) {
			$placement     = 'cart';
			$amount        = WC()->cart->get_total( 'raw' );
			$layout        = $this->settings->has( 'message_cart_layout' ) ?
				$this->settings->get( 'message_cart_layout' ) : 'text';
			$logo_type     = $this->settings->has( 'message_cart_logo' ) ?
				$this->settings->get( 'message_cart_logo' ) : 'primary';
			$logo_position = $this->settings->has( 'message_cart_position' ) ?
				$this->settings->get( 'message_cart_position' ) : 'left';
			$text_color    = $this->settings->has( 'message_cart_color' ) ?
				$this->settings->get( 'message_cart_color' ) : 'black';
			$style_color   = $this->settings->has( 'message_cart_flex_color' ) ?
				$this->settings->get( 'message_cart_flex_color' ) : 'blue';
			$ratio         = $this->settings->has( 'message_cart_flex_ratio' ) ?
				$this->settings->get( 'message_cart_flex_ratio' ) : '1x1';
			$should_show   = $this->settings->has( 'message_cart_enabled' )
				&& $this->settings->get( 'message_cart_enabled' );
		}

		if ( ! $should_show ) {
			return array();
		}

		$values = array(
			'wrapper'   => '#ppcp-messages',
			'amount'    => $amount,
			'placement' => $placement,
			'style'     => array(
				'layout' => $layout,
				'logo'   => array(
					'type'     => $logo_type,
					'position' => $logo_position,
				),
				'text'   => array(
					'color' => $text_color,
				),
				'color'  => $style_color,
				'ratio'  => $ratio,
			),
		);

		return $values;
	}

	/**
	 * Whether DCC fields can be rendered.
	 *
	 * @return bool
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException When a setting was not found.
	 */
	private function can_render_dcc() : bool {

		$can_render = $this->settings->has( 'dcc_enabled' ) && $this->settings->get( 'dcc_enabled' ) && $this->settings->has( 'client_id' ) && $this->settings->get( 'client_id' ) && $this->dcc_applies->for_country_currency();
		return $can_render;
	}

	/**
	 * Renders the HTML for the DCC fields.
	 */
	public function dcc_renderer() {

		$id = 'ppcp-hosted-fields';
		if ( ! $this->can_render_dcc() ) {
			return;
		}

		$save_card = $this->can_save_credit_card() ? sprintf(
			'<div>

                <label for="ppcp-vault-%1$s">%2$s</label>
                <input
                    type="checkbox"
                    id="ppcp-vault-%1$s"
                    class="ppcp-credit-card-vault"
                    name="vault"
                >
            </div>',
			esc_attr( $id ),
			esc_html__( 'Save your card', 'woocommerce-paypal-payments' )
		) : '';

		$label = 'checkout' === $this->context() ? __( 'Place order', 'woocommerce-paypal-payments' ) : __( 'Pay for order', 'woocommerce-paypal-payments' );

		printf(
			'<div id="%1$s" style="display:none;">
                        <button class="button alt">%3$s</button>
                        %2$s
                    </div><div id="payments-sdk__contingency-lightbox"></div><style id="ppcp-hide-dcc">.payment_method_ppcp-credit-card-gateway {display:none;}</style>',
			esc_attr( $id ),
            //phpcs:ignore
            $save_card,
			esc_html( $label )
		);
	}

	/**
	 * Whether we can store vault tokens or not.
	 *
	 * @return bool
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException If a setting hasnt been found.
	 */
	public function can_save_vault_token(): bool {

		if ( ! $this->settings->has( 'client_id' ) || ! $this->settings->get( 'client_id' ) ) {
			return false;
		}
		if ( ! $this->settings->has( 'vault_enabled' ) || ! $this->settings->get( 'vault_enabled' ) ) {
			return false;
		}
		return is_user_logged_in();
	}

	private function can_save_credit_card() {
		if ( ! $this->settings->has( 'client_id' ) || ! $this->settings->get( 'client_id' ) ) {
			return false;
		}
		if ( ! $this->settings->has( 'dcc_save_card' ) || ! $this->settings->get( 'dcc_save_card' ) ) {
			return false;
		}
		return is_user_logged_in();
	}


	/**
	 * Whether we need to initialize the script to enable tokenization for subscriptions or not.
	 *
	 * @return bool
	 */
	private function has_subscriptions(): bool {
		if ( ! $this->subscription_helper->accept_only_automatic_payment_gateways() ) {
			return false;
		}
		if ( is_product() ) {
			return $this->subscription_helper->current_product_is_subscription();
		}
		return $this->subscription_helper->cart_contains_subscription();
	}

	/**
	 * The localized data for the smart button.
	 *
	 * @return array
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException If a setting hasn't been found.
	 */
	private function localize_script(): array {
		global $wp;

		$this->request_data->enqueue_nonce_fix();
		$localize = array(
			'script_attributes' => $this->attributes(),
			'data_client_id'    => array(
				'set_attribute'       => ( is_checkout() && $this->dcc_is_enabled() )
					|| $this->can_save_vault_token(),
				'save_paypal_account' => $this->save_paypal_account(),
				'endpoint'            => home_url( \WC_AJAX::get_endpoint( DataClientIdEndpoint::ENDPOINT ) ),
				'nonce'               => wp_create_nonce( DataClientIdEndpoint::nonce() ),
				'user'                => get_current_user_id(),
			),
			'redirect'          => wc_get_checkout_url(),
			'context'           => $this->context(),
			'ajax'              => array(
				'change_cart'   => array(
					'endpoint' => home_url( \WC_AJAX::get_endpoint( ChangeCartEndpoint::ENDPOINT ) ),
					'nonce'    => wp_create_nonce( ChangeCartEndpoint::nonce() ),
				),
				'create_order'  => array(
					'endpoint' => home_url( \WC_AJAX::get_endpoint( CreateOrderEndpoint::ENDPOINT ) ),
					'nonce'    => wp_create_nonce( CreateOrderEndpoint::nonce() ),
				),
				'approve_order' => array(
					'endpoint' => home_url( \WC_AJAX::get_endpoint( ApproveOrderEndpoint::ENDPOINT ) ),
					'nonce'    => wp_create_nonce( ApproveOrderEndpoint::nonce() ),
				),
			),
			'enforce_vault'     => $this->has_subscriptions(),
			'bn_codes'          => $this->bn_codes(),
			'payer'             => $this->payerData(),
			'button'            => array(
				'wrapper'           => '#ppc-button',
				'mini_cart_wrapper' => '#ppc-button-minicart',
				'cancel_wrapper'    => '#ppcp-cancel',
				'url'               => $this->url(),
				'mini_cart_style'   => array(
					'layout'  => $this->style_for_context( 'layout', 'mini-cart' ),
					'color'   => $this->style_for_context( 'color', 'mini-cart' ),
					'shape'   => $this->style_for_context( 'shape', 'mini-cart' ),
					'label'   => $this->style_for_context( 'label', 'mini-cart' ),
					'tagline' => $this->style_for_context( 'tagline', 'mini-cart' ),
				),
				'style'             => array(
					'layout'  => $this->style_for_context( 'layout', $this->context() ),
					'color'   => $this->style_for_context( 'color', $this->context() ),
					'shape'   => $this->style_for_context( 'shape', $this->context() ),
					'label'   => $this->style_for_context( 'label', $this->context() ),
					'tagline' => $this->style_for_context( 'tagline', $this->context() ),
				),
			),
			'hosted_fields'     => array(
				'wrapper'           => '#ppcp-hosted-fields',
				'mini_cart_wrapper' => '#ppcp-hosted-fields-mini-cart',
				'labels'            => array(
					'credit_card_number' => '',
					'cvv'                => '',
					'mm_yyyy'            => __( 'MM/YYYY', 'woocommerce-paypal-payments' ),
					'fields_not_valid'   => __(
						'Unfortunatly, your credit card details are not valid.',
						'woocommerce-paypal-payments'
					),
					'card_not_supported' => __(
						'Unfortunatly, we do not support your credit card.',
						'woocommerce-paypal-payments'
					),
				),
				'valid_cards'       => $this->dcc_applies->valid_cards(),
			),
			'messages'          => $this->message_values(),
			'labels'            => array(
				'error' => array(
					'generic' => __(
						'Something went wrong. Please try again or choose another payment source.',
						'woocommerce-paypal-payments'
					),
				),
			),
			'order_id'          => 'pay-now' === $this->context() ? absint( $wp->query_vars['order-pay'] ) : 0,
		);

		if ( $this->style_for_context( 'layout', 'mini-cart' ) !== 'horizontal' ) {
			unset( $localize['button']['mini_cart_style']['tagline'] );
		}
		if ( $this->style_for_context( 'layout', $this->context() ) !== 'horizontal' ) {
			unset( $localize['button']['style']['tagline'] );
		}

		$this->request_data->dequeue_nonce_fix();
		return $localize;
	}

	/**
	 * If we can find the payer data for a current customer, we will return it.
	 *
	 * @return array|null
	 */
	private function payerData() {

		$customer = WC()->customer;
		if ( ! is_user_logged_in() || ! is_a( $customer, \WC_Customer::class ) ) {
			return null;
		}
		return $this->payer_factory->from_customer( $customer )->to_array();
	}

	/**
	 * The JavaScript SDK url to load.
	 *
	 * @return string
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException If a setting was not found.
	 */
	private function url(): string {
		$params = array(
			'client-id'        => $this->client_id,
			'currency'         => get_woocommerce_currency(),
			'locale'           => get_user_locale(),
			'integration-date' => PAYPAL_INTEGRATION_DATE,
			'components'       => implode( ',', $this->components() ),
			'vault'            => $this->can_save_vault_token() ?
				'true' : 'false',
			'commit'           => is_checkout() ? 'true' : 'false',
			'intent'           => ( $this->settings->has( 'intent' ) ) ?
				$this->settings->get( 'intent' ) : 'capture',
		);
		if (
			$this->environment->current_environment_is( Environment::SANDBOX )
			&& defined( 'WP_DEBUG' ) && \WP_DEBUG && is_user_logged_in()
			&& WC()->customer && WC()->customer->get_billing_country()
			&& 2 === strlen( WC()->customer->get_billing_country() )
		) {
			$params['buyer-country'] = WC()->customer->get_billing_country();
		}
		$payee = $this->payee_repository->payee();
		if ( $payee->merchant_id() ) {
			$params['merchant-id'] = $payee->merchant_id();
		}
		$disable_funding   = $this->settings->has( 'disable_funding' ) ?
			$this->settings->get( 'disable_funding' ) : array();
		$disable_funding[] = 'venmo';
		if ( ! is_checkout() ) {
			$disable_funding[] = 'card';
		}

		/**
		 * Disable card for UK.
		 */
		$region  = wc_get_base_location();
		$country = $region['country'];
		if ( 'GB' === $country ) {
			$disable_funding[] = 'credit';
		}
		$params['disable-funding'] = implode( ',', array_unique( $disable_funding ) );

		$smart_button_url = add_query_arg( $params, 'https://www.paypal.com/sdk/js' );
		return $smart_button_url;
	}

	/**
	 * The attributes we need to load for the JS SDK.
	 *
	 * @return array
	 */
	private function attributes(): array {
		return array(
			'data-partner-attribution-id' => $this->bn_code_for_context( $this->context() ),
		);
	}

	/**
	 * What BN Code to use in a given context.
	 *
	 * @param string $context The context.
	 * @return string
	 */
	private function bn_code_for_context( string $context ): string {

		$codes = $this->bn_codes();
		return ( isset( $codes[ $context ] ) ) ? $codes[ $context ] : '';
	}

	/**
	 * BN Codes to use.
	 *
	 * @return array
	 */
	private function bn_codes(): array {

		return array(
			'checkout'  => 'Woo_PPCP',
			'cart'      => 'Woo_PPCP',
			'mini-cart' => 'Woo_PPCP',
			'product'   => 'Woo_PPCP',
		);
	}

	/**
	 * The JS SKD components we need to load.
	 *
	 * @return array
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException If a setting was not found.
	 */
	private function components(): array {
		$components = array();

		if ( $this->load_button_component() ) {
			$components[] = 'buttons';
		}
		if ( $this->messages_apply->for_country() ) {
			$components[] = 'messages';
		}
		if ( $this->dcc_is_enabled() ) {
			$components[] = 'hosted-fields';
		}
		return $components;
	}

	/**
	 * Determines whether the button component should be loaded.
	 *
	 * @return bool
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException If a setting has not been found.
	 */
	private function load_button_component() : bool {

		$load_buttons = false;
		if (
			$this->context() === 'checkout'
			&& $this->settings->has( 'button_enabled' )
			&& $this->settings->get( 'button_enabled' )
		) {
			$load_buttons = true;
		}
		if (
			$this->context() === 'product'
			&& $this->settings->has( 'button_product_enabled' )
			&& $this->settings->get( 'button_product_enabled' )
		) {
			$load_buttons = true;
		}
		if (
			$this->settings->has( 'button_mini-cart_enabled' )
			&& $this->settings->get( 'button_mini-cart_enabled' )
		) {
			$load_buttons = true;
		}
		if (
			$this->context() === 'cart'
			&& $this->settings->has( 'button_cart_enabled' )
			&& $this->settings->get( 'button_cart_enabled' )
		) {
			$load_buttons = true;
		}
		if ( $this->context() === 'pay-now' ) {
			$load_buttons = true;
		}

		return $load_buttons;
	}

	/**
	 * The current context.
	 *
	 * @return string
	 */
	private function context(): string {
		$context = 'mini-cart';
		if ( is_product() || wc_post_content_has_shortcode( 'product_page' ) ) {
			$context = 'product';
		}
		if ( is_cart() ) {
			$context = 'cart';
		}
		if ( is_checkout() && ! $this->session_handler->order() ) {
			$context = 'checkout';
		}
		if ( is_checkout_pay_page() ) {
			$context = 'pay-now';
		}
		return $context;
	}

	/**
	 * Whether DCC is enabled or not.
	 *
	 * @return bool
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException If a setting has not been found.
	 */
	private function dcc_is_enabled(): bool {
		if ( ! is_checkout() ) {
			return false;
		}
		if ( ! $this->dcc_applies->for_country_currency() ) {
			return false;
		}
		$keys = array(
			'client_id',
			'client_secret',
			'dcc_enabled',
		);
		foreach ( $keys as $key ) {
			if ( ! $this->settings->has( $key ) || ! $this->settings->get( $key ) ) {
				return false;
			}
		}
		return true;
	}

	private function save_paypal_account(): bool {
		if ( ! $this->settings->has( 'save_paypal_account' ) || ! $this->settings->get( 'save_paypal_account' ) ) {
			return false;
		}
		return true;
	}

	/**
	 * Determines the style for a given indicator in a given context.
	 *
	 * @param string $style The style.
	 * @param string $context The context.
	 *
	 * @return string
	 * @throws \WooCommerce\PayPalCommerce\WcGateway\Exception\NotFoundException When a setting hasn't been found.
	 */
	private function style_for_context( string $style, string $context ): string {
		$defaults = array(
			'layout'  => 'vertical',
			'size'    => 'responsive',
			'color'   => 'gold',
			'shape'   => 'pill',
			'label'   => 'paypal',
			'tagline' => true,
		);

		$value = isset( $defaults[ $style ] ) ?
			$defaults[ $style ] : '';
		$value = $this->settings->has( 'button_' . $style ) ?
			$this->settings->get( 'button_' . $style ) : $value;
		$value = $this->settings->has( 'button_' . $context . '_' . $style ) ?
			$this->settings->get( 'button_' . $context . '_' . $style ) : $value;

		if ( is_bool( $value ) ) {
			$value = $value ? 'true' : 'false';
		}
		return (string) $value;
	}
}