Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-vault/Model/Method/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Vault\Model\Method;
use Exception;
use Magento\Framework\Event\ManagerInterface;
use Magento\Framework\ObjectManagerInterface;
use Magento\Payment\Gateway\Command;
use Magento\Payment\Gateway\Config\ValueHandlerPoolInterface;
use Magento\Payment\Gateway\ConfigFactoryInterface;
use Magento\Payment\Gateway\ConfigInterface;
use Magento\Payment\Model\InfoInterface;
use Magento\Payment\Model\MethodInterface;
use Magento\Payment\Observer\AbstractDataAssignObserver;
use Magento\Sales\Api\Data\OrderPaymentExtensionInterfaceFactory;
use Magento\Sales\Api\Data\OrderPaymentInterface;
use Magento\Sales\Model\Order\Payment;
use Magento\Vault\Api\Data\PaymentTokenInterface;
use Magento\Vault\Api\PaymentTokenManagementInterface;
use Magento\Vault\Block\Form;
use Magento\Vault\Model\VaultPaymentInterface;
use Magento\Framework\Serialize\Serializer\Json;
/**
* Class Vault
*
* @SuppressWarnings(PHPMD.ExcessivePublicCount)
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*
* @api
* @since 100.1.0
*/
class Vault implements VaultPaymentInterface
{
/**
* @deprecated
*/
const TOKEN_METADATA_KEY = 'token_metadata';
/**
* @var string
*/
private static $activeKey = 'active';
/**
* @var string
*/
private static $titleKey = 'title';
/**
* @var ConfigFactoryInterface
*/
private $configFactory;
/**
* @var ConfigInterface
*/
private $config;
/**
* @var MethodInterface
*/
private $vaultProvider;
/**
* @var ObjectManagerInterface
*/
private $objectManager;
/**
* @var int
*/
private $storeId;
/**
* @var ValueHandlerPoolInterface
*/
private $valueHandlerPool;
/**
* @var ManagerInterface
*/
private $eventManager;
/**
* @var Command\CommandManagerPoolInterface
*/
private $commandManagerPool;
/**
* @var PaymentTokenManagementInterface
*/
private $tokenManagement;
/**
* @var OrderPaymentExtensionInterfaceFactory
*/
private $paymentExtensionFactory;
/**
* @var string
*/
private $code;
/**
* @var Json
*/
private $jsonSerializer;
/**
* Constructor
*
* @param ConfigInterface $config
* @param ConfigFactoryInterface $configFactory
* @param ObjectManagerInterface $objectManager
* @param MethodInterface $vaultProvider
* @param ManagerInterface $eventManager
* @param ValueHandlerPoolInterface $valueHandlerPool
* @param Command\CommandManagerPoolInterface $commandManagerPool
* @param PaymentTokenManagementInterface $tokenManagement
* @param OrderPaymentExtensionInterfaceFactory $paymentExtensionFactory
* @param string $code
* @param Json|null $jsonSerializer
*
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
ConfigInterface $config,
ConfigFactoryInterface $configFactory,
ObjectManagerInterface $objectManager,
MethodInterface $vaultProvider,
ManagerInterface $eventManager,
ValueHandlerPoolInterface $valueHandlerPool,
Command\CommandManagerPoolInterface $commandManagerPool,
PaymentTokenManagementInterface $tokenManagement,
OrderPaymentExtensionInterfaceFactory $paymentExtensionFactory,
$code,
Json $jsonSerializer = null
) {
$this->config = $config;
$this->configFactory = $configFactory;
$this->objectManager = $objectManager;
$this->valueHandlerPool = $valueHandlerPool;
$this->vaultProvider = $vaultProvider;
$this->eventManager = $eventManager;
$this->commandManagerPool = $commandManagerPool;
$this->tokenManagement = $tokenManagement;
$this->paymentExtensionFactory = $paymentExtensionFactory;
$this->code = $code;
$this->jsonSerializer = $jsonSerializer ?: $this->objectManager->get(Json::class);
}
/**
* Unifies configured value handling logic
*
* @param string $field
* @param int|null $storeId
* @return mixed
*/
private function getConfiguredValue($field, $storeId = null)
{
$handler = $this->valueHandlerPool->get($field);
$subject = ['field' => $field];
return $handler->handle($subject, $storeId ?: $this->getStore());
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function getCode()
{
return $this->code;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function getFormBlockType()
{
return Form::class;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function getTitle()
{
return $this->getConfiguredValue(self::$titleKey);
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function setStore($storeId)
{
$this->storeId = (int)$storeId;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function getStore()
{
return $this->storeId;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canOrder()
{
return false;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canAuthorize()
{
return $this->vaultProvider->canAuthorize()
&& $this->vaultProvider->getConfigData(static::CAN_AUTHORIZE);
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canCapture()
{
return $this->vaultProvider->canCapture()
&& $this->vaultProvider->getConfigData(static::CAN_CAPTURE);
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canCapturePartial()
{
return false;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canCaptureOnce()
{
return $this->vaultProvider->canCaptureOnce();
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canRefund()
{
return false;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canRefundPartialPerInvoice()
{
return false;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canVoid()
{
return false;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canUseInternal()
{
$isInternalAllowed = $this->getConfiguredValue('can_use_internal');
// if config has't been specified for Vault, need to check payment provider option
if ($isInternalAllowed === null) {
return $this->vaultProvider->canUseInternal();
}
return (bool) $isInternalAllowed;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canUseCheckout()
{
return $this->vaultProvider->canUseCheckout();
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canEdit()
{
return $this->vaultProvider->canEdit();
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canFetchTransactionInfo()
{
return false;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function fetchTransactionInfo(InfoInterface $payment, $transactionId)
{
throw new \DomainException("Not implemented");
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function isGateway()
{
return $this->vaultProvider->isGateway();
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function isOffline()
{
return $this->vaultProvider->isOffline();
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function isInitializeNeeded()
{
return $this->vaultProvider->isInitializeNeeded();
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canUseForCountry($country)
{
return $this->vaultProvider->canUseForCountry($country);
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canUseForCurrency($currencyCode)
{
return $this->vaultProvider->canUseForCurrency($currencyCode);
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function getInfoBlockType()
{
return $this->vaultProvider->getInfoBlockType();
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function getInfoInstance()
{
return $this->vaultProvider->getInfoInstance();
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function setInfoInstance(InfoInterface $info)
{
$this->vaultProvider->setInfoInstance($info);
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function validate()
{
return $this->vaultProvider->validate();
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function order(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
throw new \DomainException("Not implemented");
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
if (!$payment instanceof OrderPaymentInterface) {
throw new \DomainException('Not implemented');
}
/** @var $payment OrderPaymentInterface */
$this->attachTokenExtensionAttribute($payment);
$this->attachCreditCardInfo($payment);
$commandExecutor = $this->commandManagerPool->get(
$this->vaultProvider->getCode()
);
$commandExecutor->executeByCode(
VaultPaymentInterface::VAULT_AUTHORIZE_COMMAND,
$payment,
[
'amount' => $amount
]
);
$payment->setMethod($this->vaultProvider->getCode());
return $this;
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function capture(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
if (!$payment instanceof OrderPaymentInterface) {
throw new \DomainException('Not implemented');
}
/** @var $payment Payment */
if ($payment->getAuthorizationTransaction()) {
throw new \DomainException('Capture can not be performed through vault');
}
$this->attachTokenExtensionAttribute($payment);
$commandExecutor = $this->commandManagerPool->get(
$this->vaultProvider->getCode()
);
$commandExecutor->executeByCode(
VaultPaymentInterface::VAULT_SALE_COMMAND,
$payment,
[
'amount' => $amount
]
);
$payment->setMethod($this->vaultProvider->getCode());
}
/**
* Attaches token extension attribute.
*
* @param OrderPaymentInterface $orderPayment
* @return void
*/
private function attachTokenExtensionAttribute(OrderPaymentInterface $orderPayment)
{
$additionalInformation = $orderPayment->getAdditionalInformation();
if (empty($additionalInformation[PaymentTokenInterface::PUBLIC_HASH])) {
throw new \LogicException('Public hash should be defined');
}
$customerId = isset($additionalInformation[PaymentTokenInterface::CUSTOMER_ID]) ?
$additionalInformation[PaymentTokenInterface::CUSTOMER_ID] : null;
$publicHash = $additionalInformation[PaymentTokenInterface::PUBLIC_HASH];
$paymentToken = $this->tokenManagement->getByPublicHash($publicHash, $customerId);
if ($paymentToken === null) {
throw new \LogicException("No token found");
}
$extensionAttributes = $this->getPaymentExtensionAttributes($orderPayment);
$extensionAttributes->setVaultPaymentToken($paymentToken);
}
/**
* Returns Payment's extension attributes.
*
* @param OrderPaymentInterface $payment
* @return \Magento\Sales\Api\Data\OrderPaymentExtensionInterface
*/
private function getPaymentExtensionAttributes(OrderPaymentInterface $payment)
{
$extensionAttributes = $payment->getExtensionAttributes();
if ($extensionAttributes === null) {
$extensionAttributes = $this->paymentExtensionFactory->create();
$payment->setExtensionAttributes($extensionAttributes);
}
return $extensionAttributes;
}
/**
* Attaches credit card info.
*
* @param OrderPaymentInterface $payment
* @return void
*/
private function attachCreditCardInfo(OrderPaymentInterface $payment): void
{
$paymentToken = $payment->getExtensionAttributes()
->getVaultPaymentToken();
if ($paymentToken === null) {
return;
}
$tokenDetails = $paymentToken->getTokenDetails();
if ($tokenDetails === null) {
return;
}
if (is_string($tokenDetails)) {
$tokenDetails = $this->jsonSerializer->unserialize($paymentToken->getTokenDetails());
}
if (is_array($tokenDetails)) {
$payment->addData($tokenDetails);
}
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function refund(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
throw new \DomainException("Not implemented");
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function cancel(\Magento\Payment\Model\InfoInterface $payment)
{
throw new \DomainException("Not implemented");
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function void(\Magento\Payment\Model\InfoInterface $payment)
{
throw new \DomainException("Not implemented");
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function canReviewPayment()
{
throw new \DomainException("Not implemented");
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function acceptPayment(InfoInterface $payment)
{
throw new \DomainException("Not implemented");
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function denyPayment(InfoInterface $payment)
{
throw new \DomainException("Not implemented");
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function getConfigData($field, $storeId = null)
{
return $this->getConfiguredValue($field, $storeId);
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function assignData(\Magento\Framework\DataObject $data)
{
$this->eventManager->dispatch(
'payment_method_assign_data_vault',
[
AbstractDataAssignObserver::METHOD_CODE => $this,
AbstractDataAssignObserver::MODEL_CODE => $this->getInfoInstance(),
AbstractDataAssignObserver::DATA_CODE => $data
]
);
$this->eventManager->dispatch(
'payment_method_assign_data_vault_' . $this->getProviderCode(),
[
AbstractDataAssignObserver::METHOD_CODE => $this,
AbstractDataAssignObserver::MODEL_CODE => $this->getInfoInstance(),
AbstractDataAssignObserver::DATA_CODE => $data
]
);
return $this->vaultProvider->assignData($data);
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
return $this->vaultProvider->isAvailable($quote)
&& $this->config->getValue(self::$activeKey, $this->getStore() ?: ($quote ? $quote->getStoreId() : null));
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function isActive($storeId = null)
{
return $this->vaultProvider->isActive($storeId)
&& $this->config->getValue(self::$activeKey, $this->getStore() ?: $storeId);
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function initialize($paymentAction, $stateObject)
{
throw new \DomainException("Not implemented");
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function getConfigPaymentAction()
{
return $this->vaultProvider->getConfigPaymentAction();
}
/**
* @inheritdoc
* @since 100.1.0
*/
public function getProviderCode()
{
return $this->vaultProvider->getCode();
}
}