<?php
/**
 * ADOBE CONFIDENTIAL
 *
 * Copyright 2023 Adobe
 * All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains
 * the property of Adobe and its suppliers, if any. The intellectual
 * and technical concepts contained herein are proprietary to Adobe
 * and its suppliers and are protected by all applicable intellectual
 * property laws, including trade secret and copyright laws.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe.
 */

declare(strict_types=1);

namespace Magento\PaymentServicesPaypal\Helper;

use Magento\Framework\App\Response\RedirectInterface;
use Magento\Framework\Exception\AlreadyExistsException;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\UrlInterface;
use Magento\PaymentServicesPaypal\Model\Config;
use Magento\PaymentServicesPaypal\Model\HostedFieldsConfigProvider;
use Magento\Quote\Api\Data\CartInterface;
use Magento\Quote\Model\Quote;
use Magento\Quote\Model\QuoteIdMaskFactory;
use Magento\Quote\Model\ResourceModel\Quote\QuoteIdMask;
use Psr\Log\LoggerInterface;
use Random\RandomException;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class OrderHelper
{
    /**
     * Payment sources that require L2/L3 data
     */
    private const L2_L3_PAYMENT_SOURCES = [
        HostedFieldsConfigProvider::CC_SOURCE,
        HostedFieldsConfigProvider::VAULT_SOURCE
    ];

    /**
     * User action for PayPal smart buttons
     */
    private const USER_ACTION = 'PAY_NOW';

    /**
     * @param L2DataProvider $l2DataProvider
     * @param L3DataProvider $l3DataProvider
     * @param LineItemsProvider $lineItemsProvider
     * @param Config $config
     * @param LoggerInterface $logger
     * @param QuoteIdMaskFactory $quoteIdMaskFactory
     * @param QuoteIdMask $quoteIdMaskResource
     * @param UrlInterface $urlBuilder
     * @param RedirectInterface $redirect
     */
    public function __construct(
        private readonly L2DataProvider $l2DataProvider,
        private readonly L3DataProvider $l3DataProvider,
        private readonly LineItemsProvider $lineItemsProvider,
        private readonly Config $config,
        private readonly LoggerInterface $logger,
        private readonly QuoteIdMaskFactory $quoteIdMaskFactory,
        private readonly QuoteIdMask $quoteIdMaskResource,
        private readonly UrlInterface $urlBuilder,
        private readonly RedirectInterface $redirect
    ) {
    }

    /**
     * Format the amount with two decimal places
     *
     * @param float $amount
     * @return string
     */
    public function formatAmount(float $amount): string
    {
        return number_format((float)$amount, 2, '.', '');
    }

    /**
     * Get L2 data for the given cart
     *
     * Only certain payment sources support L2 data
     *
     * @param Quote $quote
     * @param string $paymentSource
     * @return array
     */
    public function getL2Data(Quote $quote, string $paymentSource): array
    {
        return $this->isL2L3DataApplicable($paymentSource)
            ? $this->l2DataProvider->getL2Data($quote)
            : [];
    }

    /**
     * Get L3 data for the given cart
     *
     * Only certain payment sources support L3 data
     *
     * @param Quote $quote
     * @param string $paymentSource
     * @return array
     */
    public function getL3Data(Quote $quote, string $paymentSource): array
    {
        return $this->isL2L3DataApplicable($paymentSource)
            ? $this->l3DataProvider->getL3Data($quote)
            : [];
    }

    /**
     * Reserve and get the order increment ID
     *
     * @param Quote $quote
     * @return string
     */
    public function reserveAndGetOrderIncrementId(Quote $quote): string
    {
        $quote->reserveOrderId();
        return $quote->getReservedOrderId();
    }

    /**
     * Get line items information for the given cart
     *
     * If the configuration is disabled or if the line items total does not match the quote subtotal and tax amount
     * return an empty array to avoid validation error when updating the order in Paypal
     *
     * @param Quote $quote
     * @param string $orderIncrementId
     * @return array
     */
    public function getLineItems(Quote $quote, string $orderIncrementId): array
    {
        if (!$this->config->isSendLineItemsEnabled((int)$quote->getStoreId())) {
            return [];
        }

        $lineItems = $this->lineItemsProvider->getLineItems($quote);

        if ($this->hasLineItemsAmountMismatch($lineItems, $quote, $orderIncrementId)) {
            return [];
        }

        return $lineItems;
    }

    /**
     * Get amount breakdown for the given cart
     *
     * If the configuration is disabled or if the amount breakdown total does not match the quote grand total
     * return an empty array to avoid validation error when updating the order in Paypal
     *
     * @param Quote $quote
     * @param string $orderIncrementId
     * @return array
     */
    public function getAmountBreakdown(Quote $quote, string $orderIncrementId): array
    {
        if (!$this->config->isSendLineItemsEnabled((int)$quote->getStoreId())) {
            return [];
        }

        $address = $this->getQuoteAddress($quote);

        $baseSubtotal = (float)$quote->getBaseSubtotal();
        $shippingAmount = (float)$address->getBaseShippingAmount() + (float)$address->getBaseShippingTaxAmount();
        $taxAmount = (float)$address->getBaseTaxAmount() - (float)$address->getBaseShippingTaxAmount();
        $discountAmount = (float)$address->getBaseDiscountAmount();

        if ($this->hasBreakdownAmountMismatch(
            $baseSubtotal,
            $shippingAmount,
            $taxAmount,
            $discountAmount,
            (float)$quote->getBaseGrandTotal(),
            $orderIncrementId
        )) {
            return [];
        }

        return [
            'item_total' => [
                'value' => $this->formatAmount($baseSubtotal),
                'currency_code' => $quote->getCurrency()->getBaseCurrencyCode()
            ],
            'shipping' => [
                'value' => $this->formatAmount($shippingAmount),
                'currency_code' => $quote->getCurrency()->getBaseCurrencyCode()
            ],
            'tax_total' => [
                'value' => $this->formatAmount($taxAmount),
                'currency_code' => $quote->getCurrency()->getBaseCurrencyCode()
            ],
            'discount' => [
                'value' => $this->formatAmount(abs($discountAmount)),
                'currency_code' => $quote->getCurrency()->getBaseCurrencyCode()
            ]
        ];
    }

    /**
     * Check if L2/L3 data are applicable to the order
     *
     * @param string $paymentSource
     * @return bool
     */
    private function isL2L3DataApplicable(string $paymentSource): bool
    {
        return $this->config->isL2L3SendDataEnabled() && $this->isSupportedPaymentSource($paymentSource);
    }

    /**
     * Check if the payment source supports L2/L3 data
     *
     * @param string $paymentSource
     * @return bool
     */
    private function isSupportedPaymentSource(string $paymentSource): bool
    {
        return in_array($paymentSource, self::L2_L3_PAYMENT_SOURCES);
    }

    /**
     * Get the quote address
     *
     * @param Quote $quote
     * @return Quote\Address
     */
    private function getQuoteAddress(Quote $quote): Quote\Address
    {
        $address = $quote->getShippingAddress();
        if ($quote->isVirtual()) {
            $address = $quote->getBillingAddress();
        }

        return $address;
    }

    /**
     * Check if the line items total matches the quote subtotal and tax amount
     *
     * @param array $lineItems
     * @param Quote $quote
     * @param string $orderIncrementId
     * @return bool
     */
    private function hasLineItemsAmountMismatch(array $lineItems, Quote $quote, string $orderIncrementId): bool
    {
        $itemTotal = 0;
        $taxTotal = 0;

        foreach ($lineItems as $lineItem) {
            $itemTotal += $this->lineItemsProvider->toCents((float)$lineItem['unit_amount']['value'])
                * (int)$lineItem['quantity'];

            $taxTotal += $this->lineItemsProvider->toCents((float)$lineItem['tax']['value'])
                * (int)$lineItem['quantity'];
        }

        $address = $this->getQuoteAddress($quote);
        $quoteItemsTaxAmount = $this->lineItemsProvider->toCents((float)$address->getBaseTaxAmount()) -
            $this->lineItemsProvider->toCents((float)$address->getBaseShippingTaxAmount());

        if ($itemTotal !== $this->lineItemsProvider->toCents((float)$quote->getBaseSubtotal()) ||
            $taxTotal !== $quoteItemsTaxAmount) {
            $this->logger->info(
                'Line items total does not match quote subtotal or tax amount',
                [
                    'order_increment_id' => $orderIncrementId,
                    'line_items_total' => $itemTotal,
                    'line_items_tax_total' => $taxTotal,
                    'quote_subtotal' => $quote->getBaseSubtotal(),
                    'quote_tax_amount' => $address->getBaseTaxAmount()
                ]
            );

            return true;
        }

        return false;
    }

    /**
     * Check if the amount breakdown total matches the quote grand total
     *
     * @param float $baseSubtotal
     * @param float $shippingAmount
     * @param float $taxAmount
     * @param float $discountAmount
     * @param float $quoteGrandTotal
     * @param string $orderIncrementId
     * @return bool
     */
    private function hasBreakdownAmountMismatch(
        float $baseSubtotal,
        float $shippingAmount,
        float $taxAmount,
        float $discountAmount,
        float $quoteGrandTotal,
        string $orderIncrementId
    ): bool {
        $breakdownTotal = $this->lineItemsProvider->toCents($baseSubtotal) +
            $this->lineItemsProvider->toCents($shippingAmount) +
            $this->lineItemsProvider->toCents($taxAmount) +
            $this->lineItemsProvider->toCents($discountAmount);

        if ($breakdownTotal !== $this->lineItemsProvider->toCents($quoteGrandTotal)) {
            $this->logger->info(
                'Amount breakdown total does not match quote grand total',
                [
                    'order_increment_id' => $orderIncrementId,
                    'breakdown_total' => $breakdownTotal,
                    'breakdown_base_subtotal' => $baseSubtotal,
                    'breakdown_shipping' => $shippingAmount,
                    'breakdown_tax' => $taxAmount,
                    'breakdown_discount' => $discountAmount,
                    'quote_grand_total' => $quoteGrandTotal
                ]
            );

            return true;
        }

        return false;
    }

    /**
     * Validate the checkout location
     *
     * In GraphQL, the product page location is represented as PRODUCT_DETAIL,
     * while in frontend files, it is referred to as PRODUCT.
     *
     * Since we cannot change this value without risking compatibility issues
     * for merchants with custom implementations, we need to support both.
     *
     * To maintain consistency, we map PRODUCT to PRODUCT_DETAIL before sending it to SaaS.
     *
     * @param ?string $location
     * @return ?string
     */
    public function validateCheckoutLocation(?string $location) : ?string
    {
        if (!$location) {
            return null;
        }

        $location = mb_strtoupper($location);

        // Map "product" to "product_detail" for consistency
        if ($location === Config::PRODUCT_CHECKOUT_LOCATION) {
            return Config::PRODUCT_DETAIL_CHECKOUT_LOCATION;
        }

        if (in_array($location, Config::CHECKOUT_LOCATIONS)) {
            return $location;
        }

        return null;
    }

    /**
     * User action for PayPal payment method only
     *
     * @return string
     */
    public function getUserAction(): string
    {
        return self::USER_ACTION;
    }

    /**
     * Return shipping preference for create order request
     *
     * @param CartInterface|Quote $quote
     * @return string
     */
    public function getShippingPreference(CartInterface|Quote $quote): string
    {
        $allVirtual = true;
        $items = $quote->getAllVisibleItems();
        foreach ($items as $item) {
            if (!$item->getIsVirtual()) {
                $allVirtual = false;
                break;
            }
        }
        $shippingPreference = 'GET_FROM_FILE';
        if ($allVirtual) {
            $shippingPreference = 'NO_SHIPPING';
        }

        return $shippingPreference;
    }

    /**
     * Get 'order_update_callback_config' parameter values
     *
     * @param CartInterface|Quote $quote
     * @return array
     * @throws LocalizedException
     * @throws RandomException
     */
    public function getOrderUpdateCallbackConfig(CartInterface|Quote $quote): array
    {
        return [
            'callback_events' => ['SHIPPING_ADDRESS', 'SHIPPING_OPTIONS'],
            'callback_url' => $this->getCallbackUrl($quote)
        ];
    }

    /**
     * Get shipping callback Url
     *
     * @param CartInterface|Quote $quote
     * @return string
     * @throws LocalizedException
     * @throws RandomException
     */
    private function getCallbackUrl(CartInterface|Quote $quote): string
    {
        $sessionId = $this->generateSessionId();
        $quote->getPayment()->setAdditionalInformation('session_id', $sessionId);

        // Query Parameters
        $queryParams = [
            'cart_id' => $this->getOrCreateMaskedId($quote),
            'session_id' => $sessionId
        ];

        return $this->urlBuilder->getUrl(
            'paymentservicespaypal/smartbuttons/shippingcallback',
            ['_query' => $queryParams, '_secure' => true]
        );
    }

    /**
     * Get existing or create new masked ID
     *
     * @param CartInterface|Quote $quote
     * @return string
     * @throws AlreadyExistsException
     */
    private function getOrCreateMaskedId(CartInterface|Quote $quote): string
    {
        $quoteId = (int) $quote->getId();
        $quoteIdMask = $this->quoteIdMaskFactory->create();
        $this->quoteIdMaskResource->load($quoteIdMask, $quoteId, 'quote_id');

        if ($quoteIdMask->getMaskedId()) {
            return $quoteIdMask->getMaskedId();
        }

        // Create new one
        $quoteIdMask->setQuoteId($quoteId);
        $this->quoteIdMaskResource->save($quoteIdMask);
        return $quoteIdMask->getMaskedId();
    }

    /**
     * Generate unique session ID
     *
     * @return string
     * @throws RandomException
     */
    private function generateSessionId(): string
    {
        return bin2hex(random_bytes(16));
    }

    /**
     * Is app switch enabled
     *
     * @param int|null $storeId
     * @return bool
     * @throws NoSuchEntityException
     */
    public function isAppSwitchEnabled(?int $storeId = null): bool
    {
        return $this->config->getAppSwitch($storeId);
    }

    /**
     * Is contact preference enabled
     *
     * @param int|null $storeId
     * @return bool
     * @throws NoSuchEntityException
     */
    public function isContactPreferenceEnabled(?int $storeId = null): bool
    {
        return $this->config->getContactPreference($storeId);
    }

    /**
     * Get return and cancel url for App Switch
     *
     * @return string
     */
    public function getCurrentPageUrl(): string
    {
        return $this->redirect->getRefererUrl();
    }

    /**
     * Get return & cancel url of checkout payment section for App Switch
     *
     * @return string
     */
    public function getCheckoutPaymentSectionUrl(): string
    {
        return $this->urlBuilder->getUrl(
            'checkout',
            ['_secure' => true, '_fragment' => 'payment']
        );
    }

    /**
     * Get return url
     *
     * @return string
     */
    public function getReturnUrl(): string
    {
        return $this->urlBuilder->getUrl(
            'checkout/onepage/success',
            ['_secure' => true]
        );
    }
}