Check custom assets availability before importing a form

AdrienClairembault · trasher · commit 909e2adec076 · 2025-10-31T09:50:54.000+01:00
diff --git a/src/Glpi/Asset/AssetDefinitionManager.php b/src/Glpi/Asset/AssetDefinitionManager.php
@@ -390,6 +390,14 @@ public function getCapacity(string $classname): ?CapacityInterface
         return $this->capacities[$classname] ?? null;
     }
 
+    public function isCustomAsset(string $class): bool
+    {
+        return str_starts_with(
+            $class,
+            AssetDefinition::getCustomObjectNamespace()
+        );
+    }
+
     private function loadConcreteClass(AssetDefinition $definition): void
     {
         $rightname = $definition->getCustomObjectRightname();
diff --git a/src/Glpi/Controller/Form/Import/Step2PreviewController.php b/src/Glpi/Controller/Form/Import/Step2PreviewController.php
@@ -79,7 +79,11 @@ private function previewResponse(
         }
 
         $previewResult = $serializer->previewImport($json, $mapper, $skipped_forms);
-        if (empty($previewResult->getValidForms()) && empty($previewResult->getInvalidForms())) {
+        if (
+            empty($previewResult->getValidForms())
+            && empty($previewResult->getInvalidForms())
+            && empty($previewResult->getFormsWithFatalErrors())
+        ) {
             return new RedirectResponse($request->getBasePath() . '/Form/Import');
         }
 
diff --git a/src/Glpi/Dropdown/DropdownDefinitionManager.php b/src/Glpi/Dropdown/DropdownDefinitionManager.php
@@ -124,6 +124,14 @@ public function autoloadClass(string $classname): void
         }
     }
 
+    public function isCustomDropdown(string $class): bool
+    {
+        return str_starts_with(
+            $class,
+            DropdownDefinition::getCustomObjectNamespace()
+        );
+    }
+
     private function loadConcreteClass(DropdownDefinition $definition): void
     {
         $rightname = $definition->getCustomObjectRightname();
diff --git a/src/Glpi/Form/Export/Result/ImportError.php b/src/Glpi/Form/Export/Result/ImportError.php
@@ -38,4 +38,5 @@
 enum ImportError
 {
     case MISSING_DATA_REQUIREMENT;
+    case MISSING_CUSTOM_TYPE_REQUIREMENT;
 }
diff --git a/src/Glpi/Form/Export/Result/ImportResultPreview.php b/src/Glpi/Form/Export/Result/ImportResultPreview.php
@@ -46,6 +46,14 @@ final class ImportResultPreview
     /** @var string[] $skipped_forms */
     private array $skipped_forms = [];
 
+    /**
+     * Store error messages for a given form ID.
+     * Unlike $invalid_forms, this represent errors that aren't recoverable.
+     *
+     *  @var array<int, array{name: string, errors: array<string>}> $fatal_errors
+     **/
+    private array $fatal_errors = [];
+
     public function addValidForm(int $form_id, string $form_name): void
     {
         $this->valid_forms[$form_id] = $form_name;
@@ -78,4 +86,30 @@ public function getSkippedForms(): array
     {
         return $this->skipped_forms;
     }
+
+    public function addFatalErrorForForm(
+        int $form_id,
+        string $form_name,
+        string $error
+    ): void {
+        if (!isset($this->fatal_errors[$form_id])) {
+            $this->fatal_errors[$form_id] = [
+                'name' => $form_name,
+                'errors' => [],
+            ];
+        }
+
+        $this->fatal_errors[$form_id]['errors'][] = $error;
+    }
+
+    public function hasFatalErrorForForm(int $form_id): bool
+    {
+        $errors = $this->fatal_errors[$form_id]['errors'] ?? [];
+        return count($errors) > 0;
+    }
+
+    public function getFormsWithFatalErrors(): array
+    {
+        return $this->fatal_errors;
+    }
 }
diff --git a/src/Glpi/Form/Export/Serializer/FormSerializer.php b/src/Glpi/Form/Export/Serializer/FormSerializer.php
@@ -36,6 +36,8 @@
 
 use CommonDBTM;
 use Entity;
+use Glpi\Asset\AssetDefinitionManager;
+use Glpi\Dropdown\DropdownDefinitionManager;
 use Glpi\Form\AccessControl\FormAccessControl;
 use Glpi\Form\Category;
 use Glpi\Form\Comment;
@@ -54,6 +56,7 @@
 use Glpi\Form\Export\Specification\CommentContentSpecification;
 use Glpi\Form\Export\Specification\ConditionDataSpecification;
 use Glpi\Form\Export\Specification\CustomIllustrationContentSpecification;
+use Glpi\Form\Export\Specification\CustomTypeRequirementSpecification;
 use Glpi\Form\Export\Specification\DataRequirementSpecification;
 use Glpi\Form\Export\Specification\DestinationContentSpecification;
 use Glpi\Form\Export\Specification\ExportContentSpecification;
@@ -65,9 +68,12 @@
 use Glpi\Form\FormTranslation;
 use Glpi\Form\Question;
 use Glpi\Form\QuestionType\QuestionTypeInterface;
+use Glpi\Form\QuestionType\QuestionTypeItem;
+use Glpi\Form\QuestionType\QuestionTypeItemExtraDataConfig;
 use Glpi\Form\Section;
 use Glpi\UI\IllustrationManager;
 use InvalidArgumentException;
+use LogicException;
 use RuntimeException;
 use Session;
 use Throwable;
@@ -120,17 +126,32 @@ public function previewImport(
         // Validate each forms
         $results = new ImportResultPreview();
         foreach ($export_specification->forms as $form_spec) {
-            $requirements = $form_spec->data_requirements;
-            $mapper->mapExistingItemsForRequirements($requirements);
-
+            // Skip ignored forms
             $form_id   = $form_spec->id;
             $form_name = $form_spec->name;
             if (in_array($form_id, $skipped_forms)) {
                 $results->addSkippedForm($form_id, $form_name);
                 continue;
             }
 
-            if ($mapper->validateRequirements($requirements)) {
+            // Validate custom types requirements
+            $types_requirements = $form_spec->custom_types_requirements;
+            $missing_types = $this->getMissingCustomTypes($types_requirements);
+            foreach ($missing_types as $missing_type) {
+                $message = sprintf(__('Unknown custom type: %s'), $missing_type);
+                $results->addFatalErrorForForm($form_id, $form_name, $message);
+            }
+
+            // Do not process others requirements if we reached a fatal error
+            if ($results->hasFatalErrorForForm($form_id)) {
+                continue;
+            }
+
+            // Validate data requirements
+            $data_requirements = $form_spec->data_requirements;
+            $mapper->mapExistingItemsForRequirements($data_requirements);
+
+            if ($mapper->validateRequirements($data_requirements)) {
                 $results->addValidForm($form_id, $form_name);
             } else {
                 $results->addInvalidForm($form_id, $form_name);
@@ -180,15 +201,27 @@ public function importFormsFromJson(
         // Import each forms
         $result = new ImportResult();
         foreach ($export_specification->forms as $form_spec) {
-            $requirements = $form_spec->data_requirements;
-            $mapper->mapExistingItemsForRequirements($requirements);
-
+            // Skip form if needed
             $form_id = $form_spec->id;
             if (in_array($form_id, $skipped_forms)) {
                 continue;
             }
 
-            if (!$mapper->validateRequirements($requirements)) {
+            // Validate custom types
+            $types_requirements = $form_spec->custom_types_requirements;
+            if (!$this->validateCustomTypesRequirements($types_requirements)) {
+                $result->addFailedFormImport(
+                    $form_spec->name,
+                    ImportError::MISSING_CUSTOM_TYPE_REQUIREMENT,
+                );
+                continue;
+            }
+
+            // Validate data requirements
+            $data_requirements = $form_spec->data_requirements;
+            $mapper->mapExistingItemsForRequirements($data_requirements);
+
+            if (!$mapper->validateRequirements($data_requirements)) {
                 $result->addFailedFormImport(
                     $form_spec->name,
                     ImportError::MISSING_DATA_REQUIREMENT
@@ -235,6 +268,7 @@ private function exportFormToSpec(Form $form): FormContentSpecification
         $form_spec = $this->exportAccesControlPolicies($form, $form_spec);
         $form_spec = $this->exportDestinations($form, $form_spec);
         $form_spec = $this->exportTranslations($form, $form_spec);
+        $form_spec = $this->addCustomTypesRequirements($form, $form_spec);
 
         return $form_spec;
     }
@@ -1108,4 +1142,62 @@ private function prepareIllustrationDataForImport(
 
         return $prefix . $illustration->key;
     }
+
+    private function addCustomTypesRequirements(
+        Form $form,
+        FormContentSpecification $form_spec,
+    ): FormContentSpecification {
+        $asset_manager = AssetDefinitionManager::getInstance();
+        $dropdown_manager = DropdownDefinitionManager::getInstance();
+
+        // Look for item question on custom assets types
+        foreach ($form->getQuestions() as $question) {
+            $type = $question->getQuestionType();
+            if (!$type instanceof QuestionTypeItem) {
+                continue;
+            }
+
+            $config = $question->getExtraDataConfig();
+            if (!$config instanceof QuestionTypeItemExtraDataConfig) {
+                throw new LogicException(); // Impossible
+            }
+
+            $itemtype = $config->getItemtype();
+            if (
+                $asset_manager->isCustomAsset($itemtype)
+                || $dropdown_manager->isCustomDropdown($itemtype)
+            ) {
+                $form_spec->addCustomTypeRequirement(
+                    new CustomTypeRequirementSpecification($itemtype)
+                );
+            }
+        }
+
+        return $form_spec;
+    }
+
+    /** @param CustomTypeRequirementSpecification[] $requirements */
+    private function validateCustomTypesRequirements(array $requirements): bool
+    {
+        foreach ($requirements as $requirement) {
+            if (!class_exists($requirement->itemtype)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /** @param CustomTypeRequirementSpecification[] $requirements */
+    private function getMissingCustomTypes(array $requirements): array
+    {
+        $missing_types = [];
+        foreach ($requirements as $requirement) {
+            if (!class_exists($requirement->itemtype)) {
+                $missing_types[] = $requirement->itemtype;
+            }
+        }
+
+        return $missing_types;
+    }
 }
diff --git a/src/Glpi/Form/Export/Specification/CustomTypeRequirementSpecification.php b/src/Glpi/Form/Export/Specification/CustomTypeRequirementSpecification.php
@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * ---------------------------------------------------------------------
+ *
+ * GLPI - Gestionnaire Libre de Parc Informatique
+ *
+ * http://glpi-project.org
+ *
+ * @copyright 2015-2025 Teclib' and contributors.
+ * @licence   https://www.gnu.org/licenses/gpl-3.0.html
+ *
+ * ---------------------------------------------------------------------
+ *
+ * LICENSE
+ *
+ * This file is part of GLPI.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * ---------------------------------------------------------------------
+ */
+
+namespace Glpi\Form\Export\Specification;
+
+final class CustomTypeRequirementSpecification
+{
+    public function __construct(
+        public string $itemtype = "",
+    ) {}
+}
diff --git a/src/Glpi/Form/Export/Specification/FormContentSpecification.php b/src/Glpi/Form/Export/Specification/FormContentSpecification.php
@@ -77,12 +77,14 @@ final class FormContentSpecification
     /** @var DataRequirementSpecification[] $data_requirements */
     public array $data_requirements = [];
 
+    /** @var CustomTypeRequirementSpecification[] $data_requirements */
+    public array $custom_types_requirements = [];
+
     /** @return DataRequirementSpecification[] */
     public function getDataRequirements(): array
     {
         return $this->data_requirements;
     }
-
     public function addDataRequirement(
         DataRequirementSpecification $requirement
     ): void {
@@ -93,4 +95,14 @@ public function addRequirementsFromDynamicData(DynamicExportData $data): void
     {
         array_push($this->data_requirements, ...$data->getRequirements());
     }
+
+    public function getCustomTypesRequirements(): array
+    {
+        return $this->custom_types_requirements;
+    }
+    public function addCustomTypeRequirement(
+        CustomTypeRequirementSpecification $requirement
+    ): void {
+        $this->custom_types_requirements[] = $requirement;
+    }
 }
diff --git a/templates/pages/admin/form/import/step2_preview.html.twig b/templates/pages/admin/form/import/step2_preview.html.twig
@@ -56,13 +56,17 @@
                     </tr>
                 </thead>
                 <tbody>
-                    {% macro render_row(form_id, form_name, status_icon, status_text, show_resolve_issues_action, show_remove_action) %}
+                    {% macro render_row(form_id, form_name, status_icon, messages, show_resolve_issues_action, show_remove_action) %}
                         <tr>
                             <td class="w-50 px-4 align-middle">{{ form_name }}</td>
                             <td class="w-50 px-4 align-middle">
                                 <div class="d-flex align-items-center">
                                     <i class="ti {{ status_icon }} me-2"></i>
-                                    <span>{{ status_text }}</span>
+                                    <div>
+                                        {% for message in messages %}
+                                            <span>{{ message }}</span>
+                                        {% endfor %}
+                                    </div>
                                 </div>
                             </td>
                             <td class="w-25 px-4 align-middle">
@@ -108,7 +112,7 @@
                             form_id,
                             form_name,
                             'ti-check text-success',
-                            __("Ready to be imported"),
+                            [__("Ready to be imported")],
                             false,
                             true
                         ) }}
@@ -118,11 +122,21 @@
                             form_id,
                             form_name,
                             'ti-x text-danger',
-                            __("Can't be imported"),
+                            [__("Can't be imported")],
                             true,
                             true
                         ) }}
                     {% endfor %}
+                    {% for form_id, details in preview.getFormsWithFatalErrors() %}
+                        {{ _self.render_row(
+                            form_id,
+                            details.name,
+                            'ti-x text-danger',
+                            details.errors,
+                            false,
+                            true
+                        ) }}
+                    {% endfor %}
                 </tbody>
             </table>
         </div>
diff --git a/tests/cypress/e2e/form/serializer/import.cy.js b/tests/cypress/e2e/form/serializer/import.cy.js
diff --git a/tests/fixtures/forms/form-with-hammer-asset.json b/tests/fixtures/forms/form-with-hammer-asset.json
diff --git a/tests/functional/Glpi/Form/Export/FormSerializerTest.php b/tests/functional/Glpi/Form/Export/FormSerializerTest.php

Original file line number	Diff line number	Diff line change
`@@ -390,6 +390,14 @@ public function getCapacity(string $classname): ?CapacityInterface`
`390`	`390`	`return $this->capacities[$classname] ?? null;`
`391`	`391`	`}`
`392`	`392`
	`393`	`+ public function isCustomAsset(string $class): bool`
	`394`	`+ {`
	`395`	`+ return str_starts_with(`
	`396`	`+ $class,`
	`397`	`+ AssetDefinition::getCustomObjectNamespace()`
	`398`	`+ );`
	`399`	`+ }`
	`400`	`+`
`393`	`401`	`private function loadConcreteClass(AssetDefinition $definition): void`
`394`	`402`	`{`
`395`	`403`	`$rightname = $definition->getCustomObjectRightname();`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,11 @@ private function previewResponse(`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`$previewResult = $serializer->previewImport($json, $mapper, $skipped_forms);`
`82`		`- if (empty($previewResult->getValidForms()) && empty($previewResult->getInvalidForms())) {`
	`82`	`+ if (`
	`83`	`+ empty($previewResult->getValidForms())`
	`84`	`+ && empty($previewResult->getInvalidForms())`
	`85`	`+ && empty($previewResult->getFormsWithFatalErrors())`
	`86`	`+ ) {`
`83`	`87`	`return new RedirectResponse($request->getBasePath() . '/Form/Import');`
`84`	`88`	`}`
`85`	`89`
Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,14 @@ public function autoloadClass(string $classname): void`
`124`	`124`	`}`
`125`	`125`	`}`
`126`	`126`
	`127`	`+ public function isCustomDropdown(string $class): bool`
	`128`	`+ {`
	`129`	`+ return str_starts_with(`
	`130`	`+ $class,`
	`131`	`+ DropdownDefinition::getCustomObjectNamespace()`
	`132`	`+ );`
	`133`	`+ }`
	`134`	`+`
`127`	`135`	`private function loadConcreteClass(DropdownDefinition $definition): void`
`128`	`136`	`{`
`129`	`137`	`$rightname = $definition->getCustomObjectRightname();`
Original file line number	Diff line number	Diff line change
`@@ -38,4 +38,5 @@`
`38`	`38`	`enum ImportError`
`39`	`39`	`{`
`40`	`40`	`case MISSING_DATA_REQUIREMENT;`
	`41`	`+ case MISSING_CUSTOM_TYPE_REQUIREMENT;`
`41`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,12 +77,14 @@ final class FormContentSpecification`
`77`	`77`	`/** @var DataRequirementSpecification[] $data_requirements */`
`78`	`78`	`public array $data_requirements = [];`
`79`	`79`
	`80`	`+ /** @var CustomTypeRequirementSpecification[] $data_requirements */`
	`81`	`+ public array $custom_types_requirements = [];`
	`82`	`+`
`80`	`83`	`/** @return DataRequirementSpecification[] */`
`81`	`84`	`public function getDataRequirements(): array`
`82`	`85`	`{`
`83`	`86`	`return $this->data_requirements;`
`84`	`87`	`}`
`85`		`-`
`86`	`88`	`public function addDataRequirement(`
`87`	`89`	`DataRequirementSpecification $requirement`
`88`	`90`	`): void {`
`@@ -93,4 +95,14 @@ public function addRequirementsFromDynamicData(DynamicExportData $data): void`
`93`	`95`	`{`
`94`	`96`	`array_push($this->data_requirements, ...$data->getRequirements());`
`95`	`97`	`}`
	`98`	`+`
	`99`	`+ public function getCustomTypesRequirements(): array`
	`100`	`+ {`
	`101`	`+ return $this->custom_types_requirements;`
	`102`	`+ }`
	`103`	`+ public function addCustomTypeRequirement(`
	`104`	`+ CustomTypeRequirementSpecification $requirement`
	`105`	`+ ): void {`
	`106`	`+ $this->custom_types_requirements[] = $requirement;`
	`107`	`+ }`
`96`	`108`	`}`