Changeset 37 for branches/3.0/turbomail/control.py

Timestamp:

10/17/07 04:57:00 (1 year ago)

Author:

amcgregor

Message:

Misc. changes.

Files:

• branches/3.0/turbomail/control.py (modified) (6 diffs)

branches/3.0/turbomail/control.py

@@ -1 +1 @@
 # encoding: utf-8
 
-"""TurboGears extension startup and shutdown interface."""
+"""TurboGears extension startup and shutdown interface.
+
+TurboGears will automatically start and stop TurboMail if you configure
+your application with `mail.on = True`.  To start and stop TurboMail
+in your own applications::
+
+  import turbomail
+  turbomail.interface.start()
+  
+  message = turbomail.Message(...)
+  turbomail.send(message)
+  
+  turbomail.interface.stop()
+
+TurboMail will, by default, immediately delete any messages remaining in
+the queue and wait on any in-progress deliveries.  To block execution and
+allow the queue to empty, pass `blocking=True` as an argument to `stop`.
+"""
 
 import logging
@@ -12 +29 @@
 
 class ControlClass(object):
+        """Control TurboMail startup and shutdown.
+        
+        Dynamically discovers the presence of TurboGears, creating appropriate aliases for
+        TurboGears extension startup and shutdown."""
+        
         def __init__(self):
                 self.running = False
@@ -18 +40 @@
                         import turbogears
                 except ImportError:
-                        self.config = dict()
+                        turbomail.config = dict()
                 else:
-                        self.config = turbogears.config
+                        turbomail.config = turbogears.config
+                        self.start_extension = self.start
+                        self.shutdown_extension = self.stop
         
-        def _load_class(self, classpath):
-                components = classpath.split(':')
-
-                try:
-                        module = __import__(components[0], globals(), locals(), [components[1]])
-                except ImportError:
-                        return None
-                
-                return getattr(module, components[1])
+        def load_single_entry(group, name):
+                for entrypoint in pkg_resources.iter_entry_points("turbogears.command"):
+                        if entrypoint.name == name:
+                                return entrypoint.load()
+                return None
         
-        def start_extension(self):
+        def start(self):
                 """TurboGears extension startup.
 
@@ -39 +59 @@
                 """
                 
-                if not self.config.get("mail.on", False):
+                if not turbomail.config.get("mail.on", False):
                         return
                 
@@ -45 +65 @@
                 
                 # Load the requested pool manager.
-                classpath = self.config.get("mail.manager", "turbomail.managers.demand:DemandManager")
-                turbomail.manager = self._load_class(classpath)(self.config)
+                manager = turbomail.config.get("mail.manager", "demand")
+                turbomail.manager = self.load_single_entry("turbomail.managers", manager)
+                if not turbomail.manager:
+                        turbomail.config.set("mail.on", False)
+                        log.error("Unable to locate %s manager, TurboMail disabled." % manager)
+                        return
+                turbomail.manager.start()
                 
                 # Load the requested mail provider.
-                classpath = self.config.get("")
+                provider = turbomail.config.get("mail.provider", "smtp")
+                turbomail.provider = self.load_single_entry("turbomail.providers", provider)
+                if not turbomail.provider:
+                        turbomail.config.set("mail.on", False)
+                        log.error("Unable to locate %s provider, TurboMail disabled." % provider)
+                        return
+                turbomail.provider.start()
                 
-                if self.config.get("mail.default.encoding", "us-ascii") == "utf-8-qp":
+                # Override the UTF-8 character set to use the quoted printable encoding.
+                if turbomail.config.get("mail.default.encoding", "us-ascii") == "utf-8-qp":
                         Charset.add_charset('utf-8', Charset.SHORTEST, Charset.QP, 'utf-8')
-                        self.config.update({"mail.default.encoding": "utf-8"})
+                        turbomail.config.update({"mail.default.encoding": "utf-8"})
+                
+                # Load and initalize the various extensions.
+                extensions = pkg_resources.iter_entry_points("turbomail.extensions")
+                for entrypoint in extensions:
+                        ext = entrypoint.load()
+                        if hasattr(ext, "start"):
+                                ext.start()
                 
                 self.running = True
         
-        def shutdown_extension(self):
+        def stop(self):
                 """TurboGears extension shutdown.
 
@@ -68 +107 @@
                 log.info("TurboMail extension shutting down.")
                 
+                # Unload the various extensions.
+                extensions = pkg_resources.iter_entry_points("turbomail.extensions")
+                for entrypoint in extensions:
+                        ext = entrypoint.load()
+                        if hasattr(ext, "unload"):
+                                ext.unload()
+                
+                # Unload the provider and manager.
+                turbomail.provider.stop()
+                turbomail.manager.stop()
+                
                 self.running = False