[Improvement]: Possibility to include Pimcore core version in JSON export filenames (#1030)

* Update filename format for JSON export response

* add v prefix to version number

* apply to all

Author: kingjia90

CHANGELOG.md

@@ -1,3 +1,7 @@
+#### v2.3.0
+- Added `pimcore_admin:export:add_suffix` configuration option to add the Core version as suffix to exported data object type configuration (e.g. `class_Product_export_v1211.json`).
+
+
 #### v2.1.0
 - Added the possibility to set default values for multi select fields in class definitions.
 

config/pimcore/default.yaml

@@ -11,6 +11,9 @@ pimcore_admin:
     translations:
         path: "@PimcoreCoreBundle/translations"
 
+    export:
+        version_suffix: false
+
     user:
         default_key_bindings:
             save:

src/Controller/Admin/DataObject/ClassController.php

@@ -616,6 +616,19 @@ public function getAllLayoutsAction(Request $request): JsonResponse
         return $this->adminJson(['data' => $resultList]);
     }
 
+    private function getExportFileName(string $prefix, ?string $filename = null, ?bool $add_suffix = null): string
+    {
+        $addVersionSuffix = $add_suffix
+            ?? \Pimcore::getContainer()
+                ->getParameter('pimcore_admin.config')['export']['version_suffix'];
+
+        return sprintf(
+            '%s%s_export%s.json',
+            $prefix,
+            $filename ? '_' . $filename : '',
+            $addVersionSuffix ? '_v' . \Pimcore\Version::getVersion() : ''
+        );
+    }
     #[Route('/export-class', name: 'exportclass', methods: ['GET'])]
     public function exportClassAction(Request $request): Response
     {
@@ -629,11 +642,13 @@ public function exportClassAction(Request $request): Response
             throw $this->createNotFoundException($errorMessage);
         }
 
+        $filename = $this->getExportFileName('class', $class->getName());
+
         $json = DataObject\ClassDefinition\Service::generateClassDefinitionJson($class);
 
         $response = new Response($json);
         $response->headers->set('Content-type', 'application/json');
-        $response->headers->set('Content-Disposition', 'attachment; filename="class_' . $class->getName() . '_export.json"');
+        $response->headers->set('Content-Disposition', 'attachment; filename="' . $filename . '"');
 
         return $response;
     }
@@ -647,11 +662,13 @@ public function exportCustomLayoutDefinitionAction(Request $request): Response
             $customLayout = DataObject\ClassDefinition\CustomLayout::getById($id);
             if ($customLayout) {
                 $name = $customLayout->getName();
+                $filename = $this->getExportFileName('custom_definition', $name);
+
                 $json = DataObject\ClassDefinition\Service::generateCustomLayoutJson($customLayout);
 
                 $response = new Response($json);
                 $response->headers->set('Content-type', 'application/json');
-                $response->headers->set('Content-Disposition', 'attachment; filename="custom_definition_' . $name . '_export.json"');
+                $response->headers->set('Content-Disposition', 'attachment; filename="' . $filename . '"');
 
                 return $response;
             }
@@ -765,10 +782,12 @@ public function exportFieldcollectionAction(Request $request): Response
             throw $this->createNotFoundException($errorMessage);
         }
 
+        $filename = $this->getExportFileName('fieldcollection', $fieldCollection->getKey());
+
         $json = DataObject\ClassDefinition\Service::generateFieldCollectionJson($fieldCollection);
         $response = new Response($json);
         $response->headers->set('Content-type', 'application/json');
-        $response->headers->set('Content-Disposition', 'attachment; filename="fieldcollection_' . $fieldCollection->getKey() . '_export.json"');
+        $response->headers->set('Content-Disposition', 'attachment;  filename="' . $filename . '"');
 
         return $response;
     }
@@ -1117,10 +1136,12 @@ public function exportObjectbrickAction(Request $request): Response
             throw $this->createNotFoundException($errorMessage);
         }
 
+        $filename = $this->getExportFileName('objectbrick', $objectBrick->getKey());
+
         $xml = DataObject\ClassDefinition\Service::generateObjectBrickJson($objectBrick);
         $response = new Response($xml);
         $response->headers->set('Content-type', 'application/json');
-        $response->headers->set('Content-Disposition', 'attachment; filename="objectbrick_' . $objectBrick->getKey() . '_export.json"');
+        $response->headers->set('Content-Disposition', 'attachment; filename="' . $filename . '"');
 
         return $response;
     }
@@ -1629,11 +1650,12 @@ public function doBulkExportAction(Request $request): Response
                 }
             }
         }
+        $filename = $this->getExportFileName('bulk');
 
         $result = json_encode($result, JSON_PRETTY_PRINT);
         $response = new Response($result);
         $response->headers->set('Content-type', 'application/json');
-        $response->headers->set('Content-Disposition', 'attachment; filename="bulk_export.json"');
+        $response->headers->set('Content-Disposition', 'attachment; filename="' . $filename . '"');
 
         return $response;
     }

src/DependencyInjection/Configuration.php

@@ -45,6 +45,13 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->prototype('scalar')
                 ->end()
             ->end()
+            ->arrayNode('export')
+                ->children()
+                    ->booleanNode('version_suffix')
+                        ->defaultFalse()
+                    ->end()
+                ->end()
+            ->end()
             ->arrayNode('csrf_protection')
                 ->addDefaultsIfNotSet()
                 ->children()

src/DependencyInjection/PimcoreAdminExtension.php

@@ -89,6 +89,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->setParameter(self::PARAM_DOCUMENTS_NOTES_EVENTS_TYPES, $config['documents']['notes_events']['types']);
         $container->setParameter('pimcore_admin.csrf_protection.excluded_routes', $config['csrf_protection']['excluded_routes']);
         $container->setParameter('pimcore_admin.admin_languages', $config['admin_languages']);
+        $container->setParameter('pimcore_admin.export', $config['export']);
         $container->setParameter('pimcore_admin.custom_admin_path_identifier', $config['custom_admin_path_identifier']);
         $container->setParameter('pimcore_admin.custom_admin_route_name', $config['custom_admin_route_name']);
         $container->setParameter('pimcore_admin.user', $config['user']);