-
Notifications
You must be signed in to change notification settings - Fork 9.4k
#39353 Added sanitization of address fields for the presence of template variables in the customer address #39673
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.
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
Open
rostilos
wants to merge
13
commits into
magento:2.4-develop
Choose a base branch
from
rostilos:fix-for-issue-39353-validate-template-vars-in-customer-addr
base: 2.4-develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
83f5bce
#39353 Added validation for the presence of template variables in the…
rostilos 0ea74d7
Merge branch '2.4-develop' into fix-for-issue-39353-validate-template…
rostilos bd419fa
#39353 Copyright tweak
rostilos fa667e0
Merge remote-tracking branch 'origin/fix-for-issue-39353-validate-tem…
rostilos 9da6e35
#39353 Added sanitizer for template vars in address instead of valida…
rostilos c9cb769
Merge remote-tracking branch 'origin/fix-for-issue-39353-validate-tem…
rostilos f33deef
#39353 Static checks bug fixes, unit tests added
rostilos 8e83808
Merge branch 'refs/heads/2.4-develop' into fix-for-issue-39353-valida…
rostilos 1e271ef
Merge branch '2.4-develop' into fix-for-issue-39353-validate-template…
engcom-Hotel ca28932
Apply suggestions from code review
rostilos 09802cf
Merge branch '2.4-develop' into fix-for-issue-39353-validate-template…
rostilos 31f8aa5
Merge branch '2.4-develop' into fix-for-issue-39353-validate-template…
engcom-Bravo b885e49
Merge branch '2.4-develop' into fix-for-issue-39353-validate-template…
engcom-Dash File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
40 changes: 40 additions & 0 deletions
40
app/code/Magento/Customer/Model/Address/CompositeSanitizer.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
<?php | ||
/** | ||
* Copyright 2025 Adobe | ||
* All Rights Reserved. | ||
*/ | ||
declare(strict_types=1); | ||
|
||
namespace Magento\Customer\Model\Address; | ||
|
||
/** | ||
* Address composite validator. | ||
*/ | ||
class CompositeSanitizer implements SanitizerInterface | ||
{ | ||
/** | ||
* @var SanitizerInterface[] | ||
*/ | ||
private array $sanitizers; | ||
|
||
/** | ||
* @param array $sanitizers | ||
*/ | ||
public function __construct( | ||
array $sanitizers = [] | ||
) { | ||
$this->sanitizers = $sanitizers; | ||
} | ||
|
||
/** | ||
* @inheritdoc | ||
*/ | ||
public function sanitize(AbstractAddress $address): AbstractAddress | ||
{ | ||
foreach ($this->sanitizers as $sanitizer) { | ||
$sanitizer->sanitize($address); | ||
} | ||
|
||
return $address; | ||
} | ||
} |
76 changes: 76 additions & 0 deletions
76
app/code/Magento/Customer/Model/Address/Sanitizer/TemplateVars.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
<?php | ||
/** | ||
* Copyright 2025 Adobe | ||
* All Rights Reserved. | ||
*/ | ||
declare(strict_types=1); | ||
|
||
namespace Magento\Customer\Model\Address\Sanitizer; | ||
|
||
use Magento\Customer\Model\Address\SanitizerInterface; | ||
use Magento\Customer\Model\Address\AbstractAddress; | ||
|
||
class TemplateVars implements SanitizerInterface | ||
{ | ||
/** | ||
* Template vars patter | ||
* @var string | ||
*/ | ||
private string $templateVarsPattern = '/\{\{\s*([^{}]+)\s*\}\}/'; | ||
|
||
/** | ||
* List of attributes that can be entered via user input or API | ||
* @var array|string[] | ||
*/ | ||
private array $attributesToSanitize = [ | ||
'firstname', | ||
'lastname', | ||
'middlename', | ||
'city', | ||
'company', | ||
'country_id', | ||
'fax', | ||
'postcode', | ||
'prefix', | ||
'region', | ||
'region_id', | ||
'street', | ||
'suffix', | ||
'telephone', | ||
'vat_id' | ||
]; | ||
|
||
/** | ||
* Sanitize string for template vars in address attributes. | ||
* | ||
* @param AbstractAddress $address | ||
* @return AbstractAddress | ||
*/ | ||
public function sanitize(AbstractAddress $address): AbstractAddress | ||
{ | ||
foreach ($this->attributesToSanitize as $attributeCode) { | ||
$attributeValue = $address->getData($attributeCode); | ||
preg_match_all($this->templateVarsPattern, (string)$attributeValue, $matches); | ||
if (!empty($matches[0])) { | ||
$sanitizedAttributeValue = $this->sanitizeTemplateVars($attributeValue); | ||
$address->setData($attributeCode, $sanitizedAttributeValue); | ||
} | ||
} | ||
|
||
return $address; | ||
} | ||
|
||
/** | ||
* Sanitize string for template vars in address attributes. | ||
* | ||
* @param string $value | ||
* @return string | ||
*/ | ||
private function sanitizeTemplateVars(string $value): string | ||
{ | ||
if (!empty($value)) { | ||
return str_replace(['{', '}'], ['{', '}'], $value); | ||
} | ||
return $value; | ||
} | ||
} |
20 changes: 20 additions & 0 deletions
20
app/code/Magento/Customer/Model/Address/SanitizerInterface.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<?php | ||
/** | ||
* Copyright 2025 Adobe | ||
* All Rights Reserved. | ||
*/ | ||
declare(strict_types=1); | ||
|
||
namespace Magento\Customer\Model\Address; | ||
|
||
interface SanitizerInterface | ||
{ | ||
/** | ||
* Sanitize address instance. | ||
* | ||
* @param AbstractAddress $address | ||
* @return AbstractAddress | ||
* @since 102.0.0 | ||
*/ | ||
public function sanitize(AbstractAddress $address): AbstractAddress; | ||
} |
4 changes: 2 additions & 2 deletions
4
app/code/Magento/Customer/Model/Address/Validator/General.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.