kitconcept.core 1.0.0__py3-none-any.whl

kitconcept/__init__.py

@@ -0,0 +1,4 @@
+from pkgutil import extend_path
+
+
+__path__ = extend_path(__path__, __name__)

kitconcept/core/__init__.py

@@ -0,0 +1,30 @@
+"""Init and utils."""
+
+from zope.i18nmessageid import MessageFactory
+
+import logging
+
+
+__version__ = "1.0.0"
+
+PACKAGE_NAME = "kitconcept.core"
+DEFAULT_PROFILE = f"{PACKAGE_NAME}:base"
+CMF_DEPENDENCIES_PROFILE = f"{PACKAGE_NAME}:cmfdependencies"
+DEPENDENCIES_PROFILE = f"{PACKAGE_NAME}:dependencies"
+
+_ = MessageFactory(PACKAGE_NAME)
+
+logger = logging.getLogger(PACKAGE_NAME)
+
+
+def initialize(context):
+    from kitconcept.core.tools import migration
+    from Products.CMFPlone.utils import ToolInit
+
+    tools = (migration.MigrationTool,)
+    # Register tools and content
+    ToolInit(
+        "Plone Tool",
+        tools=tools,
+        icon="tool.gif",
+    ).initialize(context)

kitconcept/core/_types.py

@@ -0,0 +1,10 @@
+from typing import TypedDict
+
+
+class DistributionInfo(TypedDict):
+    """Distribution Information."""
+
+    name: str
+    title: str
+    package_name: str
+    package_version: str

kitconcept/core/behaviors/additional_contact_info.py

@@ -0,0 +1,38 @@
+from kitconcept.core import _
+from plone.autoform.directives import read_permission
+from plone.autoform.interfaces import IFormFieldProvider
+from plone.supermodel import directives
+from plone.supermodel import model
+from zope import schema
+from zope.interface import provider
+
+
+PERMISSION = "kitconcept.core.behaviors.additional_contact_info.view"
+
+
+@provider(IFormFieldProvider)
+class IAdditionalContactInfo(model.Schema):
+    read_permission(contact_building=PERMISSION, contact_room=PERMISSION)
+
+    contact_building = schema.TextLine(
+        title=_("label_contact_building", default="Building"),
+        required=False,
+    )
+
+    contact_room = schema.TextLine(
+        title=_("label_contact_room", default="Room"), required=False
+    )
+
+    address = schema.Text(
+        title=_("label_address", default="Address"),
+        required=False,
+    )
+
+    directives.fieldset(
+        "contact_location",
+        label=_(
+            "label_contact_location",
+            default="Location",
+        ),
+        fields=("contact_building", "contact_room", "address"),
+    )

kitconcept/core/behaviors/blocks_settings.py

@@ -0,0 +1,49 @@
+from kitconcept.core import _
+from plone.autoform import directives
+from plone.autoform.interfaces import IFormFieldProvider
+from plone.schema import JSONField
+from plone.supermodel import model
+from zope.interface import provider
+
+import json
+
+
+OBJECT_DEFAULT_VALUE = {}
+
+OBJECT = json.dumps({
+    "type": "object",
+})
+
+
+@provider(IFormFieldProvider)
+class ITTWBlocksSettings(model.Schema):
+    """Through The Web blocks configuration."""
+
+    model.fieldset(
+        "blocksconfiguration",
+        label=_("Blocks configuration"),
+        fields=[
+            "blocks_config_mutator",
+        ],
+    )
+
+    directives.write_permission(
+        blocks_config_mutator="kitconcept.intranet.siteadminsonly"
+    )
+    directives.widget(
+        "blocks_config_mutator",
+        frontendOptions={
+            "widget": "modalJSONEditor",
+        },
+    )
+    blocks_config_mutator = JSONField(
+        title=_("Blocks configuration"),
+        description=_(
+            "help_blocks_config_mutator",
+            default="Configure some aspects of the default blocks configuration.",
+        ),
+        schema=OBJECT,
+        default=OBJECT_DEFAULT_VALUE,
+        required=False,
+        widget="",
+    )

kitconcept/core/behaviors/configure.zcml

@@ -0,0 +1,43 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    xmlns:zcml="http://namespaces.zope.org/zcml"
+    i18n_domain="kitconcept.core"
+    >
+
+  <include
+      package="plone.behavior"
+      file="meta.zcml"
+      />
+
+  <plone:behavior
+      name="kitconcept.blocks.config"
+      title="Through The Web blocks configuration"
+      description="Allows to set configuration that will be injected into the blocks default configuration."
+      provides=".blocks_settings.ITTWBlocksSettings"
+      />
+
+  <!-- Person Behavior -->
+  <plone:behavior
+      name="kitconcept.core.additional_contact_info"
+      title="Person: Additional contact information"
+      description="Fields with additional person information"
+      provides=".additional_contact_info.IAdditionalContactInfo"
+      />
+
+  <plone:behavior
+      name="kitconcept.core.biography"
+      title="Person: Biography information"
+      description="Add a field for a biography."
+      provides=".person_bio.IPersonBiography"
+      />
+
+  <plone:behavior
+      name="kitconcept.core.person_image"
+      title="Person: Image"
+      description="Simple attribute-based image field for persons portraits."
+      provides=".person_image.IPersonImage"
+      />
+
+</configure>

kitconcept/core/behaviors/person_bio.py

@@ -0,0 +1,27 @@
+from collective.person.behaviors.person import IPersonData
+from kitconcept.core import _
+from plone.app.dexterity.textindexer import searchable
+from plone.app.textfield import RichText as RichTextField
+from plone.autoform import directives as form
+from plone.autoform.interfaces import IFormFieldProvider
+from plone.supermodel import model
+from zope.interface import provider
+
+
+@provider(IFormFieldProvider)
+class IPersonBiography(model.Schema):
+    """A behavior to add a biography field to a person."""
+
+    # Hide the existing description field
+    IPersonData["description"].__dict__["readonly"] = True
+
+    text = RichTextField(
+        title=_("label_person_biography", default="Biography"),
+        description=_(
+            "help_person_biography", default="A short biography for this person."
+        ),
+        required=False,
+    )
+    model.primary("text")
+    searchable("text")
+    form.order_after(text="last_name")

kitconcept/core/behaviors/person_image.py

@@ -0,0 +1,17 @@
+from kitconcept.core import _
+from plone.autoform.interfaces import IFormFieldProvider
+from plone.namedfile import field as namedfile
+from plone.supermodel import model
+from zope.interface import provider
+
+
+@provider(IFormFieldProvider)
+class IPersonImage(model.Schema):
+    image = namedfile.NamedBlobImage(
+        title=_("label_person_image", default="Profile Picture/Portrait"),
+        description=_(
+            "help_person_image",
+            default="Use a normal portrait image with your face centered.",
+        ),
+        required=False,
+    )

kitconcept/core/configure.zcml

@@ -0,0 +1,39 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:five="http://namespaces.zope.org/five"
+    xmlns:i18n="http://namespaces.zope.org/i18n"
+    i18n_domain="kitconcept.core"
+    >
+
+  <five:registerPackage
+      package="."
+      initialize=".initialize"
+      />
+
+  <i18n:registerTranslations directory="locales" />
+
+  <include
+      package="Products.CMFCore"
+      file="permissions.zcml"
+      />
+
+
+  <include file="dependencies.zcml" />
+  <include file="profiles.zcml" />
+  <include file="permissions.zcml" />
+
+  <include package=".behaviors" />
+  <include package=".controlpanel" />
+  <include package=".indexers" />
+  <include package=".serializers" />
+  <include package=".services" />
+  <include package=".vocabularies" />
+
+  <utility
+      factory=".factory.LocalAddonList"
+      name="kitconcept.core"
+      />
+
+  <!-- -*- extra stuff goes here -*- -->
+
+</configure>

kitconcept/core/controlpanel/configure.zcml

@@ -0,0 +1,17 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    i18n_domain="kitconcept.core"
+    >
+
+  <adapter
+      factory=".kitconcept.KitconceptControlpanel"
+      name="kitconcept-settings"
+      />
+  <adapter
+      factory=".kitconcept.SiteEndpointExpander"
+      name="kitconcept.core.settings"
+      />
+
+</configure>

kitconcept/core/controlpanel/kitconcept.py

@@ -0,0 +1,61 @@
+from kitconcept.core import _
+from kitconcept.core.interfaces import IBrowserLayer
+from plone.app.registry.browser.controlpanel import ControlPanelFormWrapper
+from plone.app.registry.browser.controlpanel import RegistryEditForm
+from plone.registry.interfaces import IRegistry
+from plone.restapi.controlpanels import RegistryConfigletPanel
+from plone.restapi.interfaces import ISiteEndpointExpander
+from zope import schema
+from zope.component import adapter
+from zope.component import getUtility
+from zope.interface import implementer
+from zope.interface import Interface
+
+
+class IKitconceptSettings(Interface):
+    """kitconcept core settings stored in the backend"""
+
+    custom_css = schema.Text(
+        title=_("Custom CSS"),
+        description=_("Custom CSS for this site."),
+        required=False,
+    )
+
+
+class KitconceptSettingsEditForm(RegistryEditForm):
+    schema = IKitconceptSettings
+    label = _("kitconcept Settings")
+    schema_prefix = "kitconcept.core.settings"
+
+    def updateFields(self):
+        super().updateFields()
+
+    def updateWidgets(self):
+        super().updateWidgets()
+
+
+class KitconceptSettingsControlPanel(ControlPanelFormWrapper):
+    form = KitconceptSettingsEditForm
+
+
+@adapter(Interface, Interface)
+class KitconceptControlpanel(RegistryConfigletPanel):
+    schema = IKitconceptSettings
+    configlet_id = "kitconceptSettings"
+    configlet_category_id = "plone-general"
+    schema_prefix = "kitconcept.core.settings"
+
+
+@adapter(Interface, IBrowserLayer)
+@implementer(ISiteEndpointExpander)
+class SiteEndpointExpander:
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+
+    def __call__(self, data):
+        registry = getUtility(IRegistry)
+        settings = registry.forInterface(
+            IKitconceptSettings, prefix="kitconcept.core.settings"
+        )
+        data["kitconcept.custom_css"] = settings.custom_css

kitconcept/core/dependencies.zcml

@@ -0,0 +1,11 @@
+<configure xmlns="http://namespaces.zope.org/zope">
+
+  <!-- List all packages you depend here -->
+  <include package="plone.restapi" />
+  <include package="plone.volto" />
+  <include package="collective.person" />
+  <include package="kitconcept.voltolighttheme" />
+  <include package="collective.volto.formsupport" />
+  <include package="plonegovbr.socialmedia" />
+
+</configure>

kitconcept/core/factory.py

@@ -0,0 +1,196 @@
+from kitconcept.core import CMF_DEPENDENCIES_PROFILE
+from kitconcept.core import DEFAULT_PROFILE
+from kitconcept.core import DEPENDENCIES_PROFILE
+from kitconcept.core import PACKAGE_NAME
+from kitconcept.core.interfaces import IAddonList
+from plone.base.interfaces.installable import INonInstallable
+from plone.distribution.api import site as site_api
+from Products.CMFPlone.MigrationTool import Addon
+from Products.CMFPlone.MigrationTool import AddonList
+from zope.component.hooks import setSite
+from zope.interface import implementer
+
+
+_PLONE_PACKAGES = [
+    "CMFDefault",
+    "Products.CMFDefault",
+    "CMFPlone",
+    "Products.CMFPlone",
+    "Products.CMFPlone.migrations",
+    "CMFTopic",
+    "Products.CMFTopic",
+    "CMFUid",
+    "Products.CMFUid",
+    "DCWorkflow",
+    "Products.DCWorkflow",
+    "PasswordResetTool",
+    "Products.PasswordResetTool",
+    "PlonePAS",
+    "Products.PlonePAS",
+    "PloneLanguageTool",
+    "Products.PloneLanguageTool",
+    "MimetypesRegistry",
+    "Products.MimetypesRegistry",
+    "PortalTransforms",
+    "Products.PortalTransforms",
+    "CMFDiffTool",
+    "Products.CMFDiffTool",
+    "CMFEditions",
+    "Products.CMFEditions",
+    "Products.NuPlone",
+    "borg.localrole",
+    "plone.app.dexterity",
+    "plone.app.event",
+    "plone.app.intid",
+    "plone.app.linkintegrity",
+    "plone.app.querystring",
+    "plone.app.registry",
+    "plone.app.referenceablebehavior",
+    "plone.app.relationfield",
+    "plone.app.theming",
+    "plone.app.users",
+    "plone.app.z3cform",
+    "plone.formwidget.recurrence",
+    "plone.keyring",
+    "plone.outputfilters",
+    "plone.portlet.static",
+    "plone.portlet.collection",
+    "plone.protect",
+    "plone.resource",
+    "plonetheme.barceloneta",
+    "plone.restapi",
+    "plone.volto",
+    "kitconcept.voltolighttheme",
+    "plonegovbr.socialmedia",
+]
+_PLONE_PROFILES = [
+    "Products.CMFDiffTool:CMFDiffTool",
+    "Products.CMFEditions:CMFEditions",
+    "Products.CMFPlone:dependencies",
+    "Products.CMFPlone:testfixture",
+    "Products.NuPlone:uninstall",
+    "Products.MimetypesRegistry:MimetypesRegistry",
+    "Products.PasswordResetTool:PasswordResetTool",
+    "Products.PortalTransforms:PortalTransforms",
+    "Products.PloneLanguageTool:PloneLanguageTool",
+    "Products.PlonePAS:PlonePAS",
+    "borg.localrole:default",
+    "plone.browserlayer:default",
+    "plone.keyring:default",
+    "plone.outputfilters:default",
+    "plone.portlet.static:default",
+    "plone.portlet.collection:default",
+    "plone.protect:default",
+    "plone.app.contenttypes:default",
+    "plone.app.dexterity:default",
+    "plone.app.event:default",
+    "plone.app.linkintegrity:default",
+    "plone.app.registry:default",
+    "plone.app.relationfield:default",
+    "plone.app.theming:default",
+    "plone.app.users:default",
+    "plone.app.versioningbehavior:default",
+    "plone.app.z3cform:default",
+    "plone.formwidget.recurrence:default",
+    "plone.resource:default",
+    "plone.restapi:default",
+    "plone.volto:default",
+    "kitconcept.voltolighttheme:default",
+    "kitconcept.voltolighttheme:demo",
+    "collective.volto.formsupport:default",
+    "plonegovbr.socialmedia:demo",
+]
+
+
+@implementer(INonInstallable)
+class HiddenProfiles:
+    def getNonInstallableProducts(self):
+        return [PACKAGE_NAME, *_PLONE_PACKAGES]
+
+    def getNonInstallableProfiles(self):
+        """Hide uninstall profile from site-creation and quickinstaller."""
+        return [
+            DEFAULT_PROFILE,
+            CMF_DEPENDENCIES_PROFILE,
+            DEPENDENCIES_PROFILE,
+            *_PLONE_PROFILES,
+        ]
+
+
+@implementer(IAddonList)
+class LocalAddonList:
+    addon_list: AddonList = AddonList([
+        Addon(profile_id="Products.CMFEditions:CMFEditions"),
+        Addon(
+            profile_id="Products.CMFPlacefulWorkflow:CMFPlacefulWorkflow",
+            check_module="Products.CMFPlacefulWorkflow",
+        ),
+        Addon(profile_id="Products.PlonePAS:PlonePAS"),
+        Addon(profile_id="plone.app.caching:default", check_module="plone.app.caching"),
+        Addon(profile_id="plone.app.contenttypes:default"),
+        Addon(profile_id="plone.app.dexterity:default"),
+        Addon(
+            profile_id="plone.app.discussion:default",
+            check_module="plone.app.discussion",
+        ),
+        Addon(profile_id="plone.app.event:default"),
+        Addon(profile_id="plone.app.iterate:default", check_module="plone.app.iterate"),
+        Addon(
+            profile_id="plone.app.multilingual:default",
+            check_module="plone.app.multilingual",
+        ),
+        Addon(profile_id="plone.app.querystring:default"),
+        Addon(profile_id="plone.app.theming:default"),
+        Addon(profile_id="plone.app.users:default"),
+        Addon(profile_id="plone.restapi:default"),
+        Addon(profile_id="plone.session:default"),
+        Addon(profile_id="plone.staticresources:default"),
+        Addon(profile_id="plone.volto:default"),
+        Addon(profile_id="plonetheme.barceloneta:default"),
+        Addon(profile_id="kitconcept.voltolighttheme:default"),
+        Addon(profile_id="collective.person:default"),
+        Addon(profile_id="collective.volto.formsupport:default"),
+        Addon(profile_id="plonegovbr.socialmedia:default"),
+        Addon(profile_id="kitconcept.core:dependencies"),
+    ])
+
+
+def add_site(
+    context,
+    site_id: str,
+    title: str = "kitconcept: Site",
+    description: str = "",
+    profile_id: str = DEFAULT_PROFILE,
+    snapshot: bool = False,
+    content_profile_id: str | None = None,
+    extension_ids: tuple[str] = (),
+    setup_content: bool = False,
+    default_language: str = "de",
+    portal_timezone: str = "UTC",
+    distribution: str = "volto",
+    **kwargs,
+):
+    """Add a PloneSite to the context."""
+
+    # Pass all arguments and keyword arguments in the answers,
+    # But the 'distribution_name' is not needed there.
+    answers = {
+        "site_id": site_id,
+        "title": title,
+        "description": description,
+        "profile_id": profile_id,
+        "snapshot": snapshot,
+        "content_profile_id": content_profile_id,
+        "extension_ids": extension_ids,
+        "setup_content": setup_content,
+        "default_language": default_language,
+        "portal_timezone": portal_timezone,
+    }
+    answers.update(kwargs)
+    site = site_api._create_site(
+        context=context,
+        distribution_name=distribution,
+        answers=answers,
+    )
+    setSite(site)
+    return site

kitconcept/core/indexers/configure.zcml

@@ -0,0 +1,7 @@
+<configure xmlns="http://namespaces.zope.org/zope">
+
+  <!-- Indexers/Metadata -->
+
+  <!-- -*- extra stuff goes here -*- -->
+
+</configure>

kitconcept/core/interfaces.py

@@ -0,0 +1,15 @@
+"""Module where all interfaces, events and exceptions live."""
+
+from Products.CMFPlone.MigrationTool import AddonList
+from zope.interface import Interface
+from zope.publisher.interfaces.browser import IDefaultBrowserLayer
+
+
+class IBrowserLayer(IDefaultBrowserLayer):
+    """Marker interface that defines a browser layer."""
+
+
+class IAddonList(Interface):
+    """List of add ons managed by migration tool."""
+
+    addon_list: AddonList

kitconcept/core/locales/__main__.py

@@ -0,0 +1,69 @@
+"""Update locales."""
+
+from pathlib import Path
+
+import logging
+import re
+import subprocess
+
+
+logger = logging.getLogger("i18n")
+logger.setLevel(logging.DEBUG)
+
+
+PATTERN = r"^[a-z]{2}.*"
+
+locale_path = Path(__file__).parent.resolve()
+target_path = locale_path.parent.resolve()
+domains = [path.name[:-4] for path in locale_path.glob("*.pot")]
+
+i18ndude = "uvx i18ndude"
+
+# ignore node_modules files resulting in errors
+excludes = '"*.html *json-schema*.xml"'
+
+
+def locale_folder_setup(domain: str):
+    languages = [path for path in locale_path.glob("*") if path.is_dir()]
+    for lang_folder in languages:
+        lc_messages_path = lang_folder / "LC_MESSAGES"
+        lang = lang_folder.name
+        if lc_messages_path.exists():
+            continue
+        elif re.match(PATTERN, lang):
+            lc_messages_path.mkdir()
+            cmd = (
+                f"msginit --locale={lang} "
+                f"--input={locale_path}/{domain}.pot "
+                f"--output={locale_path}/{lang}/LC_MESSAGES/{domain}.po"
+            )
+            subprocess.call(cmd, shell=True)  # noQA: S602
+
+
+def _rebuild(domain: str):
+    cmd = (
+        f"{i18ndude} rebuild-pot --pot {locale_path}/{domain}.pot "
+        f"--exclude {excludes} "
+        f"--create {domain} {target_path}"
+    )
+    subprocess.call(cmd, shell=True)  # noQA: S602
+
+
+def _sync(domain: str):
+    cmd = (
+        f"{i18ndude} sync --pot {locale_path}/{domain}.pot "
+        f"{locale_path}/*/LC_MESSAGES/{domain}.po"
+    )
+    subprocess.call(cmd, shell=True)  # noQA: S602
+
+
+def main():
+    for domain in domains:
+        logger.info(f"Updating translations for {domain}")
+        locale_folder_setup(domain)
+        _rebuild(domain)
+        _sync(domain)
+
+
+if __name__ == "__main__":
+    main()