Configure option to export root settings

context: Some root settings are now exported & imported by default.
Which might cause issues when migrating into an existing site. Allow
users to chose if they need root settings.

Author: ThibautBorn

src/collective/exportimport/export_other.py

@@ -86,6 +86,8 @@
 class BaseExport(BrowserView):
     """Just DRY"""
 
+    show_root_export_option = False
+
     def download(self, data):
         filename = self.request.form.get("filename")
         if not filename:
@@ -427,24 +429,27 @@ def all_translations(self):  # noqa: C901
 class ExportLocalRoles(BaseExport):
     """Export all local roles"""
 
-    def __call__(self, download_to_server=False):
+    show_root_export_option = True
+
+    def __call__(self, download_to_server=False, exclude_root_settings=False):
         self.title = _(u"Export local roles")
         self.download_to_server = download_to_server
         if not self.request.form.get("form.submitted", False):
             return self.index()
 
         logger.info(u"Exporting local roles...")
-        data = self.all_localroles()
+        data = self.all_localroles(exclude_root_settings)
         logger.info(u"Exported local roles for %s items", len(data))
         self.download(data)
 
-    def all_localroles(self):
+    def all_localroles(self, exclude_root_settings=False):
         self.results = []
 
         portal = api.portal.get()
         portal.ZopeFindAndApply(portal, search_sub=True, apply_func=self.get_localroles)
 
-        self.get_root_localroles()
+        if not exclude_root_settings:
+            self.get_root_localroles()
 
         return self.results
 
@@ -520,18 +525,20 @@ def get_position_in_parent(obj, path):
 class ExportDefaultPages(BaseExport):
     """Export all default_page settings."""
 
-    def __call__(self, download_to_server=False):
+    show_root_export_option = True
+
+    def __call__(self, download_to_server=False, exclude_root_settings=False):
         self.title = _(u"Export default pages")
         self.download_to_server = download_to_server
         if not self.request.form.get("form.submitted", False):
             return self.index()
 
         logger.info(u"Exporting default pages...")
-        data = self.all_default_pages()
+        data = self.all_default_pages(exclude_root_settings)
         logger.info(u"Exported %s default pages", len(data))
         self.download(data)
 
-    def all_default_pages(self):
+    def all_default_pages(self, exclude_root_settings=False):
         results = []
         catalog = api.portal.get_tool("portal_catalog")
         for brain in catalog.unrestrictedSearchResults(
@@ -563,14 +570,15 @@ def all_default_pages(self):
                 results.append(data)
 
         # handle portal
-        portal = api.portal.get()
-        try:
-            data = self.get_default_page_info(portal)
-            if data:
-                data["uuid"] = config.SITE_ROOT
-                results.append(data)
-        except Exception:
-            logger.info(u"Error exporting default_page for portal", exc_info=True)
+        if not exclude_root_settings:
+            portal = api.portal.get()
+            try:
+                data = self.get_default_page_info(portal)
+                if data:
+                    data["uuid"] = config.SITE_ROOT
+                    results.append(data)
+            except Exception:
+                logger.info(u"Error exporting default_page for portal", exc_info=True)
 
         return results
 
@@ -642,24 +650,30 @@ def all_discussions(self):
 
 
 class ExportPortlets(BaseExport):
-    def __call__(self, download_to_server=False):
+
+    show_root_export_option = True
+
+    def __call__(self, download_to_server=False, exclude_root_settings=False):
         self.title = _(u"Export portlets")
         self.download_to_server = download_to_server
         if not self.request.form.get("form.submitted", False):
             return self.index()
 
         logger.info(u"Exporting portlets...")
-        data = self.all_portlets()
+        data = self.all_portlets(exclude_root_settings)
         logger.info(u"Exported info for %s items with portlets", len(data))
         self.download(data)
 
-    def all_portlets(self):
+    def all_portlets(self, exclude_root_settings=False):
         self.results = []
         portal = api.portal.get()
         portal.ZopeFindAndApply(
             self.context, search_sub=True, apply_func=self.get_portlets
         )
-        self.get_root_portlets()
+
+        if not exclude_root_settings:
+            self.get_root_portlets()
+
         return self.results
 
     def get_portlets(self, obj, path):

src/collective/exportimport/templates/export_other.pt

@@ -13,6 +13,19 @@
        </h1>
 
         <form action="@@export_other" tal:attributes="action request/URL" method="post" enctype="multipart/form-data">
+            <div class="field mb-3" tal:condition="python: view.show_root_export_option">
+              <div class="form-check">
+                <input class="form-check-input" type="checkbox" name="exclude_root_settings:boolean" id="exclude_root">
+                <label for="exclude_root" class="form-check-label" i18n:translate="">
+                  Do not export portal settings.
+                  <span class="formHelp" i18n:translate="">
+                  When you have exported a folder, instead of the entire portal.
+                </span>
+                </label>
+                </div>
+                <hr>
+            </div>
+:q
             <div class="field mb-3">
               <div class="form-check">
                 <input class="form-check-input" type="radio" name="download_to_server:int" value="0" id="download_local" checked="checked">
@@ -28,6 +41,7 @@
               </div>
             </div>
 
+
             <div class="formControls" class="form-group">
                 <button class="btn btn-primary submit-widget button-field context"
                         type="submit" name="form.submitted" value="Export" tal:content="python: view.title" i18n:attributes="value" i18n:translate="">Export