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

Purge dropdown display preferences when a dropdown definition is purged #19141

Merged
merged 1 commit into from
Mar 6, 2025
+85 −52
Merged

Purge dropdown display preferences when a dropdown definition is purged #19141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
57 changes: 40 additions & 17 deletions phpunit/functional/Glpi/Asset/AssetDefinitionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,29 +482,52 @@ public function testSystemNameUpdate(): void

public function testDelete()
{
/** @var \Glpi\Asset\AssetDefinition $definition */
// Create the definition
$definition = $this->initAssetDefinition('test');

$this->createItem(
$definition->getAssetClassName(),
[
'name' => 'test',
'entities_id' => $this->getTestRootEntity(true),
]
);
$concrete_classnames = [
$definition->getAssetClassName() => true,
$definition->getAssetModelClassName() => false,
$definition->getAssetTypeClassName() => false,
];

// Validate that there are display preferences that will have to be deleted
foreach ($concrete_classnames as $classname) {
$this->assertGreaterThan(
0,
getAllDataFromTable('glpi_displaypreferences', ['itemtype' => $classname])
);
}

// Create some items
foreach ($concrete_classnames as $classname => $has_entity) {
$input = [
'name' => 'test ' . $classname,
];
if ($has_entity) {
$input['entities_id'] = $this->getTestRootEntity(true);
}
$this->createItem($classname, $input);
}

// Delete the definition
$this->assertTrue($definition->delete([
'id' => $definition->getID(),
]));
$this->assertCount(
0,
getAllDataFromTable(
'glpi_assets_assets',
[
'assets_assetdefinitions_id' => $definition->getID(),
]
)
);

foreach (array_keys($concrete_classnames) as $classname) {
// Items are deleted
$this->assertCount(
0,
getAllDataFromTable($classname::getTable(), ['assets_assetdefinitions_id' => $definition->getID()])
);

// Display preferences are deleted
$this->assertCount(
0,
getAllDataFromTable('glpi_displaypreferences', ['itemtype' => $classname])
);
}
}

public function testUpdateRights()
Expand Down
29 changes: 21 additions & 8 deletions phpunit/functional/Glpi/Dropdown/DropdownDefinitionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,27 +416,40 @@ public function testSystemNameUpdate(): void

public function testDelete()
{
/** @var \Glpi\Dropdown\DropdownDefinition $definition */
// Create the definition
$definition = $this->initDropdownDefinition('test');

$classname = $definition->getDropdownClassName();

// Validate that there are display preferences that will have to be deleted
$this->assertGreaterThan(
0,
getAllDataFromTable('glpi_displaypreferences', ['itemtype' => $classname])
);

// Create some items
$this->createItem(
$definition->getDropdownClassName(),
$classname,
[
'name' => 'test',
]
);

// Delete the definition
$this->assertTrue($definition->delete([
'id' => $definition->getID(),
]));

// Items are deleted
$this->assertCount(
0,
getAllDataFromTable(
'glpi_dropdowns_dropdowns',
[
'dropdowns_dropdowndefinitions_id' => $definition->getID(),
]
)
getAllDataFromTable('glpi_dropdowns_dropdowns', ['dropdowns_dropdowndefinitions_id' => $definition->getID()])
);

// Display preferences are deleted
$this->assertCount(
0,
getAllDataFromTable('glpi_displaypreferences', ['itemtype' => $classname])
);
}

Expand Down
17 changes: 4 additions & 13 deletions src/Glpi/Asset/AssetDefinition.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,19 +385,10 @@ public function cleanDBonPurge()
$this->onCapacityDisabled($capacity_classname);
}

$related_classes = [
$this->getAssetClassName(),
$this->getAssetModelClassName(),
$this->getAssetTypeClassName(),
];
foreach ($related_classes as $classname) {
(new $classname())->deleteByCriteria(
['assets_assetdefinitions_id' => $this->getID()],
force: true,
history: false
);
(new \DisplayPreference())->deleteByCriteria(['itemtype' => $classname]);
}
$this->purgeConcreteClassFromDb($this->getAssetModelClassName());
$this->purgeConcreteClassFromDb($this->getAssetTypeClassName());

parent::cleanDBonPurge();
}

/**
Expand Down
20 changes: 20 additions & 0 deletions src/Glpi/CustomObject/AbstractDefinition.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,26 @@ public function post_updateItem($history = true)
}
}

public function cleanDBonPurge()
{
$this->purgeConcreteClassFromDb($this->getCustomObjectClassName());
}

/**
* Delete from the database all the data related to the given concrete class.
*
* @param class-string<\CommonDBTM> $concrete_classname
*/
final protected function purgeConcreteClassFromDb(string $concrete_classname): void
{
(new $concrete_classname())->deleteByCriteria(
[static::getForeignKeyField() => $this->getID()],
force: true,
history: false
);
(new \DisplayPreference())->deleteByCriteria(['itemtype' => $concrete_classname]);
}

/**
* Remove given rights from `profiles` field.
*
Expand Down
14 changes: 0 additions & 14 deletions src/Glpi/Dropdown/DropdownDefinition.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,18 +171,4 @@ public function post_addItem()
]);
}
}

public function cleanDBonPurge()
{
$related_classes = [
$this->getDropdownClassName(),
];
foreach ($related_classes as $classname) {
(new $classname())->deleteByCriteria(
['dropdowns_dropdowndefinitions_id' => $this->getID()],
force: true,
history: false
);
}
}
}