composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-07-15 19:26:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Apply code review fixes, add tests

Browse Source
This commit is contained in:
Stephen Abello
2026-07-15 10:31:40 +02:00
parent 933d552e1e
commit 7daed4c8e6
2 changed files with 62 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
core/attributedef.class.inc.php
View File

@@ -910,9 +910,13 @@ abstract class AttributeDefinition
public function TrimValue(string $sValue)
{
$iMaxSize = $this->GetMaxSize();
if ($iMaxSize && (strlen($sValue) > $iMaxSize)) {
$sValue = substr($sValue, 0, $iMaxSize);
$iLength = mb_strlen($sValue);
if ($iMaxSize && ($iLength > $iMaxSize)) {
$sMessage = " -truncated ($iLength chars)";
return mb_substr($sValue, 0, $iMaxSize - mb_strlen($sMessage)).$sMessage;
}
return $sValue;
}
@@ -4266,10 +4270,15 @@ class AttributeText extends AttributeString
$iLengthChar = mb_strlen($sValue);
if ($iMaxSize && ($iLength > $iMaxSize)) {
$sMessage = " -truncated ($iLengthChar chars)";
$sVal = substr($sValue, 0, $iMaxSize - strlen($sMessage));
$iTruncatedValueMaxSize = $iMaxSize - strlen($sMessage);
$sTruncatedValue = substr($sValue, 0, $iTruncatedValueMaxSize);
//executes the "mb_substr" function to ensure a character is not truncated in the middle.
return mb_substr($sValue, 0, mb_strlen($sVal) - 1).$sMessage;
// Keep trimming bytes until we have valid UTF-8 to avoid returning a broken multibyte sequence.
while (($sTruncatedValue !== '') && !mb_check_encoding($sTruncatedValue, 'UTF-8')) {
$sTruncatedValue = substr($sTruncatedValue, 0, -1);
}
return $sTruncatedValue.$sMessage;
}
return $sValue;

51
tests/php-unit-tests/unitary-tests/core/DBObject/DBObjectTest.php
View File

@@ -37,7 +37,6 @@ use Team;
use User;
use UserRequest;
use UserRights;
use utils;
/**
* @group specificOrgInSampleData
@@ -1309,7 +1308,7 @@ class DBObjectTest extends ItopDataTestCase
'pending_reason 65535 chars' => ['pending_reason', 65535, 16403, false],
'pending_reason 65536 chars' => ['pending_reason', 65536, 16403, false],
'pending_reason 16385 chars' => ['pending_reason', 16385, 16403, false],
'pending_reason 16384 chars' => ['pending_reason', 16384, 16383, true],
'pending_reason 16384 chars' => ['pending_reason', 16384, 16384, true],
'pending_reason 16383 chars' => ['pending_reason', 16383, 16383, true],
'pending_reason 16382 chars' => ['pending_reason', 16382, 16382, true],
];
@@ -1345,16 +1344,18 @@ class DBObjectTest extends ItopDataTestCase
$oAttDef = MetaModel::GetAttributeDef(UserRequest::class, $sAttrCode);
$iAttrMaxSize = $oAttDef->GetMaxSize();
$bExpectedStatus = ($oAttDef->GetSize($sValueToSet) <= $iAttrMaxSize);
$this->assertSame($bExpectedStatus, $bIsValueToSetBelowAttrMaxSize, 'The data provider must stay aligned with the attribute max size logic.');
/** @noinspection PhpUnusedLocalVariableInspection */
[$bCheckStatus, $aCheckIssues, $bSecurityIssue] = $oTicket->CheckToWrite();
$this->assertEquals($bIsValueToSetBelowAttrMaxSize, $bCheckStatus, "CheckResult result:".var_export($aCheckIssues, true));
$oTicket->SetTrim($sAttrCode, $sValueToSet);
$sValueInObject = $oTicket->Get($sAttrCode);
$this->assertEquals($iExpectedLength, mb_strlen($sValueInObject), 'Should match expected resulting value length.');
if ($bIsValueToSetBelowAttrMaxSize) {
$this->assertEquals($sValueToSet, $sValueInObject, 'Should not alter string that is already shorter than attribute max length');
} else {
$this->assertEquals($iExpectedLength, mb_strlen($sValueInObject), 'Should truncate at the same length than attribute max length');
$sLastCharsOfValueInObject = mb_substr($sValueInObject, -30);
$this->assertStringContainsString(' -truncated', $sLastCharsOfValueInObject, 'Should end with "truncated" comment');
}
@@ -1387,6 +1388,50 @@ class DBObjectTest extends ItopDataTestCase
$this->assertEquals($sResult, $oOrganisation->Get('name'), 'SetTrim must limit string to 255 characters');
}
/**
* Check that DBObject::SetTrim doesn't cut through multibytes characters
*
* @covers DBObject::SetTrim
* @dataProvider SetTrimAttributeTextProvider
*/
public function testSetTrimOnAttributeTextKeepsUtf8Validity(string $sChar, int $iRepeatCount, bool $bExpectExactByteFill): void
{
$oTicket = MetaModel::NewObject('UserRequest', [
'ref' => 'Test Ticket',
'title' => 'Create OK',
'description' => 'Create OK',
'caller_id' => 15,
'org_id' => 3,
]);
$sValueToSet = str_repeat($sChar, $iRepeatCount);
$oTicket->SetTrim('pending_reason', $sValueToSet);
$sValueInObject = $oTicket->Get('pending_reason');
$oAttDef = MetaModel::GetAttributeDef('UserRequest', 'pending_reason');
$iAttrMaxSize = $oAttDef->GetMaxSize();
$iOriginalCharLength = mb_strlen($sValueToSet);
$sMessage = " -truncated ($iOriginalCharLength chars)";
$this->assertStringEndsWith($sMessage, $sValueInObject, 'Trimmed value should keep the expected truncation suffix.');
$this->assertTrue(mb_check_encoding($sValueInObject, 'UTF-8'), 'Trimmed value should stay valid UTF-8.');
$this->assertLessThanOrEqual($iAttrMaxSize, strlen($sValueInObject), 'Trimmed value should never exceed attribute byte max size.');
if ($bExpectExactByteFill) {
$this->assertSame($iAttrMaxSize, strlen($sValueInObject), 'When byte cut lands on a character boundary, SetTrim should use all available bytes.');
}
}
public function SetTrimAttributeTextProvider()
{
return [
// 2-byte UTF-8 chars: truncation payload size is byte-aligned and should fill the max size exactly.
'pending_reason 2-byte chars on byte boundary' => ["\xC3\xA9", 32768, true],
// 4-byte UTF-8 chars: truncation payload size is not byte-aligned and must backtrack to valid UTF-8.
'pending_reason 4-byte chars with mid-character byte cut' => ['💃', 16385, false],
];
}
/**
* @covers DBObject::SetTrim
*/