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-paypal/Model/Api/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Paypal\Model\Api;
use Magento\Payment\Helper\Formatter;
use Magento\Payment\Model\Method\Logger;
/**
* Abstract class for Paypal API wrappers
*/
abstract class AbstractApi extends \Magento\Framework\DataObject
{
use Formatter;
/**
* Config instance
*
* @var \Magento\Paypal\Model\Config
*/
protected $_config;
/**
* Global private to public interface map
* @var array
*/
protected $_globalMap = [];
/**
* Filter callbacks for exporting $this data to API call
*
* @var array
*/
protected $_exportToRequestFilters = [];
/**
* Filter callbacks for importing API result to $this data
*
* @var array
*/
protected $_importFromRequestFilters = [];
/**
* Line items export to request mapping settings
*
* @var array
*/
protected $_lineItemExportItemsFormat = [];
/**
* @var array
*/
protected $_lineItemExportItemsFilters = [
'name' => 'strval'
];
/**
* @var array
*/
protected $_lineItemTotalExportMap = [];
/**
* PayPal shopping cart instance
*
* @var \Magento\Paypal\Model\Cart
*/
protected $_cart;
/**
* Shipping options export to request mapping settings
*
* @var array
*/
protected $_shippingOptionsExportItemsFormat = [];
/**
* Fields that should be replaced in debug with '***'
*
* @var array
*/
protected $_debugReplacePrivateDataKeys = [];
/**
* Customer address
*
* @var \Magento\Customer\Helper\Address
*/
protected $_customerAddress;
/**
* @var \Psr\Log\LoggerInterface
*/
protected $_logger;
/**
* @var Logger
*/
protected $customLogger;
/**
* @var \Magento\Framework\Locale\ResolverInterface
*/
protected $_localeResolver;
/**
* @var \Magento\Directory\Model\RegionFactory
*/
protected $_regionFactory;
/**
* By default is looking for first argument as array and assigns it as object
* attributes This behavior may change in child classes
*
* @param \Magento\Customer\Helper\Address $customerAddress
* @param \Psr\Log\LoggerInterface $logger
* @param Logger $customLogger
* @param \Magento\Framework\Locale\ResolverInterface $localeResolver
* @param \Magento\Directory\Model\RegionFactory $regionFactory
* @param array $data
*/
public function __construct(
\Magento\Customer\Helper\Address $customerAddress,
\Psr\Log\LoggerInterface $logger,
Logger $customLogger,
\Magento\Framework\Locale\ResolverInterface $localeResolver,
\Magento\Directory\Model\RegionFactory $regionFactory,
array $data = []
) {
$this->_customerAddress = $customerAddress;
$this->_logger = $logger;
$this->customLogger = $customLogger;
$this->_localeResolver = $localeResolver;
$this->_regionFactory = $regionFactory;
parent::__construct($data);
}
/**
* Return Paypal Api user name based on config data
*
* @return string
*/
public function getApiUsername()
{
return $this->_config->getValue('apiUsername');
}
/**
* Return Paypal Api password based on config data
*
* @return string
*/
public function getApiPassword()
{
return $this->_config->getValue('apiPassword');
}
/**
* Return Paypal Api signature based on config data
*
* @return string
*/
public function getApiSignature()
{
return $this->_config->getValue('apiSignature');
}
/**
* Return Paypal Api certificate based on config data
*
* @return string
*/
public function getApiCertificate()
{
return $this->_config->getApiCertificate();
}
/**
* BN code getter
*
* @return string
*/
public function getBuildNotationCode()
{
return $this->_config->getBuildNotationCode();
}
/**
* Return Paypal Api proxy status based on config data
*
* @return bool
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getUseProxy()
{
return $this->_getDataOrConfig('use_proxy', false);
}
/**
* Return Paypal Api proxy host based on config data
*
* @return string
*/
public function getProxyHost()
{
return $this->_getDataOrConfig('proxy_host', '127.0.0.1');
}
/**
* Return Paypal Api proxy port based on config data
*
* @return string
*/
public function getProxyPort()
{
return $this->_getDataOrConfig('proxy_port', '808');
}
/**
* PayPal page CSS getter
*
* @return string
*/
public function getPageStyle()
{
return $this->_getDataOrConfig('page_style');
}
/**
* PayPal page header image URL getter
*
* @return string
*/
public function getHdrimg()
{
return $this->_getDataOrConfig('paypal_hdrimg');
}
/**
* PayPal page header border color getter
*
* @return string
*/
public function getHdrbordercolor()
{
return $this->_getDataOrConfig('paypal_hdrbordercolor');
}
/**
* PayPal page header background color getter
*
* @return string
*/
public function getHdrbackcolor()
{
return $this->_getDataOrConfig('paypal_hdrbackcolor');
}
/**
* PayPal page "payflow color" (?) getter
*
* @return string
*/
public function getPayflowcolor()
{
return $this->_getDataOrConfig('paypal_payflowcolor');
}
/**
* Payment action getter
*
* @return string
*/
public function getPaymentAction()
{
return $this->_getDataOrConfig('payment_action');
}
/**
* PayPal merchant email getter
*
* @return string
*/
public function getBusinessAccount()
{
return $this->_getDataOrConfig('business_account');
}
/**
* Import $this public data to specified object or array
*
* @param array|\Magento\Framework\DataObject $to
* @param array $publicMap
* @return array|\Magento\Framework\DataObject
*/
public function import($to, array $publicMap = [])
{
return \Magento\Framework\DataObject\Mapper::accumulateByMap([$this, 'getDataUsingMethod'], $to, $publicMap);
}
/**
* Export $this public data from specified object or array
*
* @param array|\Magento\Framework\DataObject $from
* @param array $publicMap
* @return $this
*/
public function export($from, array $publicMap = [])
{
\Magento\Framework\DataObject\Mapper::accumulateByMap($from, [$this, 'setDataUsingMethod'], $publicMap);
return $this;
}
/**
* Set PayPal cart instance
*
* @param \Magento\Paypal\Model\Cart $cart
* @return $this
*/
public function setPaypalCart(\Magento\Paypal\Model\Cart $cart)
{
$this->_cart = $cart;
return $this;
}
/**
* Config instance setter
*
* @param \Magento\Paypal\Model\Config $config
* @return $this
*/
public function setConfigObject(\Magento\Paypal\Model\Config $config)
{
$this->_config = $config;
return $this;
}
/**
* Current locale code getter
*
* @return string
*/
public function getLocale()
{
return $this->_localeResolver->getLocale();
}
/**
* Always take into account
*
* @return int
*/
public function getFraudManagementFiltersEnabled()
{
return 1;
}
/**
* Export $this public data to private request array
*
* @param array $privateRequestMap
* @param array $request
* @return array
*/
protected function &_exportToRequest(array $privateRequestMap, array $request = [])
{
$map = [];
foreach ($privateRequestMap as $key) {
if (isset($this->_globalMap[$key])) {
$map[$this->_globalMap[$key]] = $key;
}
}
$result = \Magento\Framework\DataObject\Mapper::accumulateByMap([$this, 'getDataUsingMethod'], $request, $map);
foreach ($privateRequestMap as $key) {
if (isset($this->_exportToRequestFilters[$key]) && isset($result[$key])) {
$callback = $this->_exportToRequestFilters[$key];
$privateKey = $result[$key];
$publicKey = $map[$this->_globalMap[$key]];
// phpcs:ignore Magento2.Functions.DiscouragedFunction
$result[$key] = call_user_func([$this, $callback], $privateKey, $publicKey);
}
}
return $result;
}
/**
* Import $this public data from a private response array
*
* @param array $privateResponseMap
* @param array $response
* @return void
*/
protected function _importFromResponse(array $privateResponseMap, array $response)
{
$map = [];
foreach ($privateResponseMap as $key) {
if (isset($this->_globalMap[$key])) {
$map[$key] = $this->_globalMap[$key];
}
if (isset($response[$key]) && isset($this->_importFromRequestFilters[$key])) {
$callback = $this->_importFromRequestFilters[$key];
// phpcs:ignore Magento2.Functions.DiscouragedFunction
$response[$key] = call_user_func([$this, $callback], $response[$key], $key, $map[$key]);
}
}
\Magento\Framework\DataObject\Mapper::accumulateByMap($response, [$this, 'setDataUsingMethod'], $map);
}
/**
* Prepare line items request
*
* Returns true if there were line items added
*
* @param array $request
* @param int $i
* @return true|null
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
protected function _exportLineItems(array &$request, $i = 0)
{
if (!$this->_cart) {
return;
}
// always add cart totals, even if line items are not requested
if ($this->_lineItemTotalExportMap) {
foreach ($this->_cart->getAmounts() as $key => $total) {
if (isset($this->_lineItemTotalExportMap[$key])) {
$privateKey = $this->_lineItemTotalExportMap[$key];
$total = round((float) $total, 2);
$request[$privateKey] = $this->formatPrice($total);
}
}
}
// add cart line items
$items = $this->_cart->getAllItems();
if (empty($items) || !$this->getIsLineItemsEnabled()) {
return;
}
$result = null;
foreach ($items as $item) {
foreach ($this->_lineItemExportItemsFormat as $publicKey => $privateFormat) {
$result = true;
$value = $item->getDataUsingMethod($publicKey);
$request[sprintf($privateFormat, $i)] = $this->formatValue($value, $publicKey);
}
$i++;
}
return $result;
}
/**
* Prepare shipping options request
*
* Returns false if there are no shipping options
*
* @param array $request
* @param int $i
* @return bool
*/
protected function _exportShippingOptions(array &$request, $i = 0)
{
$options = $this->getShippingOptions();
if (empty($options)) {
return false;
}
foreach ($options as $option) {
foreach ($this->_shippingOptionsExportItemsFormat as $publicKey => $privateFormat) {
$value = $option->getDataUsingMethod($publicKey);
if (is_float($value)) {
$value = $this->formatPrice($value);
}
if (is_bool($value)) {
$value = $this->_filterBool($value);
}
$request[sprintf($privateFormat, $i)] = $value;
}
$i++;
}
return true;
}
/**
* Filter boolean values in API calls
*
* @param mixed $value
* @return string
*/
protected function _filterBool($value)
{
return $value ? 'true' : 'false';
}
/**
* Filter int values in API calls
*
* @param mixed $value
* @return int
*/
protected function _filterInt($value)
{
return (int)$value;
}
/**
* Unified getter that looks in data or falls back to config
*
* @param string $key
* @param mixed|null $default
* @return mixed
*/
protected function _getDataOrConfig($key, $default = null)
{
if ($this->hasData($key)) {
return $this->getData($key);
}
return $this->_config->getValue($key) ? $this->_config->getValue($key) : $default;
}
/**
* Region_id workaround: PayPal requires state code, try to find one in the address
*
* @param \Magento\Framework\DataObject $address
* @return string
*/
protected function _lookupRegionCodeFromAddress(\Magento\Framework\DataObject $address)
{
$regionId = $address->getData('region_id');
if ($regionId) {
$region = $this->_regionFactory->create()->load($regionId);
if ($region->getId()) {
return $region->getCode();
}
}
return '';
}
/**
* Street address workaround: divides address lines into parts by specified keys
* (keys should go as 3rd, 4th[...] parameters)
*
* @param \Magento\Framework\DataObject $address
* @param array $to
* @return void
*/
protected function _importStreetFromAddress(\Magento\Framework\DataObject $address, array &$to)
{
$keys = func_get_args();
array_shift($keys);
array_shift($keys);
$street = $address->getStreet();
if (!$keys || !$street || !is_array($street)) {
return;
}
$street = $this->_customerAddress->convertStreetLines($address->getStreet(), count($keys));
$i = 0;
foreach ($keys as $key) {
$to[$key] = isset($street[$i]) ? $street[$i] : '';
$i++;
}
}
/**
* Build query string from request
*
* @param array $request
* @return string
*/
protected function _buildQuery($request)
{
return http_build_query($request);
}
/**
* Filter qty in API calls
*
* Paypal note: The value for quantity must be a positive integer. Null, zero, or negative numbers are not allowed.
*
* @param float|string|int $value
* @return string
*/
protected function _filterQty($value)
{
return (int)$value;
}
/**
* Log debug data to file
*
* @param mixed $debugData
* @return void
*/
protected function _debug($debugData)
{
$this->customLogger->debug(
$debugData,
(array)$this->getDebugReplacePrivateDataKeys(),
(bool)$this->getDebugFlag()
);
}
/**
* Define if debugging is enabled
*
* @return bool
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getDebugFlag()
{
return $this->_config->getValue('debug');
}
/**
* Check whether API certificate authentication should be used
*
* @return bool
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getUseCertAuthentication()
{
return (bool)$this->_config->getValue('apiAuthentication');
}
/**
* Return replace keys for debug data
*
* @return array
*/
public function getDebugReplacePrivateDataKeys()
{
return $this->_debugReplacePrivateDataKeys;
}
/**
* Formats value according to configured filters or converts to 0.00 format if value is float.
*
* @param string|int|float|\Magento\Framework\Phrase $value
* @param string $publicKey
* @return string
*/
private function formatValue($value, $publicKey)
{
if (!empty($this->_lineItemExportItemsFilters[$publicKey])) {
$callback = $this->_lineItemExportItemsFilters[$publicKey];
$value = method_exists($this, $callback) ? $this->{$callback}($value) : $callback($value);
}
if (is_float($value)) {
$value = $this->formatPrice($value);
}
return $value;
}
}