Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: trim shipping address inputs #44

Merged
merged 4 commits into from
Apr 17, 2024
Merged

chore: trim shipping address inputs #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4cc8920
log & trim shipTo city
justinplourde Apr 1, 2024
6032be5
trim vulnerable fields
justinplourde Apr 3, 2024
0bdd075
bump patch version
justinplourde Apr 17, 2024
4cf22d0
log warning and reformatting
justinplourde Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 37 additions & 5 deletions Api/Model/Action/Export.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
use Magento\Sales\Model\ResourceModel\Order\Collection;
use Magento\Sales\Model\ResourceModel\Order\CollectionFactory;
use Magento\Store\Model\ScopeInterface;
use Psr\Log\LoggerInterface;


/**
Expand Down Expand Up @@ -112,6 +113,9 @@ class Export
/** @var RegionCollectionFactory */
private $regionCollectionFactory;

/** @var LoggerInterface */
private $logger;

/**
* Export class constructor
*
Expand All @@ -130,7 +134,8 @@ public function __construct(
Data $dataHelper,
Message $giftMessage,
WeightAdapter $weightAdapter,
RegionCollectionFactory $regionCollectionFactory
RegionCollectionFactory $regionCollectionFactory,
LoggerInterface $logger
)
{
$this->_scopeConfig = $scopeConfig;
Expand All @@ -141,6 +146,7 @@ public function __construct(

$this->orderCollectionFactory = $orderCollectionFactory;
$this->regionCollectionFactory = $regionCollectionFactory;
$this->logger = $logger;

// @todo Initialisation in constructor is forbidden. Move to Config object.
//Price export type
Expand Down Expand Up @@ -393,6 +399,27 @@ private function getRegion(string $regionName): Region
return $region;
}

/**
* Limit the number of chars for a variable.
*
* @param string $value
* @param int $maxLength
* @return string
*/
private function trimChars(string $value, int $maxLength): string
{
if (strlen($value) > $maxLength) {

$this->logger->warning('The value is too long (magento). Trimming '.$value.' to '.$maxLength.' characters from '.strlen($value));

return mb_substr($value ?? "", 0, $maxLength);
}
else {

return $value;
}
}

/**
* Get the Shipping information of order.
*
Expand All @@ -406,16 +433,21 @@ private function _getShippingInfo(Address $shipping): self
$state = $this->getRegion($shipping->getRegion())->getCode();
}

$streetName1 = $this->trimChars($shipping->getStreetLine(1), 200);
$streetName2 = $this->trimChars($shipping->getStreetLine(2), 200);
$city = $this->trimChars($shipping->getCity(), 100);
$phone = $this->trimChars($shipping->getTelephone(), 50);

$this->_xmlData .= "\t<ShipTo>\n";
$this->addXmlElement("Name", "<![CDATA[{$shipping->getFirstname()} {$shipping->getLastname()}]]>");
$this->addXmlElement("Company", "<![CDATA[{$shipping->getCompany()}]]>");
$this->addXmlElement("Address1", "<![CDATA[{$shipping->getStreetLine(1)}]]>");
$this->addXmlElement("Address2", "<![CDATA[{$shipping->getStreetLine(2)}]]>");
$this->addXmlElement("City", "<![CDATA[{$shipping->getCity()}]]>");
$this->addXmlElement("Address1", "<![CDATA[{$streetName1}]]>");
$this->addXmlElement("Address2", "<![CDATA[{$streetName2}]]>");
$this->addXmlElement("City", "<![CDATA[{$city}]]>");
$this->addXmlElement("State", "<![CDATA[{$state}]]>");
$this->addXmlElement("PostalCode", "<![CDATA[{$shipping->getPostcode()}]]>");
$this->addXmlElement("Country", "<![CDATA[{$shipping->getCountryId()}]]>");
$this->addXmlElement("Phone", "<![CDATA[{$shipping->getTelephone()}]]>");
$this->addXmlElement("Phone", "<![CDATA[{$phone}]]>");
$this->_xmlData .= "\t</ShipTo>\n";

return $this;
Expand Down
2 changes: 1 addition & 1 deletion Api/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "auctane/api",
"description": "ShipStation is a web-based shipping solution that is integrated with the Magento API for retrieving order information and updating shipping details.",
"version": "2.4.6",
"version": "2.4.7",
"type": "magento2-module",
"license": [
"OSL-3.0",
Expand Down
2 changes: 1 addition & 1 deletion Api/etc/module.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
<module name="Auctane_Api" setup_version="2.4.6">
<module name="Auctane_Api" setup_version="2.4.7">
</module>
</config>
Loading