Changeset 5670 for main/waeup.sirp

Timestamp:

25 Jan 2011, 01:10:00 (14 years ago)

Author:

uli

Message:

Add the new applications plugin that installs an ApplicationsRoot on
site creation.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/applications/root.py (modified) (4 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/applications/root.py

@@ -24 +24 @@
 """
 import grok
+from waeup.sirp.interfaces import IWAeUPSIRPPluggable
 from waeup.sirp.applications.interfaces import IApplicationsRoot
 
@@ -30 +31 @@
     """
     grok.implements(IApplicationsRoot)
-    
+
     def addApplicationContainer(self, container, name=None):
         """Add an application container.
@@ -37 +38 @@
         under the name `name`.
 
-        `container` the container instance to be added. Should
+        `container`
+          the container instance to be added. Should
           implement :class:`IApplicationContainer`.
 
@@ -49 +51 @@
         self[name] = container
         return
+
+class ApplicationsPlugin(grok.GlobalUtility):
+    """A WAeUPSIRPPlugin that creates an applications root in portal.
+
+    This plugin should be called by a typical
+    `waeup.sirp.app.Universtiy` instance on creation time. The
+    :meth:`update` method normally can also be triggered manually over
+    the main site configuration.
+
+    Implements :class:`waeup.sirp.interfaces.IWAeUPSIRPPluggable`
+    """
+    grok.name('applications')
+    grok.implements(IWAeUPSIRPPluggable)
+    log_prefix = 'ApplicationsPlugin'
+
+    def setup(self, site, name, logger):
+        """Create a new :class:`ApplicationsRoot` instance in `site`.
+        """
+        site['applications'] = ApplicationsRoot()
+        logger.info(
+            '%s: Installed applications root.' % (self.log_prefix,)
+            )
+        return
+
+    def update(self, site, name, logger):
+        """Update site wide ``applications`` root.
+
+        If the site already contains a suitable ``applications`` root,
+        leave it that way. If not create one and delete the old one if
+        appropriate.
+        """
+        app_folder = site.get('applications', None)
+        site_name = getattr(site, '__name__', 'Unnamed Site?')
+        if IApplicationsRoot.providedBy(app_folder):
+            # Applications up to date. Return.
+            logger.info(
+                '%s: Updating site at %s: Nothing to do.' % (
+                    self.log_prefix, site_name,)
+                )
+            return
+        elif app_folder is not None:
+            # Applications need update. Remove old instance.
+            logger.warn(
+                '%s: Outdated applications folder detected at site %s.'
+                'Removing it.' % (self.log_prefix, site_name)
+                    )
+            del site['applications']
+        # Add new applications.
+        logger.info(
+            '%s: Updating site at %s. Installing '
+            'applications.' % (self.log_prefix, site_name,)
+            )
+        self.setup(site, name, logger)
+        return