Changeset 40

Timestamp:

10/18/07 01:15:41 (1 year ago)

Author:

amcgregor

Message:

Lots of changes. Minor updates to the Message class, created the immediate manager and the debug provider, and created a sample extension, utf8qp.

Location:

branches/3.0

Files:

• setup.py (modified) (2 diffs)
• turbomail/__init__.py (modified) (1 diff)
• turbomail/api.py (modified) (1 diff)
• turbomail/control.py (modified) (6 diffs)
• turbomail/exceptions.py (modified) (3 diffs)
• turbomail/extensions/utf8qp.py (added)
• turbomail/managers/_base.py (deleted)
• turbomail/managers/demand.py (added)
• turbomail/managers/immediate.py (added)
• turbomail/message.py (modified) (2 diffs)
• turbomail/providers/_base.py (deleted)
• turbomail/providers/debug.py (added)
• turbomail/providers/sink.py (added)

branches/3.0/setup.py

@@ -25 +25 @@
         
                 install_requires = [
-                        "TurboGears >= 1.0"
                         "uuid >= 1.30"
                 ],
@@ -51 +50 @@
                         ],
                         'turbomail.managers': [
-                                "demand = turbomail.managers.demand"
-#                               "polling = turbomail.managers.polling"
+#                               "demand = turbomail.managers.demand",
+#                               "polling = turbomail.managers.polling",
+                                "immediate = turbomail.managers.immediate"
                         ],
                         'turbomail.providers': [
-                                "smtp = turbomail.providers.smtp",
+#                               "smtp = turbomail.providers.smtp",
 #                               "sendmail = turbomail.providers.sendmail"
 #                               "disk = turbomail.providers.disk",
-#                               "debug = turbomail.providers.debug"
+                                "debug = turbomail.providers.debug"
                         ],
                         'turbomail.extensions': [
+                                "utf8qp = turbomail.extensions.utf8qp",
 #                               "smime = turbomail.extensions.smime",
 #                               "gpg = turbomail.extensions.gpg",

branches/3.0/turbomail/__init__.py

@@ -17 +17 @@
 
 from turbomail.message import Message
+from turbomail.control import interface
 
-
-__all__ = ['exceptions', 'extensions', 'managers', 'providers', 'release', 'manager', 'provider', 'config', 'Message']
+__all__ = ['exceptions', 'extensions', 'managers', 'providers', 'release', 'manager', 'provider', 'config', 'Message', 'interface']
 
 

branches/3.0/turbomail/api.py

@@ +1 @@
+# encoding: utf-8
+
+"""TurboMail extension API."""
+
+
+class Extension(object):
+        def __init__(self):
+                super(Extension, self).__init__()
+                self.ready = False
+        
+        def start(self):
+                self.ready = True
+                
+                return True
+        
+        def stop(self):
+                if not self.ready: return False
+                
+                self.ready = False
+                
+                return True
+
+
+class ProviderFactory(Extension):
+        """docstring for ProviderFactory"""
+        provider = None
+        
+        def __init__(self):
+                super(ProviderFactory, self).__init__()
+        
+        def new(self):
+                if not self.ready: return None
+                return self.provider()
+
+
+class Provider(object):
+        """docstring for Provider"""
+        def __init__(self):
+                super(Provider, self).__init__()
+
+        def deliver(self, message):
+                raise NotImplementedError, "Provider plugin must override this method without inheritance."
+
+
+class Manager(Extension):
+        """docstring for Manager"""
+        def __init__(self):
+                super(Manager, self).__init__()
+        
+        def deliver(self, message):
+                if not self.ready: return False
+                return True
+

branches/3.0/turbomail/control.py

@@ -24 +24 @@
 
 import turbomail
+import pkg_resources
 
 __all__ = ['extension']
@@ -46 +47 @@
                         self.shutdown_extension = self.stop
         
-        def load_single_entry(group, name):
-                for entrypoint in pkg_resources.iter_entry_points("turbogears.command"):
-                        if entrypoint.name == name:
-                                return entrypoint.load()
+        def load_single_entry(self, group, name):
+                for entrypoint in pkg_resources.iter_entry_points(group, name):
+                        return entrypoint.load()
                 return None
         
         def start(self):
-                """TurboGears extension startup.
-
-                Exits immediately if TurboMail is not enabled and creates a MailPool
-                instance if all is well.
-                """
+                try:
+                        import turbogears
+                except ImportError:
+                        pass
+                else:
+                        turbomail.config = turbogears.config
                 
                 if not turbomail.config.get("mail.on", False):
@@ -65 +66 @@
                 
                 # Load the requested pool manager.
-                manager = turbomail.config.get("mail.manager", "demand")
-                turbomail.manager = self.load_single_entry("turbomail.managers", manager)
+                manager = turbomail.config.get("mail.manager", "immediate")
+                turbomail.manager = self.load_single_entry("turbomail.managers", manager).load()
                 if not turbomail.manager:
                         turbomail.config.set("mail.on", False)
@@ -74 +75 @@
                 
                 # Load the requested mail provider.
-                provider = turbomail.config.get("mail.provider", "smtp")
-                turbomail.provider = self.load_single_entry("turbomail.providers", provider)
+                provider = turbomail.config.get("mail.provider", "debug")
+                turbomail.provider = self.load_single_entry("turbomail.providers", provider).load()
                 if not turbomail.provider:
                         turbomail.config.set("mail.on", False)
@@ -82 +83 @@
                 turbomail.provider.start()
                 
-                # 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')
-                        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()
+                        log.debug("Found extension '%s'." % entrypoint.name)
+                        if turbomail.config.get("mail." + entrypoint.name + ".on", False):
+                                log.debug("Loading extension '%s'." % entrypoint.name)
+                                ext = entrypoint.load()
+                                if hasattr(ext, "start"): ext.start()
                 
                 self.running = True
         
         def stop(self):
-                """TurboGears extension shutdown.
-
-                Exits immediately if TurboMail is not enabled and shuts down the
-                MailPool object safely.
-                """
-
                 if not self.running: return
                 
@@ -110 +102 @@
                 extensions = pkg_resources.iter_entry_points("turbomail.extensions")
                 for entrypoint in extensions:
-                        ext = entrypoint.load()
-                        if hasattr(ext, "unload"):
-                                ext.unload()
+                        if turbomail.config.get("mail." + entrypoint.name + ".on", False):
+                                ext = entrypoint.load()
+                                if hasattr(ext, "unload"): ext.unload()
                 
                 # Unload the provider and manager.

branches/3.0/turbomail/exceptions.py

@@ -4 +4 @@
 
 
-__all__ = ['MailException', 'MailNotEnabledException', 'MailConfigurationException']
+__all__ = ['MailException', 'MailNotEnabledError', 'MailConfigurationError', 'ProviderException', 'ProviderExhaustedException', 'ManagerException']
 
 
@@ -12 +12 @@
         pass
 
-                
-class MailNotEnabledException(MailException):
+
+class MailNotEnabledError(MailException):
         """Attempted to use TurboMail before being enabled."""
         
@@ -20 +20 @@
                            "framework but outbound mail hasn't been enabled in the " \
                            "config file [via mail.on]."
-        
-        
-class MailConfigurationException(MailException):
+
+
+class MailConfigurationError(MailException):
         """There was an error in the configuration of TurboMail."""
         
-        args = ()
-        def __init__(self, message):
-                self.message= message
-                
+        pass
+
+
+class ProviderException(MailException):
+        """The base for all TurboMail Provider exceptions."""
+        
+        pass
+
+
+class ProviderExhaustedException(MailException):
+        """Attempted to use TurboMail before being enabled."""
+        
         def __str__(self):
-                return self.message
+                return "This Provider instance is no longer capable of delivering mail."
+
+
+class ManagerException(MailException):
+        """The base for all TurboMail Manager exceptions."""
+        
+        pass

branches/3.0/turbomail/message.py

@@ -119 +119 @@
                 if not self._id or (self._processed and self._dirty):
                         self.__dict__['_id'] = str(uuid())
+                        self._processed = False
                 
                 return self._id
@@ -137 +138 @@
                 #if not self._dirty and self._processed:
                 #       return self._mime
-
+                
+                self._processed = False
+                
                 plain = MIMEText(self._callable(self.plain).encode(self.encoding), 'plain', self.encoding)
                 rich = self.rich and MIMEText(self._callable(self.rich).encode(self.encoding), 'html', self.encoding) or None