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, decode_header
  30     from email.utils import parsedate_tz, mktime_tz
  31 except ImportError:
  32     # Python 2.4 compatibility
  33     from email.Header import Header, decode_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', 'X-list']
  40
  41 whitespace_re = re.compile('\s+')
  42 def normalise_space(str):
  43     return whitespace_re.sub(' ', str).strip()
  44
  45 def clean_header(header):
  46     """ Decode (possibly non-ascii) headers """
  47
  48     def decode(fragment):
  49         (frag_str, frag_encoding) = fragment
  50         if frag_encoding:
  51             return frag_str.decode(frag_encoding)
  52         return frag_str.decode()
  53
  54     fragments = map(decode, decode_header(header))
  55
  56     return normalise_space(u' '.join(fragments))
  57
  58 def find_project(mail):
  59     project = None
  60     listid_res = [re.compile('.*<([^>]+)>.*', re.S),
  61                   re.compile('^([\S]+)$', re.S)]
  62
  63     for header in list_id_headers:
  64         if header in mail:
  65
  66             for listid_re in listid_res:
  67                 match = listid_re.match(mail.get(header))
  68                 if match:
  69                     break
  70
  71             if not match:
  72                 continue
  73
  74             listid = match.group(1)
  75
  76             try:
  77                 project = Project.objects.get(listid = listid)
  78                 break
  79             except:
  80                 pass
  81
  82     return project
  83
  84 def find_author(mail):
  85
  86     from_header = clean_header(mail.get('From'))
  87     (name, email) = (None, None)
  88
  89     # tuple of (regex, fn)
  90     #  - where fn returns a (name, email) tuple from the match groups resulting
  91     #    from re.match().groups()
  92     from_res = [
  93         # for "Firstname Lastname" <example@example.com> style addresses
  94        (re.compile('"?(.*?)"?\s*<([^>]+)>'), (lambda g: (g[0], g[1]))),
  95
  96        # for example@example.com (Firstname Lastname) style addresses
  97        (re.compile('"?(.*?)"?\s*\(([^\)]+)\)'), (lambda g: (g[1], g[0]))),
  98
  99        # everything else
 100        (re.compile('(.*)'), (lambda g: (None, g[0]))),
 101     ]
 102
 103     for regex, fn in from_res:
 104         match = regex.match(from_header)
 105         if match:
 106             (name, email) = fn(match.groups())
 107             break
 108
 109     if email is None:
 110         raise Exception("Could not parse From: header")
 111
 112     email = email.strip()
 113     if name is not None:
 114         name = name.strip()
 115
 116     new_person = False
 117
 118     try:
 119         person = Person.objects.get(email__iexact = email)
 120     except Person.DoesNotExist:
 121         person = Person(name = name, email = email)
 122         new_person = True
 123
 124     return (person, new_person)
 125
 126 def mail_date(mail):
 127     t = parsedate_tz(mail.get('Date', ''))
 128     if not t:
 129         return datetime.datetime.utcnow()
 130     return datetime.datetime.utcfromtimestamp(mktime_tz(t))
 131
 132 def mail_headers(mail):
 133     return reduce(operator.__concat__,
 134             ['%s: %s\n' % (k, Header(v, header_name = k, \
 135                     continuation_ws = '\t').encode()) \
 136                 for (k, v) in mail.items()])
 137
 138 def find_content(project, mail):
 139     patchbuf = None
 140     commentbuf = ''
 141
 142     for part in mail.walk():
 143         if part.get_content_maintype() != 'text':
 144             continue
 145
 146         payload = part.get_payload(decode=True)
 147         charset = part.get_content_charset()
 148         subtype = part.get_content_subtype()
 149
 150         # if we don't have a charset, assume utf-8
 151         if charset is None:
 152             charset = 'utf-8'
 153
 154         if not isinstance(payload, unicode):
 155             payload = unicode(payload, charset)
 156
 157         if subtype in ['x-patch', 'x-diff']:
 158             patchbuf = payload
 159
 160         elif subtype == 'plain':
 161             if not patchbuf:
 162                 (patchbuf, c) = parse_patch(payload)
 163             else:
 164                 c = payload
 165
 166             if c is not None:
 167                 commentbuf += c.strip() + '\n'
 168
 169     patch = None
 170     comment = None
 171
 172     if patchbuf:
 173         mail_headers(mail)
 174         name = clean_subject(mail.get('Subject'), [project.linkname])
 175         patch = Patch(name = name, content = patchbuf,
 176                     date = mail_date(mail), headers = mail_headers(mail))
 177
 178     if commentbuf:
 179         if patch:
 180             cpatch = patch
 181         else:
 182             cpatch = find_patch_for_comment(project, mail)
 183             if not cpatch:
 184                 return (None, None)
 185         comment = Comment(patch = cpatch, date = mail_date(mail),
 186                 content = clean_content(commentbuf),
 187                 headers = mail_headers(mail))
 188
 189     return (patch, comment)
 190
 191 def find_patch_for_comment(project, mail):
 192     # construct a list of possible reply message ids
 193     refs = []
 194     if 'In-Reply-To' in mail:
 195         refs.append(mail.get('In-Reply-To'))
 196
 197     if 'References' in mail:
 198         rs = mail.get('References').split()
 199         rs.reverse()
 200         for r in rs:
 201             if r not in refs:
 202                 refs.append(r)
 203
 204     for ref in refs:
 205         patch = None
 206
 207         # first, check for a direct reply
 208         try:
 209             patch = Patch.objects.get(project = project, msgid = ref)
 210             return patch
 211         except Patch.DoesNotExist:
 212             pass
 213
 214         # see if we have comments that refer to a patch
 215         try:
 216             comment = Comment.objects.get(patch__project = project, msgid = ref)
 217             return comment.patch
 218         except Comment.DoesNotExist:
 219             pass
 220
 221
 222     return None
 223
 224 split_re = re.compile('[,\s]+')
 225
 226 def split_prefixes(prefix):
 227     """ Turn a prefix string into a list of prefix tokens
 228
 229     >>> split_prefixes('PATCH')
 230     ['PATCH']
 231     >>> split_prefixes('PATCH,RFC')
 232     ['PATCH', 'RFC']
 233     >>> split_prefixes('')
 234     []
 235     >>> split_prefixes('PATCH,')
 236     ['PATCH']
 237     >>> split_prefixes('PATCH ')
 238     ['PATCH']
 239     >>> split_prefixes('PATCH,RFC')
 240     ['PATCH', 'RFC']
 241     >>> split_prefixes('PATCH 1/2')
 242     ['PATCH', '1/2']
 243     """
 244     matches = split_re.split(prefix)
 245     return [ s for s in matches if s != '' ]
 246
 247 re_re = re.compile('^(re|fwd?)[:\s]\s*', re.I)
 248 prefix_re = re.compile('^\[([^\]]*)\]\s*(.*)$')
 249
 250 def clean_subject(subject, drop_prefixes = None):
 251     """ Clean a Subject: header from an incoming patch.
 252
 253     Removes Re: and Fwd: strings, as well as [PATCH]-style prefixes. By
 254     default, only [PATCH] is removed, and we keep any other bracketed data
 255     in the subject. If drop_prefixes is provided, remove those too,
 256     comparing case-insensitively.
 257
 258     >>> clean_subject('meep')
 259     'meep'
 260     >>> clean_subject('Re: meep')
 261     'meep'
 262     >>> clean_subject('[PATCH] meep')
 263     'meep'
 264     >>> clean_subject('[PATCH] meep \\n meep')
 265     'meep meep'
 266     >>> clean_subject('[PATCH RFC] meep')
 267     '[RFC] meep'
 268     >>> clean_subject('[PATCH,RFC] meep')
 269     '[RFC] meep'
 270     >>> clean_subject('[PATCH,1/2] meep')
 271     '[1/2] meep'
 272     >>> clean_subject('[PATCH RFC 1/2] meep')
 273     '[RFC,1/2] meep'
 274     >>> clean_subject('[PATCH] [RFC] meep')
 275     '[RFC] meep'
 276     >>> clean_subject('[PATCH] [RFC,1/2] meep')
 277     '[RFC,1/2] meep'
 278     >>> clean_subject('[PATCH] [RFC] [1/2] meep')
 279     '[RFC,1/2] meep'
 280     >>> clean_subject('[PATCH] rewrite [a-z] regexes')
 281     'rewrite [a-z] regexes'
 282     >>> clean_subject('[PATCH] [RFC] rewrite [a-z] regexes')
 283     '[RFC] rewrite [a-z] regexes'
 284     >>> clean_subject('[foo] [bar] meep', ['foo'])
 285     '[bar] meep'
 286     >>> clean_subject('[FOO] [bar] meep', ['foo'])
 287     '[bar] meep'
 288     """
 289
 290     if drop_prefixes is None:
 291         drop_prefixes = []
 292     else:
 293         drop_prefixes = [ s.lower() for s in drop_prefixes ]
 294
 295     drop_prefixes.append('patch')
 296
 297     # remove Re:, Fwd:, etc
 298     subject = re_re.sub(' ', subject)
 299
 300     subject = normalise_space(subject)
 301
 302     prefixes = []
 303
 304     match = prefix_re.match(subject)
 305
 306     while match:
 307         prefix_str = match.group(1)
 308         prefixes += [ p for p in split_prefixes(prefix_str) \
 309                         if p.lower() not in drop_prefixes]
 310
 311         subject = match.group(2)
 312         match = prefix_re.match(subject)
 313
 314     subject = normalise_space(subject)
 315
 316     subject = subject.strip()
 317     if prefixes:
 318         subject = '[%s] %s' % (','.join(prefixes), subject)
 319
 320     return subject
 321
 322 sig_re = re.compile('^(-- |_+)\n.*', re.S | re.M)
 323 def clean_content(str):
 324     """ Try to remove signature (-- ) and list footer (_____) cruft """
 325     str = sig_re.sub('', str)
 326     return str.strip()
 327
 328 def parse_mail(mail):
 329
 330     # some basic sanity checks
 331     if 'From' not in mail:
 332         return 0
 333
 334     if 'Subject' not in mail:
 335         return 0
 336
 337     if 'Message-Id' not in mail:
 338         return 0
 339
 340     hint = mail.get('X-Patchwork-Hint', '').lower()
 341     if hint == 'ignore':
 342         return 0;
 343
 344     project = find_project(mail)
 345     if project is None:
 346         print "no project found"
 347         return 0
 348
 349     msgid = mail.get('Message-Id').strip()
 350
 351     (author, save_required) = find_author(mail)
 352
 353     (patch, comment) = find_content(project, mail)
 354
 355     if patch:
 356         # we delay the saving until we know we have a patch.
 357         if save_required:
 358             author.save()
 359             save_required = False
 360         patch.submitter = author
 361         patch.msgid = msgid
 362         patch.project = project
 363         try:
 364             patch.save()
 365         except Exception, ex:
 366             print str(ex)
 367
 368     if comment:
 369         if save_required:
 370             author.save()
 371         # looks like the original constructor for Comment takes the pk
 372         # when the Comment is created. reset it here.
 373         if patch:
 374             comment.patch = patch
 375         comment.submitter = author
 376         comment.msgid = msgid
 377         try:
 378             comment.save()
 379         except Exception, ex:
 380             print str(ex)
 381
 382     return 0
 383
 384 def main(args):
 385     mail = message_from_file(sys.stdin)
 386     return parse_mail(mail)
 387
 388 if __name__ == '__main__':
 389     sys.exit(main(sys.argv))