Changeset in

Timestamp:

05/02/09 13:38:19 (3 years ago)

Author:

Gartersnake Server <gartersnake@…>

Children:

4bceacf6b979775083c8623c2906a66e95eefe48

Parents:

935fbfb3a362aa24429eff491679842cfb8feb81

git-committer:

Gartersnake Server <gartersnake@gartersnake.precisionconversions.com> / 2009-05-02T13:38:19Z-0700

Message:

Restructured file layout, converted to 'resourcetotrac'

Location:

resourcetotrac

Files:

• resourcetotrac/api.py (modified) (2 diffs)
• resourcetotrac/email/__init__.py (added)
• resourcetotrac/email/api.py (added)
• resourcetotrac/email/imap.py (moved) (moved from resourcetotrac/resourcetotrac/imap.py) (3 diffs)
• resourcetotrac/email/util.py (added)
• resourcetotrac/script.py (modified) (3 diffs)
• setup.py (modified) (1 diff)

resourcetotrac/resourcetotrac/api.py

@@ -17 +17 @@
 # Local imports
 
-__all__ = ['IEmailStore']
-
-class StoreConnectError(StandardError): pass
+__all__ = [
+    'IDataSource',
+    'IResourceSubmitter',
+    'IResourceParser',
+    'ITypeParser',
+    'BaseParsedMessage',
+]
 
 
@@ -62 +66 @@
         """ Submits the resource to Trac """ 
 
+class IResourceParser(Interface):
+    """ Parse a message
+
+    This interface should be subclassed to the specific data source.
+    """
+
+    def match_resource_type(self, resource_type):
+        """ Return whether or not to parse the given resource type """
+
+    def parse_message(self, resource_type, message):
+        """ Parses the message and returns a child instance of
+        BaseParsedMesssage
+        """
+
+class ITypeParser(Interface):
+    """ Extracts the resource type from the message
+    
+    This interface should be subclassed to the specific data source.
+    """
+
+    def get_resource_type(self, msg):
+        """ Returns the resource type or None if it can't identify it """
+    
+
+
 class BaseParsedMessage(object):
     """ Base class for parsed messages.

resourcetotrac/resourcetotrac/email/imap.py

@@ -20 +20 @@
 
 # Local imports
-from emailtoticket.api import IEmailStore, StoreConnectError
+from resourcetotrac.api import IDataSource
+from resourcetotrac.email.api import StoreConnectError, IEmailResourceParser
+from resourcetotrac.email.api import IEmailTypeParser
 
-__all__ = ['IMAPStore']
+__all__ = ['IMAPSource']
 
 RESPONSE = 0
@@ -30 +32 @@
 OK = 'OK'
 
-class IMAPStore(Component):
+class IMAPSource(Component):
 
-    implements(IEmailStore)
+    implements(IDataSource)
 
-    host = Option('email2ticket', 'imap.host', default='localhost',
+    resource_parsers = ExtensionPoint(IEmailResourceParser)
+    type_parsers = ExtensionPoint(IEmailTypeParser)
+
+    host = Option('resource2trac', 'imap.host', default='localhost',
                    doc="Hostname or IP of IMAP server. [default:localhost]")
-    port = IntOption('email2ticket', 'imap.port', default='143',
+    port = IntOption('resource2trac', 'imap.port', default='143',
                    doc="Port to use when connecting to IMAP server. "
                        "[default:143 or 993 if imap.ssl = True]")
-    ssl = BoolOption('email2ticket', 'imap.ssl', default=False,
+    ssl = BoolOption('resource2trac', 'imap.ssl', default=False,
                       doc="Use SSL")
-    user = Option('email2ticket', 'imap.user',
+    user = Option('resource2trac', 'imap.user',
                    doc="Username to use when logging into IMAP")
-    passwd = Option('email2ticket', 'imap.passwd',
+    passwd = Option('resource2trac', 'imap.passwd',
                     doc="IMAP password")
-    def __repr__(self):
-        return 'IMAPStore'
 
-    def __str__(self):
-        return 'IMAPStore'
+    # IDataSource Methods
+    def get_message(self):
+        """ Generator that returns a tuple of (id, email)
 
+        The id parameter is an identifier that can be used to locate the email
+        in the email store.
+
+        The email parameter must be an email.message.Message object
+        """
+        if not self.connected:
+            self.log.debug('Connection timeout.  Retrying connection...')
+            self._connect()
+
+        response = self.cnx.select()
+        if response[RESPONSE] != OK:
+            self.log.debug('Unable to select messages from server')
+        for x in int(response[DATA]):
+            msg = self._parse_message( msg = email.message_from_string(self.cnx.fetch(x, r'(UID RFC822)')[DATA][CONTAINER][MSG])
+            yield (x, parsed_msg)
+        
+
+    def archive_message(self, id, info={}):
+        """ Archive the email with the specified id
+
+        The id is the id retrieved from the call to get_email().
+        """
+        
+        archive = 'INBOX._archive.%d' % ticket
+        response = self.cnx.list(archive)
+        if response[RESPONSE] == OK and response[DATA][0] == 'None':
+            response = self.cnx.create(archive)
+        if response[RESPONSE] == OK:
+            response = self.cnx.select()
+            if response[RESPONSE] == OK:
+                self.cnx.copy(id, archive)
+        pass
+        
+
+    def delete_message(self, id):
+        """ Delete the email from the email store """
+        self.cnx.store(id, '+flags', r'(\Deleted)')
+
+
+    def cleanup(self):
+        self.cnx.expunge()
+
+    # Private Methods
     def _connect(self):
         """ Logs into the IMAP server. """
@@ -85 +132 @@
     connected = property(_test_imap_cnx)
 
+    def _parse_email(self, msg);
+        """ Parses the message returning an instance of the appropriate 
+        BaseParsedMessage subclass
+        """
+        for p in self.type_parsers:
+            resource_type = p.get_resource_type(msg)
+            if resource_type:
+                break
+            continue
+        for p in self.resource_parsers:
+            if p.match_resource_type(resource_type):
+                return p.parse_message(resource_type, msg)
+            continue
+        return None
 
-    def get_email(self):
-        """ Generator that returns a tuple of (id, email)
+    def __repr__(self):
+        return 'IMAPSource'
 
-        The id parameter is an identifier that can be used to locate the email
-        in the email store.
+    def __str__(self):
+        return 'IMAPSource'
 
-        The email parameter must be an email.message.Message object
-        """
-        if not self.connected:
-            self.log.debug('Connection timeout.  Retrying connection...')
-            self._connect()
-
-        response = self.cnx.select()
-        if response[RESPONSE] != OK:
-            self.log.debug('Unable to select messages from server')
-        for x in int(response[DATA]):
-            yield (x, email.message_from_string(self.cnx.fetch(x, r'(UID RFC822)')[DATA][CONTAINER][MSG]))
-        
-
-    def archive_email(self, id, info={}):
-        """ Archive the email with the specified id
-
-        The id is the id retrieved from the call to get_email().
-        """
-        ticket = info.get('ticket', 0)
-        archive = 'INBOX._archive.%d' % ticket
-        response = self.cnx.list(archive)
-        if response[RESPONSE] == OK and response[DATA][0] == 'None':
-            response = self.cnx.create(archive)
-
-        if response[RESPONSE] == OK:
-            self.cnx.copy(id, archive)
-        pass
-        
-
-    def delete_email(self, id):
-        """ Delete the email from the email store """
-        self.cnx.store(id, '+flags', r'(\Deleted)')
-
-
-    def cleanup(self):
-        self.cnx.expunge()

resourcetotrac/resourcetotrac/script.py

@@ -19 +19 @@
 import daemonize
 from trac.env import Environment
-from trac.core import Component
+from trac.core import Component, ExtensionPoint
 from trac.config import OrderedExtensionsOption
 
 # Local imports
-from emailtoticket.api import IEmailStore
-from emailtoticket.util import EmailParser
+from resourcetotrac.api import IDataSource, IResourceSubmitter
 
 
@@ -30 +29 @@
 
 
-__all__ = ['EmailToTicketConfig']
+__all__ = ['ResourceSubmission']
 
 
-class EmailTicketSubmission(Component):
+class ResourceSubmission(Component):
 
     implemnts(IResourceSubmitter)
 
-    email_stores = OrderedExtensionsOption('email2ticket', 'stores', 
-                                           IEmailStore, include_missing=False,
-                                           doc="List of enabled email stores")
+    data_sources = OrderedExtensionsOption('resource2trac', 'sources', 
+                                           IDataSource, include_missing=False,
+                                           doc="List of enabled data sources")
 
-    archive = BoolOption('email2ticket', 'archive', True,
-                         doc="Whether or not to archive the processed emails")
+    resource_submitters = ExtensionPoint(IResourceSubmitter)
 
-    def submit_ticket(self, email):
-        """ Rape the email and submit/update a ticket """
-
-        parser = EmailParser(self.env)
-        subject = parser.get_subject(email)email['Subject'].strip()
-        author_email = parseaddr(email['From'])[1]
-        update = subject[:3].lower() == 're:'
-        if update:
-            subject = subject[3:].strip()
-        
+    archive = BoolOption('resource2trac', 'archive', True,
+                         doc="Whether or not to archive the processed messages")
 
 
-    def process_tickets(self):
-        self.parser
-        for store in self.email_stores:
-            for id, email in store.get_email():
+    def process_resources(self):
+        for src in self.data_sources:
+            for id, msg in src.get_message():
                 try:
-                    info = self.submit_ticket(email)
+                    resource_type = msg.get_type()
+                    for submitter in self.resource_submitters():
+                        if submitter.match_resource_type(resource_type):
+                            break
+                        continue
+                    submitter.submit_resource(resource_type, msg)
                     if self.archive:
-                        store.archive_email(id)
-                    store.delete_email(id)
+                        src.archive_message(id)
+                    src.delete_message(id)
                 except:
-                    self.log.debug('Unable to submit the ticket')
-            store.cleanup()
+                    self.log.debug('Unable to submit the resource')
+            src.cleanup()
             continue
-            
-
 
 
@@ -103 +95 @@
 def main(argv):
     opts = doArgs(argv)
-    emailticket = EmailTicketSubmission(opts.env) 
+    emailticket = ResourceSubmission(opts.env) 
     emailticket.process_tickets()
     return 0

resourcetotrac/setup.py

@@ -27 +27 @@
         resourcetotrac.api = resourcetotrac.api
         resourcetotrac.config = resourcetotrac.config
-        resourcetotrac.imap = resourcetotrac.imap
+        resourcetotrac.email.imap = resourcetotrac.email.imap
     """
 # Currently no package data in use