eea.api.controlpanel 1.0__zip

eea.api.controlpanel-1.0/eea/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+""" Init """
+__import__('pkg_resources').declare_namespace(__name__)

eea.api.controlpanel-1.0/eea/api/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+""" Init """
+__import__('pkg_resources').declare_namespace(__name__)

eea.api.controlpanel-1.0/eea/api/controlpanel/README.txt

@@ -0,0 +1,16 @@
+Overview
+========
+eea.api.controlpanel is a revolutionary plone package that redefines Plone Add-ons.
+
+  * See more: http://github.com/eea/eea.api.controlpanel
+
+
+Installation
+============
+  * Go to admin > Site Setup > Add-ons
+  * Activate eea.api.controlpanel
+
+
+Authors
+=======
+  "European Environment Agency", mailto:eea-edw-a-team-alerts@googlegroups.com

eea.api.controlpanel-1.0/eea/api/controlpanel/__init__.py

@@ -0,0 +1,57 @@
+""" Main product initializer
+"""
+import os
+import logging
+from datetime import datetime
+import transaction
+import Zope2
+from zope.i18nmessageid.message import MessageFactory
+
+logger = logging.getLogger('eea')
+EEAMessageFactory = MessageFactory('eea')
+
+version_record = "eea.api.controlpanel.interfaces.IEEAVersionsBackend.version"
+old_version = "eea.api.controlpanel.interfaces.IEEAVersionsBackend.old_version"
+date_record = "eea.api.controlpanel.interfaces.IEEAVersionsBackend.date"
+version_env = "BACKEND_VERSION"
+
+
+def initialize(context):
+    """Initializer called when used as a Zope 2 product.
+    """
+    root = Zope2.app()
+    sites = root.objectValues("Plone Site")
+    version = os.environ.get(version_env, "")
+
+    if not version:
+        return
+
+    changed = False
+    for site in sites:
+        if not hasattr(site, "portal_registry"):
+            continue
+
+        registry = site.portal_registry
+
+        if version_record not in registry:
+            continue
+
+        if not isinstance(version, str):
+            version = str(version)
+
+        if registry[version_record] != version:
+            registry[old_version] = registry[version_record]
+            registry[version_record] = version
+            registry[date_record] = datetime.now()
+            changed = True
+
+    if changed:
+        transaction.get().note('eea.api.controlpanel: update BACKEND_VERSION')
+        try:
+            transaction.commit()
+        except Exception as err:
+            logger.warning(
+                "BACKEND_VERSION already updated elsewhere: %s", err)
+            transaction.abort()
+        else:
+            logger.info("BACKEND_VERSION updated to: %s", version)

eea.api.controlpanel-1.0/eea/api/controlpanel/browser/__init__.py

@@ -0,0 +1,2 @@
+""" Browser
+"""

eea.api.controlpanel-1.0/eea/api/controlpanel/browser/configure.zcml

@@ -0,0 +1,6 @@
+<configure
+  xmlns="http://namespaces.zope.org/zope"
+  xmlns:browser="http://namespaces.zope.org/browser"
+  i18n_domain="eea">
+
+</configure>

eea.api.controlpanel-1.0/eea/api/controlpanel/configure.zcml

@@ -0,0 +1,14 @@
+<configure
+  xmlns="http://namespaces.zope.org/zope"
+  xmlns:i18n="http://namespaces.zope.org/i18n"
+  i18n_domain="eea">
+
+  <i18n:registerTranslations directory="locales" />
+
+  <include file="profiles.zcml" />
+  <include package=".browser" />
+  <include package=".events" />
+  <include package=".restapi" />
+  <include package=".upgrades" />
+
+</configure>

eea.api.controlpanel-1.0/eea/api/controlpanel/events/configure.zcml

@@ -0,0 +1,9 @@
+<configure xmlns="http://namespaces.zope.org/zope">
+
+  <subscriber
+    for="eea.api.controlpanel.interfaces.IEEAVersionsFrontend
+         plone.registry.interfaces.IRecordModifiedEvent"
+    handler=".handlers.detectVersionChange"
+    />
+
+</configure>

eea.api.controlpanel-1.0/eea/api/controlpanel/events/handlers.py

@@ -0,0 +1,30 @@
+# pylint: disable=W1201, C0301
+"""events module"""
+import logging
+from datetime import datetime
+import transaction
+from plone.api.portal import set_registry_record
+from eea.api.controlpanel.interfaces import IEEAVersionsFrontend
+
+
+logger = logging.getLogger("eea.api.controlpanel")
+
+
+def detectVersionChange(settings, event):
+    """ Frontend vers event subscriber that updates old_version & date record
+    """
+    if event.record.fieldName == 'version':
+        set_registry_record(
+            'date', datetime.now(), interface=IEEAVersionsFrontend)
+        if event.oldValue:
+            set_registry_record(
+                'old_version', event.oldValue, interface=IEEAVersionsFrontend)
+
+        transaction.get().note(
+            "eea.api.controlpanel: updating FRONTEND_VERSION")
+        transaction.commit()
+
+        logger.info(
+            "Frontend version changed from %s to %s",
+            event.oldValue, event.newValue
+        )

eea.api.controlpanel-1.0/eea/api/controlpanel/interfaces.py

@@ -0,0 +1,54 @@
+"""Module where all interfaces, events and exceptions live."""
+
+from zope import schema
+from zope.interface import Interface
+from zope.publisher.interfaces.browser import IDefaultBrowserLayer
+from eea.api.controlpanel import EEAMessageFactory as _
+
+
+class IEeaApiControlpanelLayer(IDefaultBrowserLayer):
+    """Marker interface that defines a browser layer."""
+
+
+class IEEAVersionsBackend(Interface):
+    """ Registry record for the backend versions
+    """
+    date = schema.Datetime(
+        title=_("Date of last version update"),
+        description=("The date when the version was last updated"),
+        required=True
+    )
+
+    version = schema.Text(
+        title=_("Current version"),
+        description=("The latest version that exists"),
+        required=True
+    )
+
+    old_version = schema.Text(
+        title=_("Previous version"),
+        description=("The version that was previously"),
+        required=False
+    )
+
+
+class IEEAVersionsFrontend(Interface):
+    """ Registry record for the frontend versions
+    """
+    date = schema.Datetime(
+        title=_("Date of last version update"),
+        description=("The date when the version was last updated"),
+        required=True
+    )
+
+    version = schema.Text(
+        title=_("Current version"),
+        description=("The latest version that exists"),
+        required=True
+    )
+
+    old_version = schema.Text(
+        title=_("Previous version"),
+        description=("The version that was previously"),
+        required=False
+    )

eea.api.controlpanel-1.0/eea/api/controlpanel/locales/__init__.py

@@ -0,0 +1,2 @@
+""" i18n
+"""

eea.api.controlpanel-1.0/eea/api/controlpanel/locales/update.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+cd $(dirname $0)
+domain=eea
+i18ndude rebuild-pot --pot $domain.pot --create $domain ../../
+i18ndude sync --pot $domain.pot */LC_MESSAGES/$domain.po
+i18ndude sync --pot plone-manual.pot */*/plone.po

eea.api.controlpanel-1.0/eea/api/controlpanel/profiles/default/browserlayer.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<layers>
+  <layer
+      name="eea.api.controlpanel"
+      interface="eea.api.controlpanel.interfaces.IEeaApiControlpanelLayer"
+      />
+</layers>

eea.api.controlpanel-1.0/eea/api/controlpanel/profiles/default/metadata.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata>
+  <version>1.0</version>
+</metadata>

eea.api.controlpanel-1.0/eea/api/controlpanel/profiles/default/registry.xml

@@ -0,0 +1,4 @@
+<registry>
+ <records interface="eea.api.controlpanel.interfaces.IEEAVersionsBackend" />
+ <records interface="eea.api.controlpanel.interfaces.IEEAVersionsFrontend" />
+</registry>

eea.api.controlpanel-1.0/eea/api/controlpanel/profiles/uninstall/browserlayer.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<layers>
+  <layer
+      name="eea.api.controlpanel"
+      remove="true"
+      />
+</layers>