rework for readability

Author: gotcha

CHANGES.rst

@@ -5,12 +5,12 @@ Changelog
 1.16 (unreleased)
 -----------------
 
-- Skip setting a default page if the default is already set to the same value. 
+- Skip setting a default page if the default is already set to the same value.
   [mamico]
 - Fixed data extraction of Archetypes ATFilefields to concatenate all `Pdata` chunks, when the FileField data was still stored in Filestorage and not not migrated to use blobstorage (using plone.app.blobs).
   [@jnptk]
 - Bugfix to prevent clearing existing relations from catalog when migrating into sites with existing content [ThibautBorn]
-- Add option to export portal settings (local roles, default pages, portlets) [ThibautBorn]
+- Enable option to not export the portal settings (local roles, default pages, portlets) [ThibautBorn]
 
 1.15 (2025-07-15)
 -----------------

src/collective/exportimport/export_other.py

@@ -30,6 +30,7 @@
 from zope.component import getUtility
 from zope.component import queryMultiAdapter
 from zope.component import queryUtility
+from zope.deprecation import deprecation
 from zope.interface import providedBy
 
 import json
@@ -86,7 +87,7 @@
 class BaseExport(BrowserView):
     """Just DRY"""
 
-    show_root_export_option = False
+    show_export_portal_option = False
 
     def download(self, data):
         filename = self.request.form.get("filename")
@@ -429,27 +430,31 @@ def all_translations(self):  # noqa: C901
 class ExportLocalRoles(BaseExport):
     """Export all local roles"""
 
-    show_root_export_option = True
+    show_export_portal_option = True
 
-    def __call__(self, download_to_server=False, exclude_root_settings=False):
+    # Because an unticked HTML checkbox is not included in the HTTP request,
+    # the default (ie not present) value has to be False.
+    # This mandates exclude_portal=False instead of more readable export_portal=True.
+    def __call__(self, download_to_server=False, exclude_portal=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(exclude_root_settings)
+        export_portal = not exclude_portal
+        data = self.all_localroles(export_portal)
         logger.info(u"Exported local roles for %s items", len(data))
         self.download(data)
 
-    def all_localroles(self, exclude_root_settings=False):
+    def all_localroles(self, export_portal=True):
         self.results = []
 
         portal = api.portal.get()
         portal.ZopeFindAndApply(portal, search_sub=True, apply_func=self.get_localroles)
 
-        if not exclude_root_settings:
-            self.get_root_localroles()
+        if export_portal:
+            self.get_portal_localroles()
 
         return self.results
 
@@ -478,10 +483,12 @@ def _get_localroles(self, obj, uid):
                 return
             self.results.append(item)
 
-    def get_root_localroles(self):
+    def get_portal_localroles(self):
         site = api.portal.get()
         self._get_localroles(site, PORTAL_PLACEHOLDER)
 
+    get_root_localroles = deprecation.deprecated(get_portal_localroles, 'get_root_localroles renamed to get_portal_localroles')
+
     def item_hook(self, item):
         return item
 
@@ -525,20 +532,24 @@ def get_position_in_parent(obj, path):
 class ExportDefaultPages(BaseExport):
     """Export all default_page settings."""
 
-    show_root_export_option = True
+    show_export_portal_option = True
 
-    def __call__(self, download_to_server=False, exclude_root_settings=False):
+    # Because an unticked HTML checkbox is not included in the HTTP request,
+    # the default (ie not present) value has to be False.
+    # This mandates exclude_portal=False instead of more readable export_portal=True.
+    def __call__(self, download_to_server=False, exclude_portal=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(exclude_root_settings)
+        export_portal = not exclude_portal
+        data = self.all_default_pages(export_portal)
         logger.info(u"Exported %s default pages", len(data))
         self.download(data)
 
-    def all_default_pages(self, exclude_root_settings=False):
+    def all_default_pages(self, export_portal=True):
         results = []
         catalog = api.portal.get_tool("portal_catalog")
         for brain in catalog.unrestrictedSearchResults(
@@ -553,11 +564,11 @@ def all_default_pages(self, exclude_root_settings=False):
                 logger.error(u"brain.getObject() is None %s", brain.getPath())
                 continue
             if IPloneSiteRoot.providedBy(obj):
-                # Site root is handled below (in Plone 6 it is returned by a catalog search)
+                # Portal is handled below (in Plone 6 it is returned by a catalog search)
                 continue
 
             try:
-                data = self.get_default_page_info(obj)
+                data = get_default_page_info(obj)
             except Exception:
                 logger.info(
                     u"Error exporting default_page for %s",
@@ -570,40 +581,43 @@ def all_default_pages(self, exclude_root_settings=False):
                 results.append(data)
 
         # handle portal
-        if not exclude_root_settings:
+        if export_portal:
             portal = api.portal.get()
             try:
-                data = self.get_default_page_info(portal)
-                if data:
-                    data["uuid"] = config.SITE_ROOT
-                    results.append(data)
+                portal_data = get_default_page_info(portal)
+                if portal_data:
+                    portal_data["uuid"] = config.SITE_ROOT
+                    results.append(portal_data)
             except Exception:
                 logger.info(u"Error exporting default_page for portal", exc_info=True)
-
         return results
 
     def get_default_page_info(self, obj):
-        uid = IUUID(obj, None)
+        return get_default_page_info(obj)
 
-        # We use a simplified method to only get index_html
-        # and the property default_page on the object.
-        # We don't care about other cases
-        # 1. obj is folderish, check for a index_html in it
-        if "index_html" in obj:
-            default_page = "index_html"
-        else:
-            # 2. Check attribute 'default_page'
-            default_page = getattr(aq_base(obj), "default_page", [])
-
-        if default_page and default_page in obj:
-            default_page_obj = obj.get(default_page)
-            if default_page_obj:
-                default_page_uid = IUUID(default_page_obj, None)
-                return {
-                    "uuid": uid,
-                    "default_page": default_page,
-                    "default_page_uuid": default_page_uid,
-                }
+
+def get_default_page_info(obj):
+    uid = IUUID(obj, None)
+
+    # We use a simplified method to only get index_html
+    # and the property default_page on the object.
+    # We don't care about other cases
+    # 1. obj is folderish, check for a index_html in it
+    if "index_html" in obj:
+        default_page = "index_html"
+    else:
+        # 2. Check attribute 'default_page'
+        default_page = getattr(aq_base(obj), "default_page", [])
+
+    if default_page and default_page in obj:
+        default_page_obj = obj.get(default_page)
+        if default_page_obj:
+            default_page_uid = IUUID(default_page_obj, None)
+            return {
+                "uuid": uid,
+                "default_page": default_page,
+                "default_page_uuid": default_page_uid,
+            }
 
 
 if HAS_DISCUSSION:  # noqa: C901
@@ -651,28 +665,32 @@ def all_discussions(self):
 
 class ExportPortlets(BaseExport):
 
-    show_root_export_option = True
+    show_export_portal_option = True
 
-    def __call__(self, download_to_server=False, exclude_root_settings=False):
+    # Because an unticked HTML checkbox is not included in the HTTP request,
+    # the default (ie not present) value has to be False.
+    # This mandates exclude_portal=False instead of more readable export_portal=True.
+    def __call__(self, download_to_server=False, exclude_portal=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(exclude_root_settings)
+        export_portal = not exclude_portal
+        data = self.all_portlets(export_portal)
         logger.info(u"Exported info for %s items with portlets", len(data))
         self.download(data)
 
-    def all_portlets(self, exclude_root_settings=False):
+    def all_portlets(self, export_portal=True):
         self.results = []
         portal = api.portal.get()
         portal.ZopeFindAndApply(
             self.context, search_sub=True, apply_func=self.get_portlets
         )
 
-        if not exclude_root_settings:
-            self.get_root_portlets()
+        if export_portal:
+            self.get_portal_portlets()
 
         return self.results
 
@@ -698,11 +716,13 @@ def _get_portlets(self, obj, uid):
             self.results.append(obj_results)
         return
 
-    def get_root_portlets(self):
+    def get_portal_portlets(self):
         site = api.portal.get()
         self._get_portlets(site, PORTAL_PLACEHOLDER)
         return
 
+    get_root_portlets = deprecation.deprecated(get_portal_portlets, 'get_root_portlets renamed get_portal_portlets')
+
     def local_portlets_hook(self, portlets):
         return portlets
 

src/collective/exportimport/templates/export_other.pt

@@ -13,10 +13,10 @@
        </h1>
 
         <form action="@@export_other" tal:attributes="action request/URL" method="post" enctype="multipart/form-data">
-            <div class="field mb-3" tal:condition="python: getattr(view, 'show_root_export_option', False)">
+            <div class="field mb-3" tal:condition="python: getattr(view, 'show_export_portal_option', False)">
               <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="">
+                <input class="form-check-input" type="checkbox" name="exclude_portal:boolean" id="exclude_portal">
+                <label for="exclude_portal" 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.
@@ -26,7 +26,7 @@
                 <hr>
             </div>
 
-	    <div class="field mb-3">
+            <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">
                 <label for="download_local" class="form-check-label" i18n:translate="">