Your IP : 216.73.216.97
<?php
declare(strict_types=1);
namespace PayPal\Braintree\Model\Kount;
use Braintree\Transaction;
use Exception;
use PayPal\Braintree\Api\EnsManagementInterface;
use PayPal\Braintree\Model\Adapter\BraintreeAdapter;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\DB\TransactionFactory;
use Magento\Framework\Exception\LocalizedException;
use Magento\Sales\Api\Data\OrderInterface;
use Magento\Sales\Api\OrderRepositoryInterface;
use Magento\Sales\Model\Order;
use Magento\Sales\Model\Order\CreditmemoFactory;
use Magento\Sales\Model\Order\Invoice;
use Magento\Sales\Model\Order\Payment;
use Magento\Sales\Model\ResourceModel\Order\Invoice\Collection;
use Magento\Sales\Model\Service\CreditmemoService;
use Magento\Store\Model\ScopeInterface;
use Magento\Store\Model\StoreManagerInterface;
use SimpleXMLElement;
/**
* Contains methods for dealing with Kount ENS Notifications.
*/
class EnsConfig implements EnsManagementInterface
{
/**
* @var StoreManagerInterface
*/
private $storeManager;
/**
* @var ScopeConfigInterface
*/
private $scopeConfig;
/**
* @var OrderInterface
*/
private $order;
/**
* @var BraintreeAdapter
*/
private $braintreeAdapter;
/**
* @var TransactionFactory
*/
private $transactionFactory;
/**
* @var CreditmemoFactory
*/
private $creditmemoFactory;
/**
* @var CreditmemoService
*/
private $creditmemoService;
/**
* @var OrderRepositoryInterface
*/
private $orderRepository;
/**
* @param StoreManagerInterface $storeManager
* @param ScopeConfigInterface $scopeConfig
* @param OrderInterface $order
* @param OrderRepositoryInterface $orderRepository
* @param BraintreeAdapter $braintreeAdapter
* @param TransactionFactory $transactionFactory
* @param CreditmemoFactory $creditmemoFactory
* @param CreditmemoService $creditmemoService
*/
public function __construct(
StoreManagerInterface $storeManager,
ScopeConfigInterface $scopeConfig,
OrderInterface $order,
OrderRepositoryInterface $orderRepository,
BraintreeAdapter $braintreeAdapter,
TransactionFactory $transactionFactory,
CreditmemoFactory $creditmemoFactory,
CreditmemoService $creditmemoService
) {
$this->scopeConfig = $scopeConfig;
$this->storeManager = $storeManager;
$this->order = $order;
$this->braintreeAdapter = $braintreeAdapter;
$this->transactionFactory = $transactionFactory;
$this->creditmemoFactory = $creditmemoFactory;
$this->creditmemoService = $creditmemoService;
$this->orderRepository = $orderRepository;
}
/**
* @return array
*/
public function getAllowedIps(): array
{
$ips = $this->scopeConfig->getValue(self::CONFIG_ALLOWED_IPS);
return $ips ? explode(',', $ips) : [];
}
/**
* This method will check if a given IP (as a string) falls into a valid range, e.g "192.168.0.0/255".
*
* @param string $ip
* @param string $range
* @return bool
*/
public function isIpInRange(string $ip, string $range): bool
{
// If no "range" is set, add the full range of 255.
if (strpos($range, '/') === false) {
$range .= '/255';
}
// $range is in IP/CIDR format eg 127.0.0.1/255
list($range, $netmask) = explode('/', $range, 2); // Get the starting IP and the netmask of the IP range.
$range_decimal = ip2long($range);
$ip_decimal = ip2long($ip);
$wildcard_decimal = (2 ** (32 - $netmask)) - 1;
$netmask_decimal = ~ $wildcard_decimal;
return (($ip_decimal & $netmask_decimal) === ($range_decimal & $netmask_decimal));
}
/**
* @param string $remoteAddress
* @return bool
*/
public function isAllowed(string $remoteAddress): bool
{
$allowedIps = $this->getAllowedIps();
if (!$allowedIps) {
return true;
}
foreach ($allowedIps as $allowedIp) {
if ($this->isIpInRange($remoteAddress, $allowedIp)) {
return true;
}
}
return false;
}
/**
* @param string $merchantId
* @return bool
*/
public function validateMerchantId(string $merchantId): bool
{
$stores = $this->storeManager->getStores();
foreach ($stores as $store) {
$storeMerchantId = $this->scopeConfig->getValue(
self::CONFIG_KOUNT_ID,
ScopeInterface::SCOPE_STORE,
$store->getId()
);
if ($storeMerchantId === $merchantId) {
return true;
}
}
return false;
}
/**
* @param SimpleXMLElement $event
* @return bool
* @throws Exception
*/
public function processEvent(SimpleXMLElement $event): bool
{
if ((string) $event->name === self::ENS_WORKFLOW_EDIT) {
return $this->workflowStatusEdit($event);
}
return false;
}
/**
* @param $event
* @return bool
* @throws Exception
*/
public function workflowStatusEdit($event): bool
{
$incrementId = $this->getIncrementId($event);
$kountTransactionId = $this->getKountTransactionId($event);
if ($incrementId && $kountTransactionId) {
/** @var Order $order */
$order = $this->order->loadByIncrementId($incrementId);
if ($order) {
/** @var Payment $payment */
$payment = $order->getPayment();
$paymentKountId = $payment->getAdditionalInformation('riskDataId');
if ($kountTransactionId === $paymentKountId) {
if ((string) $event->old_value === self::RESPONSE_REVIEW ||
(string) $event->old_value === self::RESPONSE_ESCALATE
) {
if ((string) $event->new_value === self::RESPONSE_APPROVE) {
return $this->approveOrder($order);
}
if ((string) $event->new_value === self::RESPONSE_DECLINE) {
return $this->declineOrder($order);
}
}
}
}
}
return false;
}
/**
* @param $event
* @return int|null
*/
public function getIncrementId($event)
{
if (isset($event->key['order_number'])) {
return (int) $event->key['order_number'];
}
return null;
}
/**
* @param $event
* @return string|null
*/
public function getKountTransactionId($event)
{
if (isset($event->key)) {
return (string) $event->key;
}
return null;
}
/**
* @param OrderInterface $order
* @return bool
* @throws Exception
*/
public function approveOrder(OrderInterface $order): bool
{
/** @var Order $order */
if ($order->getStatus() === Order::STATUS_FRAUD || $order->getStatus() === Order::STATE_PAYMENT_REVIEW) {
$order->getPayment()->accept();
$this->orderRepository->save($order);
return true;
}
return false;
}
/**
* @param OrderInterface $order
* @return bool
* @throws Exception
*/
public function declineOrder(OrderInterface $order): bool
{
/** @var Order $order */
if ($order->getStatus() === Order::STATUS_FRAUD || $order->getStatus() === Order::STATE_PAYMENT_REVIEW) {
$braintreeId = $order->getPayment()->getCcTransId();
/** @var Transaction $braintreeTransaction */
$braintreeTransaction = $this->braintreeAdapter->findById($braintreeId);
if ($braintreeTransaction) {
if ($braintreeTransaction->status === Transaction::AUTHORIZED
|| $braintreeTransaction->status === Transaction::SUBMITTED_FOR_SETTLEMENT) {
return $this->voidOrder($order);
}
if ($braintreeTransaction->status === Transaction::SETTLED) {
return $this->refundOrder($order);
}
}
}
return false;
}
/**
* @param OrderInterface $order
* @return bool
* @throws Exception
*/
public function voidOrder(OrderInterface $order): bool
{
/** @var Collection $invoices */
$invoices = $order->getInvoiceCollection();
if (count($invoices->getItems()) > 0) {
foreach ($invoices as $invoice) {
/** @var Invoice $invoice */
$invoice->void();
$invoice->getOrder()->setStatus(Order::STATE_CANCELED);
$invoice->getOrder()->addCommentToStatusHistory(
__('Order declined through Kount, order voided in Magento.')
);
$this->transactionFactory->create()
->addObject($invoice)
->addObject($invoice->getOrder())
->save();
}
} elseif ($order->getPayment()) {
$order->getPayment()->deny();
$this->orderRepository->save($order);
}
return true;
}
/**
* @param OrderInterface $order
* @return bool
* @throws LocalizedException
*/
public function refundOrder(OrderInterface $order): bool
{
/** @var Collection $invoices */
$invoices = $order->getInvoiceCollection();
if (count($invoices->getItems()) > 0) {
foreach ($invoices as $invoice) {
/** @var Invoice $invoice */
if ($invoice->getState() !== Order\Invoice::STATE_PAID) {
$invoice->pay();
}
if ($invoice->canRefund()) {
$creditMemo = $this->creditmemoFactory->createByInvoice($invoice);
$creditMemo->setInvoice($invoice);
$this->creditmemoService->refund($creditMemo);
}
}
return true;
}
return false;
}
}