N°9169 - adapt itsm designer connector to the new setup (#928)

* N°9169 - Adapt ITSM designer connector to the new setup - Button Back to designer

* N°9169 - Enhance ITSM designer connector with return button functionality

* N°9169 - Adapt ITSM designer connector to the new setup - Button Back to designer (removed URL in post params)

* N°9169 - Enhance ITSM designer connector with return button functionality and update button styles

---------

Co-authored-by: lenaick.moreira <lenaick.moreira@gmail.com>

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

@@ -26,6 +26,7 @@ use Dict;
 use Exception;
 use MetaModel;
 use RunTimeEnvironment;
+use SecurityException;
 use SetupUtils;
 use utils;
 
@@ -83,10 +84,11 @@ class DataFeatureRemovalController extends Controller
 	{
 		$aParams = [];
 
-		if (SetupUtils::IsSessionSetupTokenValid()) {
+		try {
 			//from setup wizard/mtp
+			SetupUtils::CheckSetupToken();
 			SetupUtils::EraseSetupToken();
-		} else {
+		} catch (SecurityException $e) {
 			//from same module
 			$this->ValidateTransactionId();
 		}
@@ -100,6 +102,7 @@ class DataFeatureRemovalController extends Controller
 			'removed_extensions' => '[]',
 			'extensions_not_uninstallable' => '[]',
 			'copy_setup_files' => 1,
+			'return_button_label' => '',
 		];
 
 		$aHiddenInputs = [];
@@ -108,6 +111,10 @@ class DataFeatureRemovalController extends Controller
 		}
 		$aParams['aHiddenInputs'] = $aHiddenInputs;
 
+		if ($aHiddenInputs['return_button_label'] !== '') {
+			$aParams['sReturnButtonURL'] = utils::GetAbsoluteUrlModulePage('itsm-designer-connector', 'launch.php');
+		}
+
 		$aAddedExtensions = json_decode($aHiddenInputs['added_extensions'], true);
 
 		$aRemovedExtensions = json_decode($aHiddenInputs['removed_extensions'], true);
@@ -179,6 +186,10 @@ class DataFeatureRemovalController extends Controller
 			$aParams['aSetupParams']["_params[$sInputName]"] = $sInputValue;
 		}
 
+		if ($aHiddenInputs['return_button_label'] !== '') {
+			$aParams['sReturnButtonURL'] = utils::GetAbsoluteUrlModulePage('itsm-designer-connector', 'launch.php');
+		}
+
 		[$aParams['aDeletionPlanSummary'], $aParams['iQueryCount'], $aParams['bDeletionPossible']] = $this->GetDeletionPlanSummaryTable($aGetRemovedClasses);
 		[$aParams['aDeletionExecutionSummary'], $aParams['bHasDeletionExecution']] = $this->GetExecutionSummaryTable();
 		$aParams['bDeletionNeeded'] = ($aParams['iQueryCount'] > 0);

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

@@ -87,11 +87,15 @@
         {% endif %}
     {% endif %}
 
-    {% 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_back', sId:'btn_back', bIsSubmit:true} %}
-        {% EndUIToolbar %}
-    {% EndUIForm %}
+    {% if aHiddenInputs.return_button_label != '' %}
+        {% UIButton ForAlternativeSecondaryAction { sLabel:aHiddenInputs.return_button_label, OnClickJsCode: 'window.location.href="' ~ sReturnButtonURL ~ '"'} %}
+    {% else %}
+        {% 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_back', sId:'btn_back', bIsSubmit:true} %}
+            {% EndUIToolbar %}
+        {% EndUIForm %}
+    {% endif %}
 {% EndUIPanel %}

setup/setup.js

@@ -26,17 +26,17 @@ function WizardAsyncAction(sActionCode, oParams, OnErrorFunction)
 function WizardUpdateButtons()
 {
 	if (CanMoveForward()) {
-		$("#btn_next").prop('disabled', false);
+		$("#btn_next").removeClass('ibo-is-hidden');
 	}
 	else {
-		$("#btn_next").prop('disabled', true);
+		$("#btn_next").addClass('ibo-is-hidden');
 	}
 
 	if (CanMoveBackward()) {
-		$("#btn_back").prop('disabled', false);
+		$("#btn_back").removeClass('ibo-is-hidden');
 	}
 	else {
-		$("#btn_back").prop('disabled', true);
+		$("#btn_back").addClass('ibo-is-hidden');
 	}
 }
 

setup/wizardcontroller.class.inc.php

@@ -151,10 +151,10 @@ class WizardController
 		$sCurrentState = utils::ReadParam('_state', $this->sInitialState);
 		$oStep = $this->GetWizardStep($sCurrentStepClass, $sCurrentState);
 		if ($oStep->ValidateParams()) {
-			if ($oStep->CanComeBack()) {
+			$aPossibleSteps = $oStep->GetPossibleSteps();
+			if ($oStep->CanMoveBackward()) {
 				$this->PushStep(['class' => $sCurrentStepClass, 'state' => $sCurrentState]);
 			}
-			$aPossibleSteps = $oStep->GetPossibleSteps();
 			$oWizardState = $oStep->UpdateWizardStateAndGetNextStep(true); // true => moving forward
 			if (in_array($oWizardState->GetNextStep(), $aPossibleSteps)) {
 				$oNextStep = $this->GetWizardStep($oWizardState->GetNextStep(), $oWizardState->GetState());
@@ -237,8 +237,12 @@ HTML;
 
 		$oPage->add('<input type="hidden" name="_steps" value="'.utils::EscapeHtml(json_encode($this->aWizardSteps)).'"/>');
 		$oPage->add('<table style="width:100%;" class="ibo-setup--wizard--buttons-container"><tr>');
-		if ((count($this->aWizardSteps) > 0) && ($oStep->CanMoveBackward())) {
-			$oPage->add('<td style="text-align: left"><button id="btn_back" class="ibo-button ibo-is-alternative ibo-is-neutral" type="submit" name="operation" value="back"><span class="ibo-button--label">Back</span></button></td>');
+		if (count($this->aWizardSteps) > 0) {
+			if ($oStep->CanMoveBackward()) {
+				$oPage->add('<td style="text-align: left"><button id="btn_back" class="ibo-button ibo-is-alternative ibo-is-neutral" type="submit" name="operation" value="back"><span class="ibo-button--label">Back</span></button></td>');
+			} else {
+				$oPage->add('<td style="text-align: left"><button id="btn_back" class="ibo-button ibo-is-alternative ibo-is-neutral ibo-is-hidden" type="submit" name="operation" value="back"><span class="ibo-button--label">Back</span></button></td>');
+			}
 		}
 		if ($oStep->CanMoveForward()) {
 			$oPage->add('<td style="text-align:right;"><button id="btn_next" class="default ibo-button ibo-is-regular ibo-is-primary" type="submit" name="operation" value="next"><span class="ibo-button--label">'.utils::EscapeHtml($oStep->GetNextButtonLabel()).'</span></button></td>');

setup/wizardsteps/WizStepDataAudit.php

@@ -54,16 +54,20 @@ class WizStepDataAudit extends WizStepInstall
 		}
 	}
 
+	/**
+	 * Tells whether this step/state allows to go back or not
+	 * @return boolean True if the '<< Back' button should be displayed
+	 */
+	public function CanMoveBackward()
+	{
+		return false;
+	}
+
 	public function UpdateWizardStateAndGetNextStep($bMoveForward = true): WizardState
 	{
 		return new WizardState(WizStepSummary::class);
 	}
 
-	public function CanComeBack()
-	{
-		return false;
-	}
-
 	public function Display(SetupPage $oPage): void
 	{
 
@@ -108,6 +112,7 @@ JS);
 			'removed_extensions' => '[]',
 			'extensions_not_uninstallable' => '[]',
 			'copy_setup_files' => 1,
+			'return_button_label' => '',
 		];
 		$aHiddenInputs = '';
 		foreach ($aParams as $sParamName => $defaultValue) {
@@ -123,23 +128,43 @@ INPUT;
 			<<<HTML
 <form id="data-feature-removal" class="ibo-setup--wizard ibo-is-hidden" method="post" action="$sApplicationUrl">
 	<input type="hidden" name="operation" value="AnalysisResult"/>
-	<input type="hidden" name="setup_token" value="$sUID"/>
+	<input type="hidden" name="authent" value="$sUID"/>
 	$aHiddenInputs
 </form>
 HTML
 		);
+
+		$sButtonLabel = $this->oWizard->GetParameter('return_button_label', '');
+		if ($sButtonLabel !== '') {
+			$sButtonLabel = utils::HtmlEntities($sButtonLabel);
+			$sButtonUrl = utils::GetAbsoluteUrlModulePage('itsm-designer-connector', 'launch.php');
+			$sButtonUrl = utils::HtmlEntities($sButtonUrl);
+			$oPage->add_ready_script(
+				<<<JS
+	$('.ibo-setup--wizard--buttons-container tr td:nth-child(1)').after('<td style="text-align:center;"><button id="return-button" class="ibo-button ibo-is-alternative ibo-is-neutral ibo-is-hidden" type="button" onclick="window.location.href=\'$sButtonUrl\'"><span class="ibo-button--label">$sButtonLabel</span></button></td>');
+JS
+			);
+		}
 	}
 
 	protected function AddProgressErrorScript($oPage, $aRes)
 	{
+		$oPage->add_ready_script(
+			<<<JS
+    if ($('#return-button').length > 0) {
+		$('#return-button').removeClass('ibo-is-hidden');
+    }
+JS
+		);
+
 		if (isset($aRes['error_code']) && $aRes['error_code'] === DataAuditSequencer::DATA_AUDIT_FAILED) {
 			$oPage->add_ready_script(
-				<<<EOF
-	$('.ibo-setup--wizard--buttons-container tr td:nth-child(2)').before('<td style="text-align:center;"><button class="ibo-button ibo-is-alternative ibo-is-neutral" type="submit" name="operation" value="next" id="ignore_and_continue"><span class="ibo-button--label">Ignore and continue</span></button></td>');
+				<<<JS
+	$('.ibo-setup--wizard--buttons-container tr td:nth-child(2)').after('<td style="text-align:center;"><button class="ibo-button ibo-is-alternative ibo-is-neutral" type="submit" name="operation" value="next" id="ignore_and_continue"><span class="ibo-button--label">Ignore and continue</span></button></td>');
 	$('#ignore_and_continue').on('click', function() {
 		return confirm("If you skip the cleanup you won't be able to run the process later. You'll have to migrate or delete unconsistent data manually.");
 	});
-	$('.ibo-setup--wizard--buttons-container tr td:nth-child(2)').after('<td style="text-align:center;"><span id="submit-wait" class="ibo-spinner ibo-is-inline ibo-is-hidden ibo-spinner ibo-block" data-role="ibo-spinner"><i class="ibo-spinner--icon fas fa-sync-alt fa-spin" aria-hidden="true"></i></span>&nbsp;<button id="goto-data-feature-removal" class="default ibo-button ibo-is-regular ibo-is-primary" type="button"><span class="ibo-button--label">Cleanup my data</span></button></td>');
+	$('.ibo-setup--wizard--buttons-container tr td:nth-child(3)').after('<td style="text-align:center;"><span id="submit-wait" class="ibo-spinner ibo-is-inline ibo-is-hidden ibo-spinner ibo-block" data-role="ibo-spinner"><i class="ibo-spinner--icon fas fa-sync-alt fa-spin" aria-hidden="true"></i></span>&nbsp;<button id="goto-data-feature-removal" class="default ibo-button ibo-is-regular ibo-is-primary" type="button"><span class="ibo-button--label">Cleanup my data</span></button></td>');
 	$('#goto-data-feature-removal').on("click", function() {
 		$('#goto-data-feature-removal').prop('disabled', true);
 		$('#submit-wait').removeClass("ibo-is-hidden");
@@ -148,7 +173,7 @@ HTML
 	
 	$("#wiz_form").data("installation_status", "cleanup_needed");
 	$('#btn_next').hide();
-EOF
+JS
 			);
 		}
 
@@ -161,6 +186,10 @@ EOF
 
 	public function JSCanMoveBackward()
 	{
+		if ($this->oWizard->GetParameter('return_button_label', '') !== '') {
+			return 'return false;';
+		}
+
 		return 'return  ["not started", "error", "cleanup_needed"].indexOf($("#wiz_form").data("installation_status")) !== -1;';
 	}
 }

setup/wizardsteps/WizStepDone.php

@@ -144,6 +144,11 @@ class WizStepDone extends WizardStep
 		return false;
 	}
 
+	public function JSCanMoveBackward()
+	{
+		return 'return false;';
+	}
+
 	/**
 	 * Tells whether this step of the wizard requires that the configuration file be writable
 	 * @return bool True if the wizard will possibly need to modify the configuration at some point

setup/wizardsteps/WizStepInstall.php

@@ -54,6 +54,13 @@ class WizStepInstall extends AbstractWizStepInstall
 		}
 	}
 
+	public function CanMoveBackward()
+	{
+		$sLabel = $this->oWizard->GetParameter('return_button_label', '');
+		SetupLog::Info(__METHOD__.": return_button_label [$sLabel]");
+		return $sLabel === '';
+	}
+
 	public function UpdateWizardStateAndGetNextStep($bMoveForward = true): WizardState
 	{
 		return new WizardState(WizStepDone::class);
@@ -109,6 +116,20 @@ JS);
 JS);
 	}
 
+	public function PostFormDisplay(SetupPage $oPage)
+	{
+		$sButtonLabel = $this->oWizard->GetParameter('return_button_label', '');
+		SetupLog::Info(__METHOD__.": return_button_label [$sButtonLabel]");
+		if ($sButtonLabel !== '') {
+			$sButtonUrl = utils::GetAbsoluteUrlModulePage('itsm-designer-connector', 'launch.php');
+			$oPage->add_ready_script(
+				<<<JS
+	$('.ibo-setup--wizard--buttons-container tr td:nth-child(1)').after('<td style="text-align:center;"><button id="return-button" class="ibo-button ibo-is-alternative ibo-is-neutral ibo-is-hidden" type="button" onclick="window.location.href=\'$sButtonUrl\'"><span class="ibo-button--label">$sButtonLabel</span></button></td>');
+JS
+			);
+		}
+	}
+
 	/**
 	 * @throws \Exception
 	 */
@@ -125,27 +146,25 @@ JS);
 			// Tell the web page to move the progress bar and to launch the next step
 			$sMessage = addslashes(utils::EscapeHtml($aRes['next-step-label']));
 			$oPage->add_ready_script(
-				<<<EOF
-	$("#wiz_form").data("installation_status", "running");
-	WizardUpdateButtons();
-	$('#setup_msg').html('$sMessage');
-	$('#progress').progression( {Current:{$aRes['percentage-completed']}, Maximum: 100} );
-	
-	//$("#percentage").html('{$aRes['percentage-completed']} % completed<br/>{$aRes['next-step-label']}');
-	ExecuteStep('{$aRes['next-step']}');
-EOF
+				<<<JS
+				$("#wiz_form").data("installation_status", "running");
+				WizardUpdateButtons();
+				$('#setup_msg').html('$sMessage');
+				$('#progress').progression( {Current:{$aRes['percentage-completed']}, Maximum: 100} );
+				
+				//$("#percentage").html('{$aRes['percentage-completed']} % completed<br/>{$aRes['next-step-label']}');
+				ExecuteStep('{$aRes['next-step']}');
+JS
 			);
 			static::AddPrevStepSuccessMessage($oPage, $aRes['prev-step-success-message']);
 		} elseif ($aRes['status'] !== StepSequencer::ERROR) {
 			// Installation complete, move to the next step of the wizard
 			$oPage->add_ready_script(
-				<<<EOF
-	$("#wiz_form").data("installation_status", "completed");
-	$('#progress').progression( {Current:100, Maximum: 100} );
-	WizardUpdateButtons();
-	$("#btn_next").off("click.install");
-	$("#btn_next").trigger('click');
-EOF
+				<<<JS
+				$('#progress').progression( {Current:100, Maximum: 100} );
+				$("#wiz_form").data("installation_status", "completed");
+				$("#btn_next").trigger('click');
+JS
 			);
 			static::AddPrevStepSuccessMessage($oPage, $aRes['prev-step-success-message']);
 		} else {
@@ -153,12 +172,12 @@ EOF
 			$sMessage = addslashes(utils::EscapeHtml($aRes['message']));
 			$sMessage = str_replace("\n", '<br>', $sMessage);
 			$oPage->add_ready_script(
-				<<<EOF
-	$("#wiz_form").data("installation_status", "error");
-	$("#progress .progress").addClass('progress-error');
-	WizardUpdateButtons();
-	$('#setup_error').html('$sMessage').show();
-EOF
+				<<<JS
+				$("#wiz_form").data("installation_status", "error");
+				$("#progress .progress").addClass('progress-error');
+				WizardUpdateButtons();
+				$('#setup_error').html('$sMessage').show();
+JS
 			);
 			$this->AddProgressErrorScript($oPage, $aRes);
 		}
@@ -166,7 +185,13 @@ EOF
 
 	protected function AddProgressErrorScript($oPage, $aRes)
 	{
-
+		$oPage->add_ready_script(
+			<<<JS
+    if ($('#return-button').length > 0) {
+		$('#return-button').removeClass('ibo-is-hidden');
+    }
+JS
+		);
 	}
 
 	/**

setup/wizardsteps/WizStepLandingBeforeAudit.php

@@ -84,7 +84,7 @@ class WizStepLandingBeforeAudit extends WizStepModulesChoice
 		return 'Next';
 	}
 
-	public function CanComeBack()
+	public function CanMoveBackward()
 	{
 		return false;
 	}

setup/wizardsteps/WizStepSummary.php

@@ -57,6 +57,14 @@ class WizStepSummary extends AbstractWizStepInstall
 		}
 	}
 
+	public function CanMoveBackward()
+	{
+		$sLabel = $this->oWizard->GetParameter('return_button_label', '');
+		SetupLog::Info(__METHOD__.": return_button_label [$sLabel]");
+
+		return $sLabel === '';
+	}
+
 	public function UpdateWizardStateAndGetNextStep($bMoveForward = true): WizardState
 	{
 		$this->oWizard->SaveParameter('db_backup', false);
@@ -242,6 +250,19 @@ JS
 		);
 	}
 
+	public function PostFormDisplay(SetupPage $oPage)
+	{
+		$sButtonLabel = $this->oWizard->GetParameter('return_button_label', '');
+		if ($sButtonLabel !== '') {
+			$sButtonUrl = utils::GetAbsoluteUrlModulePage('itsm-designer-connector', 'launch.php');
+			$oPage->add_ready_script(
+				<<<JS
+	$('.ibo-setup--wizard--buttons-container tr td:nth-child(1)').after('<td style="text-align:center;"><button id="return-button" class="ibo-button ibo-is-alternative ibo-is-neutral" type="button" onclick="window.location.href=\'$sButtonUrl\'"><span class="ibo-button--label">$sButtonLabel</span></button></td>');
+JS
+			);
+		}
+	}
+
 	/**
 	 * Tells whether the "Next" button should be enabled interactively
 	 * @return string A piece of javascript code returning either true or false
@@ -257,7 +278,11 @@ JS
 	 */
 	public function JSCanMoveBackward()
 	{
-		return 'return true;';
+		if ($this->oWizard->GetParameter('return_button_label', '') === '') {
+			return 'return true;';
+		}
+
+		return 'return false;';
 	}
 
 }

setup/wizardsteps/WizStepWelcome.php

@@ -18,8 +18,6 @@
  * You should have received a copy of the GNU Affero General Public License
  */
 
-use Combodo\iTop\Application\WebPage\WebPage;
-
 /**
  * First step of the iTop Installation Wizard: Welcome screen, requirements
  */
@@ -98,7 +96,7 @@ EOF
 		$sStyle = 'style="display:none;overflow:auto;"';
 		$sToggleButtons = '<button type="button" id="show_details" class="ibo-button ibo-is-alternative ibo-is-neutral" onclick="$(\'#details\').toggle(); $(this).toggle(); $(\'#hide_details\').toggle();"><span class="ibo-button--icon fa fa-caret-down"></span><span class="ibo-button--label">Show details</span></button><button type="button" id="hide_details" class="ibo-button ibo-is-alternative ibo-is-neutral" style="display:none;" onclick="$(\'#details\').toggle(); $(this).toggle(); $(\'#show_details\').toggle();"><span class="ibo-button--icon fa fa-caret-up"></span><span class="ibo-button--label">Hide details</span></button>';
 		if (count($aErrors) > 0) {
-			$sStyle = 'overflow:auto;"';
+			$sStyle = 'style="overflow:auto;"';
 			$sTitle = count($aErrors).' Error(s), '.count($aWarnings).' Warning(s).';
 			$sH2Class = 'text-error';
 		} elseif (count($aWarnings) > 0) {

setup/wizardsteps/WizardStep.php

@@ -151,15 +151,6 @@ abstract class WizardStep
 		return true;
 	}
 
-	/**
-	 * Tells whether the user will come back to this step/state if he click on "Back"
-	 * @return boolean True if the 'Back' button should display this step
-	 */
-	public function CanComeBack()
-	{
-		return true;
-	}
-
 	/**
 	 * Tells whether the "Next" button should be enabled interactively
 	 * @return string A piece of javascript code returning either true or false