Update create_site.py to create a site using a distribution.

Author: mauritsvanrees

skeleton/scripts/create_site.py

@@ -1,13 +1,29 @@
 from AccessControl.SecurityManagement import newSecurityManager
-from Products.CMFPlone.factory import _DEFAULT_PROFILE
-from Products.CMFPlone.factory import addPloneSite
+from pathlib import Path
+from plone.distribution.api import site as site_api
 from Testing.makerequest import makerequest
 
-import transaction
+import json
+import logging
 import os
+import transaction
+
+
+logging.basicConfig(format="%(message)s")
 
+# Silence some loggers
+for logger_name in [
+    "GenericSetup.componentregistry",
+    "Products.MimetypesRegistry.MimeTypesRegistry",
+]:
+    logging.getLogger(logger_name).setLevel(logging.ERROR)
 
-truthy = frozenset(('t', 'true', 'y', 'yes', 'on', '1'))
+logger = logging.getLogger("Plone Site Creation")
+logger.setLevel(logging.DEBUG)
+
+SCRIPT_DIR = Path().cwd() / "scripts"
+
+truthy = frozenset(("t", "true", "y", "yes", "on", "1"))
 
 
 def asbool(s):
@@ -22,7 +38,7 @@ def asbool(s):
     return s.lower() in truthy
 
 
-app = makerequest(app)
+app = makerequest(globals()["app"])
 
 request = app.REQUEST
 
@@ -31,56 +47,60 @@ def asbool(s):
 newSecurityManager(None, admin)
 
 # VARS
-TYPE = os.getenv("TYPE", "volto")
-SITE_ID = os.getenv("SITE_ID", "Plone")
-SETUP_CONTENT = asbool(os.getenv("SETUP_CONTENT"))
+ANSWERS = os.getenv("ANSWERS", "default")
 DELETE_EXISTING = asbool(os.getenv("DELETE_EXISTING"))
-LANGUAGE = os.getenv("LANGUAGE", "en")
-TIMEZONE = os.getenv("TIMEZONE", "Europe/Berlin")
-ADDITIONAL_PROFILES = os.getenv("PROFILES", os.getenv("ADDITIONAL_PROFILES", ""))
-
-PROFILES = {
-    "volto": [
-        "plone.app.caching:default",
-        "plonetheme.barceloneta:default",
-        "plone.volto:default",
-        "plone.volto:default-homepage",
-    ],
-    "classic": [
-        "plone.app.caching:default",
-        "plonetheme.barceloneta:default",
-    ],
-}
-
-
-def profile_ids(site_type):
-    extension_ids = PROFILES[site_type]
-    if ADDITIONAL_PROFILES:
-        extension_ids.extend(
-            [
-                profile.strip()
-                for profile in ADDITIONAL_PROFILES.split(" ")
-                if profile.strip()
-            ]
-        )
-    return extension_ids
-
-
-payload = {
-    "title": "Plone",
-    "profile_id": _DEFAULT_PROFILE,
-    "extension_ids": profile_ids(TYPE),
-    "setup_content": SETUP_CONTENT,
-    "default_language": LANGUAGE,
-    "portal_timezone": TIMEZONE,
-}
-
-if SITE_ID in app.objectIds() and DELETE_EXISTING:
-    app.manage_delObjects([SITE_ID])
+DISTRIBUTION = os.getenv("DISTRIBUTION", "")
+
+if not DISTRIBUTION:
+    # We used to support setting TYPE 'volto' or 'classic'.
+    TYPE = os.getenv("TYPE", "")
+    if TYPE == "classic":
+        DISTRIBUTION = "classic"
+    elif TYPE == "volto":
+        DISTRIBUTION = "default"
+
+# Load default site creation parameters
+answers_file = SCRIPT_DIR / f"{ANSWERS}.json"
+answers = json.loads(answers_file.read_text())
+
+# Override the defaults from the OS environment
+if DISTRIBUTION:
+    answers["distribution"] = DISTRIBUTION
+SITE_ID = os.getenv("SITE_ID")
+if SITE_ID:
+    answers["site_id"] = SITE_ID
+LANGUAGE = os.getenv("LANGUAGE")
+if LANGUAGE:
+    answers["default_language"] = LANGUAGE
+SETUP_CONTENT = os.getenv("SETUP_CONTENT")
+if SETUP_CONTENT is not None:
+    answers["setup_content"] = asbool(SETUP_CONTENT)
+TIMEZONE = os.getenv("TIMEZONE")
+if TIMEZONE:
+    answers["portal_timezone"] = TIMEZONE
+
+# Get the final site_id and distribution from the updated answers.
+site_id = answers["site_id"]
+DISTRIBUTION = answers["distribution"]
+logger.info(f"Creating a new Plone site  @ {site_id}")
+logger.info(f" - Using the {DISTRIBUTION} distribution and answers from {answers_file}")
+
+
+if site_id in app.objectIds() and DELETE_EXISTING:
+    app.manage_delObjects([site_id])
     transaction.commit()
     app._p_jar.sync()
-
-if SITE_ID not in app.objectIds():
-    site = addPloneSite(app, SITE_ID, **payload)
+    logger.info(f" - Deleted existing site with id {site_id}")
+else:
+    logger.info(
+        f" - Stopping site creation, as there is already a site with id {site_id}. "
+        "Set DELETE_EXISTING=1 to delete the existing site before creating a new one."
+    )
+
+if site_id not in app.objectIds():
+    site = site_api._create_site(
+        context=app, distribution_name=DISTRIBUTION, answers=answers
+    )
     transaction.commit()
     app._p_jar.sync()
+    logger.info(" - Site created!")

skeleton/scripts/default.json

@@ -0,0 +1,8 @@
+{
+  "site_id": "Plone",
+  "title": "Welcome to Plone 6",
+  "description": "Site created with a new Plone Distribution",
+  "default_language": "en",
+  "portal_timezone": "Europe/Berlin",
+  "setup_content": true
+}