git.ozlabs.org Git - patchwork/blob - apps/patchwork/bin/parsemail.py

   1 #!/usr/bin/python
   2 #
   3 # Patchwork - automated patch tracking system
   4 # Copyright (C) 2008 Jeremy Kerr <jk@ozlabs.org>
   5 #
   6 # This file is part of the Patchwork package.
   7 #
   8 # Patchwork is free software; you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 2 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Patchwork is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Patchwork; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21
  22 import sys
  23 import re
  24 import datetime
  25 import time
  26 import operator
  27 from email import message_from_file
  28 try:
  29     from email.header import Header
  30     from email.utils import parsedate_tz, mktime_tz
  31 except ImportError:
  32     # Python 2.4 compatibility
  33     from email.Header import Header
  34     from email.Utils import parsedate_tz, mktime_tz
  35
  36 from patchwork.parser import parse_patch
  37 from patchwork.models import Patch, Project, Person, Comment
  38
  39 list_id_headers = ['List-ID', 'X-Mailing-List']
  40
  41 def find_project(mail):
  42     project = None
  43     listid_re = re.compile('.*<([^>]+)>.*', re.S)
  44
  45     for header in list_id_headers:
  46         if header in mail:
  47             match = listid_re.match(mail.get(header))
  48             if not match:
  49                 continue
  50
  51             listid = match.group(1)
  52
  53             try:
  54                 project = Project.objects.get(listid = listid)
  55                 break
  56             except:
  57                 pass
  58
  59     return project
  60
  61 def find_author(mail):
  62
  63     from_header = mail.get('From').strip()
  64     (name, email) = (None, None)
  65
  66     # tuple of (regex, fn)
  67     #  - where fn returns a (name, email) tuple from the match groups resulting
  68     #    from re.match().groups()
  69     from_res = [
  70         # for "Firstname Lastname" <example@example.com> style addresses
  71        (re.compile('"?(.*?)"?\s*<([^>]+)>'), (lambda g: (g[0], g[1]))),
  72
  73        # for example@example.com (Firstname Lastname) style addresses
  74        (re.compile('"?(.*?)"?\s*\(([^\)]+)\)'), (lambda g: (g[1], g[0]))),
  75
  76        # everything else
  77        (re.compile('(.*)'), (lambda g: (None, g[0]))),
  78     ]
  79
  80     for regex, fn in from_res:
  81         match = regex.match(from_header)
  82         if match:
  83             (name, email) = fn(match.groups())
  84             break
  85
  86     if email is None:
  87         raise Exception("Could not parse From: header")
  88
  89     email = email.strip()
  90     if name is not None:
  91         name = name.strip()
  92
  93     new_person = False
  94
  95     try:
  96         person = Person.objects.get(email = email)
  97     except Person.DoesNotExist:
  98         person = Person(name = name, email = email)
  99         new_person = True
 100
 101     return (person, new_person)
 102
 103 def mail_date(mail):
 104     t = parsedate_tz(mail.get('Date', ''))
 105     if not t:
 106         print "using now()"
 107         return datetime.datetime.utcnow()
 108     return datetime.datetime.utcfromtimestamp(mktime_tz(t))
 109
 110 def mail_headers(mail):
 111     return reduce(operator.__concat__,
 112             ['%s: %s\n' % (k, Header(v, header_name = k, \
 113                     continuation_ws = '\t').encode()) \
 114                 for (k, v) in mail.items()])
 115
 116 def find_content(project, mail):
 117     patchbuf = None
 118     commentbuf = ''
 119
 120     for part in mail.walk():
 121         if part.get_content_maintype() != 'text':
 122             continue
 123
 124         #print "\t%s, %s" % \
 125         #    (part.get_content_subtype(), part.get_content_charset())
 126
 127         charset = part.get_content_charset()
 128         if not charset:
 129             charset = mail.get_charset()
 130         if not charset:
 131             charset = 'utf-8'
 132
 133         payload = unicode(part.get_payload(decode=True), charset, "replace")
 134
 135         if part.get_content_subtype() == 'x-patch':
 136             patchbuf = payload
 137
 138         if part.get_content_subtype() == 'plain':
 139             if not patchbuf:
 140                 (patchbuf, c) = parse_patch(payload)
 141             else:
 142                 c = payload
 143
 144             if c is not None:
 145                 commentbuf += c.strip() + '\n'
 146
 147     patch = None
 148     comment = None
 149
 150     if patchbuf:
 151         mail_headers(mail)
 152         name = clean_subject(mail.get('Subject'), [project.linkname])
 153         patch = Patch(name = name, content = patchbuf,
 154                     date = mail_date(mail), headers = mail_headers(mail))
 155
 156     if commentbuf:
 157         if patch:
 158             cpatch = patch
 159         else:
 160             cpatch = find_patch_for_comment(mail)
 161             if not cpatch:
 162                 return (None, None)
 163         comment = Comment(patch = cpatch, date = mail_date(mail),
 164                 content = clean_content(commentbuf),
 165                 headers = mail_headers(mail))
 166
 167     return (patch, comment)
 168
 169 def find_patch_for_comment(mail):
 170     # construct a list of possible reply message ids
 171     refs = []
 172     if 'In-Reply-To' in mail:
 173         refs.append(mail.get('In-Reply-To'))
 174
 175     if 'References' in mail:
 176         rs = mail.get('References').split()
 177         rs.reverse()
 178         for r in rs:
 179             if r not in refs:
 180                 refs.append(r)
 181
 182     for ref in refs:
 183         patch = None
 184
 185         # first, check for a direct reply
 186         try:
 187             patch = Patch.objects.get(msgid = ref)
 188             return patch
 189         except Patch.DoesNotExist:
 190             pass
 191
 192         # see if we have comments that refer to a patch
 193         try:
 194             comment = Comment.objects.get(msgid = ref)
 195             return comment.patch
 196         except Comment.DoesNotExist:
 197             pass
 198
 199
 200     return None
 201
 202 split_re = re.compile('[,\s]+')
 203
 204 def split_prefixes(prefix):
 205     """ Turn a prefix string into a list of prefix tokens
 206
 207     >>> split_prefixes('PATCH')
 208     ['PATCH']
 209     >>> split_prefixes('PATCH,RFC')
 210     ['PATCH', 'RFC']
 211     >>> split_prefixes('')
 212     []
 213     >>> split_prefixes('PATCH,')
 214     ['PATCH']
 215     >>> split_prefixes('PATCH ')
 216     ['PATCH']
 217     >>> split_prefixes('PATCH,RFC')
 218     ['PATCH', 'RFC']
 219     >>> split_prefixes('PATCH 1/2')
 220     ['PATCH', '1/2']
 221     """
 222     matches = split_re.split(prefix)
 223     return [ s for s in matches if s != '' ]
 224
 225 re_re = re.compile('^(re|fwd?)[:\s]\s*', re.I)
 226 prefix_re = re.compile('^\[([^\]]*)\]\s*(.*)$')
 227 whitespace_re = re.compile('\s+')
 228
 229 def clean_subject(subject, drop_prefixes = None):
 230     """ Clean a Subject: header from an incoming patch.
 231
 232     Removes Re: and Fwd: strings, as well as [PATCH]-style prefixes. By
 233     default, only [PATCH] is removed, and we keep any other bracketed data
 234     in the subject. If drop_prefixes is provided, remove those too,
 235     comparing case-insensitively.
 236
 237     >>> clean_subject('meep')
 238     'meep'
 239     >>> clean_subject('Re: meep')
 240     'meep'
 241     >>> clean_subject('[PATCH] meep')
 242     'meep'
 243     >>> clean_subject('[PATCH RFC] meep')
 244     '[RFC] meep'
 245     >>> clean_subject('[PATCH,RFC] meep')
 246     '[RFC] meep'
 247     >>> clean_subject('[PATCH,1/2] meep')
 248     '[1/2] meep'
 249     >>> clean_subject('[PATCH RFC 1/2] meep')
 250     '[RFC,1/2] meep'
 251     >>> clean_subject('[PATCH] [RFC] meep')
 252     '[RFC] meep'
 253     >>> clean_subject('[PATCH] [RFC,1/2] meep')
 254     '[RFC,1/2] meep'
 255     >>> clean_subject('[PATCH] [RFC] [1/2] meep')
 256     '[RFC,1/2] meep'
 257     >>> clean_subject('[PATCH] rewrite [a-z] regexes')
 258     'rewrite [a-z] regexes'
 259     >>> clean_subject('[PATCH] [RFC] rewrite [a-z] regexes')
 260     '[RFC] rewrite [a-z] regexes'
 261     >>> clean_subject('[foo] [bar] meep', ['foo'])
 262     '[bar] meep'
 263     >>> clean_subject('[FOO] [bar] meep', ['foo'])
 264     '[bar] meep'
 265     """
 266
 267     if drop_prefixes is None:
 268         drop_prefixes = []
 269     else:
 270         drop_prefixes = [ s.lower() for s in drop_prefixes ]
 271
 272     drop_prefixes.append('patch')
 273
 274     # remove Re:, Fwd:, etc
 275     subject = re_re.sub(' ', subject)
 276
 277     prefixes = []
 278
 279     match = prefix_re.match(subject)
 280
 281     while match:
 282         prefix_str = match.group(1)
 283         prefixes += [ p for p in split_prefixes(prefix_str) \
 284                         if p.lower() not in drop_prefixes]
 285
 286         subject = match.group(2)
 287         match = prefix_re.match(subject)
 288
 289     subject = whitespace_re.sub(' ', subject)
 290
 291     subject = subject.strip()
 292     if prefixes:
 293         subject = '[%s] %s' % (','.join(prefixes), subject)
 294
 295     return subject
 296
 297 sig_re = re.compile('^(-{2,3} ?|_+)\n.*', re.S | re.M)
 298 def clean_content(str):
 299     str = sig_re.sub('', str)
 300     return str.strip()
 301
 302 def main(args):
 303     mail = message_from_file(sys.stdin)
 304
 305     # some basic sanity checks
 306     if 'From' not in mail:
 307         return 0
 308
 309     if 'Subject' not in mail:
 310         return 0
 311
 312     if 'Message-Id' not in mail:
 313         return 0
 314
 315     hint = mail.get('X-Patchwork-Hint', '').lower()
 316     if hint == 'ignore':
 317         return 0;
 318
 319     project = find_project(mail)
 320     if project is None:
 321         print "no project found"
 322         return 0
 323
 324     msgid = mail.get('Message-Id').strip()
 325
 326     (author, save_required) = find_author(mail)
 327
 328     (patch, comment) = find_content(project, mail)
 329
 330     if patch:
 331         # we delay the saving until we know we have a patch.
 332         if save_required:
 333             author.save()
 334             save_required = False
 335         patch.submitter = author
 336         patch.msgid = msgid
 337         patch.project = project
 338         try:
 339             patch.save()
 340         except Exception, ex:
 341             print str(ex)
 342
 343     if comment:
 344         if save_required:
 345             author.save()
 346         # looks like the original constructor for Comment takes the pk
 347         # when the Comment is created. reset it here.
 348         if patch:
 349             comment.patch = patch
 350         comment.submitter = author
 351         comment.msgid = msgid
 352         try:
 353             comment.save()
 354         except Exception, ex:
 355             print str(ex)
 356
 357     return 0
 358
 359 if __name__ == '__main__':
 360     sys.exit(main(sys.argv))