N°8761 - WIP deletion plan execution

datamodels/2.x/combodo-data-feature-removal/src/Controller/DataFeatureRemovalController.php

@@ -12,13 +12,16 @@ require_once APPROOT.'setup/feature_removal/DryRemovalRuntimeEnvironment.php';
 
 use Combodo\iTop\Application\TwigBase\Controller\Controller;
 use Combodo\iTop\AuthentToken\Helper\TokenAuthLog;
+use Combodo\iTop\DataFeatureRemoval\Helper\DataFeatureRemovalException;
 use Combodo\iTop\DataFeatureRemoval\Helper\DataFeatureRemovalHelper;
 use Combodo\iTop\DataFeatureRemoval\Model\DataFeatureRemoverAuditRuleService;
 use Combodo\iTop\DataFeatureRemoval\Model\DataFeatureRemoverExtensionService;
+use Combodo\iTop\DataFeatureRemoval\Service\DeletionPlanService;
 use Combodo\iTop\Setup\FeatureRemoval\DryRemovalRuntimeEnvironment;
 use Combodo\iTop\Setup\FeatureRemoval\SetupAudit;
 use Dict;
 use Exception;
+use IssueLog;
 use MetaModel;
 use utils;
 
@@ -51,8 +54,10 @@ class DataFeatureRemovalController extends Controller
 		$iTotalCount = 0;
 		$aData = [];
 		$aColumns = [];
+		$aClasses = [];
 		foreach (DataFeatureRemoverAuditRuleService::GetInstance()->ReadCheckRules() as $oRule) {
 			$sContent = $oRule->Get('class_name');
+			$aClasses[] = $sContent;
 			$sModuleName = MetaModel::GetModuleName($sContent);
 			$aExtensions = DataFeatureRemoverExtensionService::GetInstance()->GetIncludingExtensions($sModuleName);
 			$sExtensions = implode(' ', $aExtensions);
@@ -79,10 +84,12 @@ HTML,
 
 		$aParams['aCheckRules'] =  $this->GetTableData('Analysis', $aColumns, $aData);
 		$aParams['rule_count'] = $iTotalCount;
+		$aParams['aClasses'] = $aClasses;
 	}
 
 	public function OperationAnalyze()
 	{
+		$this->ValidateTransactionId();
 		$aSelectedExtensionsFromUI = utils::ReadPostedParam('aExtensions', []);
 		$this->aSelectedExtensionsForCheck = [];
 		foreach ($aSelectedExtensionsFromUI as $sCode => $aData) {
@@ -98,7 +105,7 @@ HTML,
 			$this->Analyze();
 			$this->OperationMain();
 		} catch (Exception $e) {
-			\IssueLog::Error(__METHOD__, null, ['stack' => $e->getTraceAsString(), 'exception' => $e->getMessage()]);
+			IssueLog::Error(__METHOD__, null, ['stack' => $e->getTraceAsString(), 'exception' => $e->getMessage()]);
 			$this->OperationMain($e->getMessage());
 		}
 	}
@@ -150,7 +157,7 @@ HTML,
 			return [
 				'Type' => 'Table',
 				'Columns' => [['label' => '']],
-				'Data' => [[ Dict::S('DbCleaner:Table:Empty')]],
+				'Data' => [[ Dict::S('DataFeatureRemoval:Table:Empty')]],
 			];
 		}
 
@@ -182,8 +189,74 @@ HTML,
 
 	private function Save(array $aGetRemovedClasses)
 	{
-		\IssueLog::Debug(__METHOD__, null, ['aGetRemovedClasses' => $aGetRemovedClasses]);
+		IssueLog::Debug(__METHOD__, null, ['aGetRemovedClasses' => $aGetRemovedClasses]);
 
 		DataFeatureRemoverAuditRuleService::GetInstance()->SaveChecks($aGetRemovedClasses);
 	}
+
+	public function OperationDeletionPlan()
+	{
+		$aParams = [];
+		$this->ValidateTransactionId();
+
+		$aClasses = utils::ReadPostedParam('classes', null, utils::ENUM_SANITIZATION_FILTER_CLASS);
+
+		$aDeletionPlanSummaryEntities = DeletionPlanService::GetInstance()->GetDeletionPlanSummary($aClasses);
+		$aColumns = ['Class', 'DeleteCount' , 'UpdateCount', 'Issue'];
+		$aRows = [];
+		foreach ($aDeletionPlanSummaryEntities as $oDeletionPlanSummaryEntity) {
+			$aRows[] = [
+				$oDeletionPlanSummaryEntity->sClass,
+				$oDeletionPlanSummaryEntity->iDeleteCount,
+				$oDeletionPlanSummaryEntity->iUpdateCount,
+				$oDeletionPlanSummaryEntity->sIssue ?? '',
+			];
+		}
+
+		$aParams['sTransactionId'] = utils::GetNewTransactionId();
+		$aParams['aDeletionPlanSummary'] = $this->GetTableData('Extensions', $aColumns, $aRows);
+		$aParams['aClasses'] = $aClasses;
+
+		$this->DisplayPage($aParams);
+	}
+
+	public function OperationDoDeletion()
+	{
+		$aParams = [];
+		$this->ValidateTransactionId();
+
+		$aClasses = utils::ReadPostedParam('classes', null, utils::ENUM_SANITIZATION_FILTER_CLASS);
+
+		$aDeletionExecutionSummary = DeletionPlanService::GetInstance()->ExecuteDeletionPlan($aClasses);
+		$aColumns = ['Class', 'DeleteCount' , 'UpdateCount'];
+		$aRows = [];
+		foreach ($aDeletionExecutionSummary as $oDeletionExecutionSummaryEntity) {
+			$aRows[] = [
+				$oDeletionExecutionSummaryEntity->sClass,
+				$oDeletionExecutionSummaryEntity->iDeleteCount,
+				$oDeletionExecutionSummaryEntity->iUpdateCount,
+			];
+		}
+
+		$aParams['sTransactionId'] = utils::GetNewTransactionId();
+		$aParams['aDeletionExecutionSummary'] = $this->GetTableData('Extensions', $aColumns, $aRows);
+		$this->DisplayPage($aParams);
+	}
+
+	/**
+	 * @return void
+	 * @throws \Combodo\iTop\MFABase\Helper\MFABaseException
+	 */
+	public function ValidateTransactionId(): void
+	{
+		if (empty($_POST)) {
+			return;
+		}
+
+		$sTransactionId = utils::ReadPostedParam('transaction_id', null, utils::ENUM_SANITIZATION_FILTER_TRANSACTION_ID);
+		IssueLog::Debug(__FUNCTION__.": Transaction [$sTransactionId]");
+		if (empty($sTransactionId) || !utils::IsTransactionValid($sTransactionId, false)) {
+			throw new DataFeatureRemovalException(Dict::S("iTopUpdate:Error:InvalidToken"));
+		}
+	}
 }

datamodels/2.x/combodo-data-feature-removal/src/Entity/DeletionPlanSummaryEntity.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Combodo\iTop\DataFeatureRemoval\Entity;
+
+class DeletionPlanSummaryEntity
+{
+	public string $sClass;
+
+	/**
+	 * @var int : DEL_MANUAL|DEL_AUTO|DEL_SILENT|DEL_MOVEUP|DEL_NONE
+	 * @see \AttributeDefinition DEL_xxx
+	 */
+	public int $iMode = 0;
+	public ?string $sIssue = null;
+	public int $iUpdateCount = 0;
+	public int $iDeleteCount = 0;
+
+	/**
+	 * @param string $sClass
+	 */
+	public function __construct(string $sClass)
+	{
+		$this->sClass = $sClass;
+	}
+}

datamodels/2.x/combodo-data-feature-removal/src/Service/DeletionPlanService.php

@@ -0,0 +1,145 @@
+<?php
+
+namespace Combodo\iTop\DataFeatureRemoval\Service;
+
+use Combodo\iTop\DataFeatureRemoval\Entity\DeletionPlanSummaryEntity;
+use Combodo\iTop\DataFeatureRemoval\Helper\DataFeatureRemovalException;
+use DeletionPlan;
+use Hoa\Math\Test\Unit\Issue;
+
+class DeletionPlanService
+{
+	private static DeletionPlanService $oInstance;
+
+	protected function __construct()
+	{
+	}
+
+	final public static function GetInstance(): DeletionPlanService
+	{
+		if (!isset(self::$oInstance)) {
+			self::$oInstance = new DeletionPlanService();
+		}
+
+		return self::$oInstance;
+	}
+
+	final public static function SetInstance(?DeletionPlanService $oInstance): void
+	{
+		self::$oInstance = $oInstance;
+	}
+
+	/**
+	 * @param array $sClasses
+	 *
+	 * @return array<\Combodo\iTop\DataFeatureRemoval\Entity\DeletionPlanSummaryEntity>
+	 */
+	public function GetDeletionPlanSummary(array $aClasses): array
+	{
+		$aSummary = [];
+
+		$oDeletionPlan = new DeletionPlan();
+		foreach ($aClasses as $sClass) {
+			$aObjects = $this->GetAllObjects($sClass);
+			foreach ($aObjects as $oObject) {
+				$oObject->CheckToDelete($oDeletionPlan);
+			}
+		}
+
+		foreach ($oDeletionPlan->ListUpdates() as $sClass => $aUpdates) {
+			$oDeletionPlanSummaryEntity = new DeletionPlanSummaryEntity($sClass);
+			$oDeletionPlanSummaryEntity->iUpdateCount = count($aUpdates);
+			$aSummary[$sClass] = $oDeletionPlanSummaryEntity;
+		}
+
+		foreach ($oDeletionPlan->ListDeletes() as $sClass => $aDeletes) {
+			$oDeletionPlanSummaryEntity = $aSummary[$sClass] ?? new DeletionPlanSummaryEntity($sClass);
+			$oDeletionPlanSummaryEntity->iDeleteCount = count($aDeletes);
+
+			$aDelete = array_shift($aDeletes);
+			$oDeletionPlanSummaryEntity->iMode = $aDelete['mode'];
+			$oDeletionPlanSummaryEntity->sIssue = $aDelete['issue'] ?? null;
+
+			$aSummary[$sClass] = $oDeletionPlanSummaryEntity;
+		}
+
+		return $aSummary;
+	}
+
+	/**
+	 * @return \DBObject[]
+	 */
+	private function GetAllObjects(string $sClass): array
+	{
+		$oFilter = new \DBObjectSearch($sClass);
+		$oFilter->AllowAllData();
+		$oSet = new \DBObjectSet($oFilter);
+		return $oSet->ToArray();
+	}
+
+	/**
+	 * @param array $sClasses
+	 *
+	 * @return array<\Combodo\iTop\DataFeatureRemoval\Entity\DeletionPlanSummaryEntity>
+	 */
+	public function ExecuteDeletionPlan(array $aClasses)
+	{
+		$oDeletionPlan = new DeletionPlan();
+		foreach ($aClasses as $sClass) {
+			$aObjects = $this->GetAllObjects($sClass);
+			foreach ($aObjects as $oObject) {
+				$oObject->CheckToDelete($oDeletionPlan);
+			}
+		}
+
+		return $this->DoDelete($oDeletionPlan);
+
+	}
+
+	/**
+	 * @param DeletionPlan $oDeletionPlan
+	 *
+	 * @return array<\Combodo\iTop\DataFeatureRemoval\Entity\DeletionPlanSummaryEntity>
+	 */
+	private function DoDelete(DeletionPlan $oDeletionPlan)
+	{
+		if (count($oDeletionPlan->GetIssues()) > 0) {
+			throw new DataFeatureRemovalException("Deletion Plan cannot be executed due to issues");
+		}
+
+		$aSummary = [];
+		foreach ($oDeletionPlan->ListUpdates() as $sClass => $aToUpdate) {
+			$oDeletionPlanSummaryEntity = $aSummary[$sClass] ?? new DeletionPlanSummaryEntity($sClass);
+
+			foreach ($aToUpdate as $aData) {
+				$oToUpdate = $aData['to_reset'];
+				/** @var \DBObject $oToUpdate */
+				foreach ($aData['attributes'] as $sRemoteExtKey => $aRemoteAttDef) {
+					$oToUpdate->Set($sRemoteExtKey, 0);
+					$oToUpdate->DBUpdate();
+
+					$oDeletionPlanSummaryEntity->iUpdateCount++;
+				}
+			}
+
+			$aSummary[$sClass] = $oDeletionPlanSummaryEntity;
+		}
+
+		foreach ($oDeletionPlan->ListDeletes() as $sClass => $aDeletes) {
+			$oDeletionPlanSummaryEntity = $aSummary[$sClass] ?? new DeletionPlanSummaryEntity($sClass);
+
+			foreach ($aDeletes as $sId => $aDelete) {
+				$oFilter = \DBObjectSearch::FromOQL_AllData("SELECT $sClass WHERE id=:id");
+				$sQuery = $oFilter->MakeDeleteQuery(['id' => $sId]);
+				\CMDBSource::DeleteFrom($sQuery);
+				\IssueLog::Info(__METHOD__, null, [$sQuery]);
+
+				$oDeletionPlanSummaryEntity->iDeleteCount++;
+			}
+
+			$aSummary[$sClass] = $oDeletionPlanSummaryEntity;
+		}
+
+		return $aSummary;
+	}
+}

datamodels/2.x/combodo-data-feature-removal/templates/DeletionPlan.html.twig

@@ -0,0 +1,26 @@
+{# @copyright   Copyright (C) 2010-2026 Combodo SARL #}
+{# @license     http://opensource.org/licenses/AGPL-3.0 #}
+
+{% UIPanel ForInformation { sTitle:'DataFeatureRemoval:DeletionPlan:Title'|dict_s, sSubTitle: 'DataFeatureRemoval:DeletionPlan:SubTitle'|dict_s } %}
+    {% UIDataTable ForForm { sRef:'aDeletionPlanSummary', aColumns:aDeletionPlanSummary.Columns, aData:aDeletionPlanSummary.Data} %}{% EndUIDataTable %}
+{% EndUIPanel %}
+
+
+{% UIForm Standard {} %}
+    {% UIInput ForHidden { sName:'transaction_id', sValue:sTransactionId} %}
+    {% UIInput ForHidden { sName:'operation', sValue:'DoDeletion'} %}
+    {% for sKey, sClass in aClasses %}
+        {% UIInput ForHidden { sName:"classes[" ~ sKey ~ "]", sValue:sClass } %}
+    {% endfor %}
+ {% UIToolbar ForButton {} %}
+        {% UIButton ForPrimaryAction {sLabel:'UI:Button:DoDeletion'|dict_s, sName:'btn_deletion', sId:'btn_deletion', bIsSubmit:true} %}
+    {% EndUIToolbar %}
+{% EndUIForm %}
+
+{% UIForm Standard {} %}
+    {% UIInput ForHidden { sName:'transaction_id', sValue:sTransactionId} %}
+    {% UIInput ForHidden { sName:'operation', sValue:'Main'} %}
+ {% UIToolbar ForButton {} %}
+        {% UIButton ForPrimaryAction {sLabel:'UI:Button:BackToMain'|dict_s, sName:'btn_deletion', sId:'btn_deletion', bIsSubmit:true} %}
+    {% EndUIToolbar %}
+{% EndUIForm %}

datamodels/2.x/combodo-data-feature-removal/templates/DoDeletion.html.twig

@@ -0,0 +1,14 @@
+{# @copyright   Copyright (C) 2010-2026 Combodo SARL #}
+{# @license     http://opensource.org/licenses/AGPL-3.0 #}
+
+{% UIPanel ForInformation { sTitle:'DataFeatureRemoval:DoDeletion:Title'|dict_s, sSubTitle: 'DataFeatureRemoval:DoDeletion:SubTitle'|dict_s } %}
+    {% UIDataTable ForForm { sRef:'aDeletionExecutionSummary', aColumns:aDeletionExecutionSummary.Columns, aData:aDeletionExecutionSummary.Data} %}{% EndUIDataTable %}
+{% EndUIPanel %}
+
+{% UIForm Standard {} %}
+    {% UIInput ForHidden { sName:'transaction_id', sValue:sTransactionId} %}
+    {% UIInput ForHidden { sName:'operation', sValue:'Main'} %}
+ {% UIToolbar ForButton {} %}
+        {% UIButton ForPrimaryAction {sLabel:'UI:Button:BackToMain'|dict_s, sName:'btn_deletion', sId:'btn_deletion', bIsSubmit:true} %}
+    {% EndUIToolbar %}
+{% EndUIForm %}

datamodels/2.x/combodo-data-feature-removal/templates/ExtensionRemovalData.html.twig

@@ -0,0 +1,17 @@
+{# @copyright   Copyright (C) 2010-2024 Combodo SAS #}
+{# @license     http://opensource.org/licenses/AGPL-3.0 #}
+
+{% UIPanel Neutral { sTitle:'DataFeatureRemoval:Analysis:Title'|dict_s, sSubTitle: 'DataFeatureRemoval:Analysis:SubTitle'|dict_format(rule_count) } %}
+    {% UIDataTable ForForm { sRef:'aCheckRules', aColumns:aCheckRules.Columns, aData:aCheckRules.Data} %}{% EndUIDataTable %}
+{% EndUIPanel %}
+
+{% UIForm Standard {} %}
+    {% UIInput ForHidden { sName:'transaction_id', sValue:sTransactionId} %}
+    {% UIInput ForHidden { sName:'operation', sValue:'DeletionPlan'} %}
+    {% for sKey, sClass in aClasses %}
+        {% UIInput ForHidden { sName:"classes[" ~ sKey ~ "]", sValue:sClass } %}
+    {% endfor %}
+ {% UIToolbar ForButton {} %}
+        {% UIButton ForPrimaryAction {sLabel:'UI:Button:PlanDeletion'|dict_s, sName:'btn_plandeletion', sId:'btn_plandeletion', bIsSubmit:true} %}
+    {% EndUIToolbar %}
+{% EndUIForm %}

datamodels/2.x/combodo-data-feature-removal/templates/ExtensionRemovalDataTab.html.twig

@@ -1,8 +0,0 @@
-{# @copyright   Copyright (C) 2010-2024 Combodo SAS #}
-{# @license     http://opensource.org/licenses/AGPL-3.0 #}
-
-{% UIForm Standard {} %}
-    {% UIPanel Neutral { sTitle:'DataFeatureRemoval:Analysis:Title'|dict_s, sSubTitle: 'DataFeatureRemoval:Analysis:SubTitle'|dict_format(rule_count) } %}
-        {% UIDataTable ForForm { sRef:'aCheckRules', aColumns:aCheckRules.Columns, aData:aCheckRules.Data} %}{% EndUIDataTable %}
-    {% EndUIPanel %}
-{% EndUIForm %}

datamodels/2.x/combodo-data-feature-removal/templates/Main.html.twig

@@ -8,7 +8,7 @@
 
 {# DataFeatureRemoval #}
 
-{% UIPanel Neutral { sTitle:'DataFeatureRemoval:Main:Title'|dict_s, sSubTitle: 'DataFeatureRemoval:Main:SubTitle'|dict_s } %}
+{% UIPanel ForInformation { sTitle:'DataFeatureRemoval:Main:Title'|dict_s, sSubTitle: 'DataFeatureRemoval:Main:SubTitle'|dict_s } %}
 
     {% UIAlert ForInformation { sTitle:'DataFeatureRemoval:Helper:Title'|dict_s } %}
         {{ 'DataFeatureRemoval:Helper:Desc1'|dict_s }}<BR>
@@ -23,6 +23,6 @@
     </div>
 {% endif %}
 
-    {% include 'FeaturesTab.html.twig' %}
-    {% include 'ExtensionRemovalDataTab.html.twig' %}
+    {% include 'Features.html.twig' %}
+    {% include 'ExtensionRemovalData.html.twig' %}
 {% EndUIPanel %}

datamodels/2.x/combodo-data-feature-removal/vendor/composer/autoload_classmap.php

@@ -7,11 +7,12 @@ $baseDir = dirname($vendorDir);
 
 return array(
     'Combodo\\iTop\\DataFeatureRemoval\\Controller\\DataFeatureRemovalController' => $baseDir . '/src/Controller/DataFeatureRemovalController.php',
+    'Combodo\\iTop\\DataFeatureRemoval\\Entity\\DeletionPlanSummaryEntity' => $baseDir . '/src/Entity/DeletionPlanSummaryEntity.php',
     'Combodo\\iTop\\DataFeatureRemoval\\Helper\\DataFeatureRemovalException' => $baseDir . '/src/Helper/DataFeatureRemovalException.php',
     'Combodo\\iTop\\DataFeatureRemoval\\Helper\\DataFeatureRemovalHelper' => $baseDir . '/src/Helper/DataFeatureRemovalHelper.php',
     'Combodo\\iTop\\DataFeatureRemoval\\Helper\\DataFeatureRemovalLog' => $baseDir . '/src/Helper/DataFeatureRemovalLog.php',
     'Combodo\\iTop\\DataFeatureRemoval\\Model\\DataFeatureRemoverAuditRuleService' => $baseDir . '/src/Model/DataFeatureRemoverAuditRuleService.php',
     'Combodo\\iTop\\DataFeatureRemoval\\Model\\DataFeatureRemoverExtensionService' => $baseDir . '/src/Model/DataFeatureRemoverExtensionService.php',
-    'Combodo\\iTop\\DataFeatureRemoval\\Service\\SetupAudit' => $baseDir . '/src/Service/SetupAudit.php',
+    'Combodo\\iTop\\DataFeatureRemoval\\Service\\DeletionPlanService' => $baseDir . '/src/Service/DeletionPlanService.php',
     'Composer\\InstalledVersions' => $vendorDir . '/composer/InstalledVersions.php',
 );

datamodels/2.x/combodo-data-feature-removal/vendor/composer/autoload_static.php

@@ -26,12 +26,13 @@ class ComposerStaticInit4f96a7199e2c0d90e547333758b26464
 
     public static $classMap = array (
         'Combodo\\iTop\\DataFeatureRemoval\\Controller\\DataFeatureRemovalController' => __DIR__ . '/../..' . '/src/Controller/DataFeatureRemovalController.php',
+        'Combodo\\iTop\\DataFeatureRemoval\\Entity\\DeletionPlanSummaryEntity' => __DIR__ . '/../..' . '/src/Entity/DeletionPlanSummaryEntity.php',
         'Combodo\\iTop\\DataFeatureRemoval\\Helper\\DataFeatureRemovalException' => __DIR__ . '/../..' . '/src/Helper/DataFeatureRemovalException.php',
         'Combodo\\iTop\\DataFeatureRemoval\\Helper\\DataFeatureRemovalHelper' => __DIR__ . '/../..' . '/src/Helper/DataFeatureRemovalHelper.php',
         'Combodo\\iTop\\DataFeatureRemoval\\Helper\\DataFeatureRemovalLog' => __DIR__ . '/../..' . '/src/Helper/DataFeatureRemovalLog.php',
         'Combodo\\iTop\\DataFeatureRemoval\\Model\\DataFeatureRemoverAuditRuleService' => __DIR__ . '/../..' . '/src/Model/DataFeatureRemoverAuditRuleService.php',
         'Combodo\\iTop\\DataFeatureRemoval\\Model\\DataFeatureRemoverExtensionService' => __DIR__ . '/../..' . '/src/Model/DataFeatureRemoverExtensionService.php',
-        'Combodo\\iTop\\DataFeatureRemoval\\Service\\SetupAudit' => __DIR__ . '/../..' . '/src/Service/SetupAudit.php',
+        'Combodo\\iTop\\DataFeatureRemoval\\Service\\DeletionPlanService' => __DIR__ . '/../..' . '/src/Service/DeletionPlanService.php',
         'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php',
     );