Skip to content

fix(ModuleInstallerAPI): Rename class in DB recursively #854

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

Open
Hipska wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

fix(ModuleInstallerAPI): Rename class in DB recursively #854

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
41926d0
fix(ModuleInstallerAPI): Rename class in DB recursively
Hipska Mar 25, 2026
6d20288
Typo fix
Hipska Mar 25, 2026
cd8c197
Add class rename on related references
Hipska Apr 15, 2026
3f3c1c5
SynchroDataSource must be updated as well or setup will fail
Hipska Apr 15, 2026
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
40 changes: 33 additions & 7 deletions setup/moduleinstaller.class.inc.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,24 +77,50 @@ public static function AfterDataLoad(Config $oConfiguration, $sPreviousVersion,
/**
* Helper to complete the renaming of a class
* The renaming is made in the datamodel definition, but the name has to be changed in the DB as well
* Must be called after DB update, i.e within an implementation of AfterDatabaseCreation()
* Must be called before DB update, i.e within an implementation of BeforeDatabaseCreation()
*
* @param string $sFrom Original name (already INVALID in the current datamodel)
* @param string $sTo New name (valid in the current datamodel)
* @return void
*/
public static function RenameClassInDB($sFrom, $sTo)
{
if (!MetaModel::DBExists(false)) {
// Install from scratch, no migration
return;
}

try {
if (!MetaModel::IsStandaloneClass($sTo)) {
$sRootClass = MetaModel::GetRootClass($sTo);
$sTableName = MetaModel::DBGetTable($sRootClass);
$sFinalClassCol = MetaModel::DBGetClassField($sRootClass);
$sRepair = "UPDATE `$sTableName` SET `$sFinalClassCol` = '$sTo' WHERE `$sFinalClassCol` = BINARY '$sFrom'";
CMDBSource::Query($sRepair);
$iAffectedRows = CMDBSource::AffectedRows();
$iAffectedRows = 0;
foreach (MetaModel::EnumParentClasses($sTo) as $sParentClass) {
$sTableName = MetaModel::DBGetTable($sParentClass);
$sFinalClassCol = MetaModel::DBGetClassField($sParentClass);
$sRepair = "UPDATE `$sTableName` SET `$sFinalClassCol` = '$sTo' WHERE `$sFinalClassCol` = BINARY '$sFrom'";
CMDBSource::Query($sRepair);
Comment thread
Hipska marked this conversation as resolved.
$iAffectedRows += CMDBSource::AffectedRows();
}
SetupLog::Info("Renaming class in DB - final class from '$sFrom' to '$sTo': $iAffectedRows rows affected");
Comment thread
Hipska marked this conversation as resolved.
}

// Also rename the class reference on the following classes
$aAdditionalClassReferences = [
['class' => CMDBChangeOp::class, 'attcode' => 'objclass'],
['class' => SynchroDataSource::class, 'attcode' => 'scope_class'],
['class' => SynchroReplica::class, 'attcode' => 'dest_class'],
['class' => TriggerOnObject::class, 'attcode' => 'target_class'],
['class' => EventOnObject::class, 'attcode' => 'obj_class'],
];
foreach ($aAdditionalClassReferences as ['class' => $sClass, 'attcode' => $sAttCode]) {
if (MetaModel::IsValidAttCode($sClass, $sAttCode)) {
$sTableName = MetaModel::DBGetTable($sClass, $sAttCode);
$sClassCol = MetaModel::GetAttributeDef($sClass, $sAttCode)->Get("sql");
$sRepair = "UPDATE `$sTableName` SET `$sClassCol` = '$sTo' WHERE `$sClassCol` = BINARY '$sFrom'";
CMDBSource::Query($sRepair);
$iAffectedRows = CMDBSource::AffectedRows();
SetupLog::Info("Renaming class in DB - $sClass::$sAttCode - from '$sFrom' to '$sTo': $iAffectedRows rows affected");
}
}
} catch (Exception $e) {
SetupLog::Warning("Failed to rename class in DB - final class from '$sFrom' to '$sTo'. Reason: ".$e->getMessage());
}
Expand Down