Import new version from internal git.

This corresponds to sha1 2d1e3ab3a716cc248288bfddb132ea5331591e0b.

Signed-off-by: Nelson Elhage <nelhage@ksplice.com>

Author: nelhage

review

@@ -28,9 +28,15 @@ DOMAIN = 'example.com'
 import sys
 import os
 import optparse
+import posixpath
 import subprocess
 import tempfile
 import git
+import shlex
+import codecs
+from StringIO import StringIO
+from email.message import Message
+from email.header import Header
 
 usage = """
 %%prog -r <reviewer> [-r <another-reviewer>] [-s <summary>] [-m <message>] [options] {<since>|<revision-range>}
@@ -43,24 +49,60 @@ Name a range of commits, or name a single commit (e.g., 'HEAD^' or
 """.strip() % CC_EMAIL
 
 
-def show_usage(args):
-  print >>sys.stderr, usage
-  return 2
+# Monkeypatch a bug in git-python.
+import git.commit, git.repo
+
+def git__commit__Commit__find_all(cls, repo, ref, path=None, **kwargs):
+    options = {'pretty': 'raw'}
+    options.update(kwargs)
+
+    lpath = [p for p in (path,) if p is not None]
+    output = repo.git.rev_list(ref, '--', *lpath, **options)
+    return cls.list_from_string(repo, output)
+git.commit.Commit.find_all = classmethod(git__commit__Commit__find_all)
+
+def git__repo__Repo__commit(self, id, path = None):
+    options = {'max_count': 1}
+
+    commits = git.commit.Commit.find_all(self, id, path, **options)
+
+    if not commits:
+        raise ValueError, 'Invalid identifier %s' % id
+    return commits[0]
+git.repo.Repo.commit = git__repo__Repo__commit
+# End monkeypatch.
+
+
+def check_unicode(option, opt, value):
+  try:
+    return unicode(value, 'utf-8', 'strict')
+  except UnicodeDecodeError:
+    raise optparse.OptionValueError('option %s: invalid UTF-8 string' % opt)
+
+class MyOption(optparse.Option):
+  TYPES = optparse.Option.TYPES + ('unicode',)
+  TYPE_CHECKER = dict(optparse.Option.TYPE_CHECKER, unicode=check_unicode)
 
 
 def parse_options(args):
-  parser = optparse.OptionParser(usage)
-  parser.add_option('-r', '--reviewer', type='string', dest='reviewers', action="append",
+  parser = optparse.OptionParser(usage, option_class=MyOption)
+  parser.add_option('--first-parent', action='store_true', dest='first_parent',
+                    help='follow first parents only')
+  parser.add_option('-r', '--reviewer', type='unicode', dest='reviewers', action="append",
                     help='the person you are asking to do the review')
   parser.add_option('--stdout', action='store_true', dest='stdout',
                     help='send to standard output rather than send mail')
   parser.add_option('--format', type='choice', dest='format',
                     choices=['oneline', 'message', 'patch'],
                     help="'patch' (default for one commit), 'message' (default for more), or 'oneline'")
-  parser.add_option('-s', '--summary', type='string', dest='summary',
+  parser.add_option('-s', '--summary', type='unicode', dest='summary',
                     help='summary for subject line')
-  parser.add_option('-m', '--message', type='string', dest='message',
+  parser.add_option('-m', '--message', type='unicode', dest='message',
                     help='message for body of email')
+  parser.add_option('-t', '--testing', type='unicode', dest='testing',
+                    help='extent and methods of testing employed')
+  parser.add_option('-e', '--edit', action='store_true', dest='edit',
+                    help='spawn $EDITOR and edit review request')
   options, args = parser.parse_args(args)
   if not options.reviewers:
     parser.error('reviewer required')  
@@ -76,68 +118,206 @@ def parse_options(args):
   return options, args
 
 
-def parse_revs(repo, args):
-  if len(args) == 1 and '..' not in args[0]:
-      return list(repo.commits_between(args[0], 'HEAD'))
+def get_default_remote(repo):
+  try:
+    return repo.git.config('--get', 'remotes.default')
+  except git.errors.GitCommandError:
+    try:
+      branch = repo.active_branch
+      return repo.git.config('--get', 'branch.%s.remote' % branch)
+    except git.errors.GitCommandError:
+      return 'origin'
+
+
+def get_reponame(repo):
+  remote = get_default_remote(repo)
+
+  try:
+    url = repo.git.config('--get', 'remote.%s.url' % remote)
+  except git.errors.GitCommandError:
+    url = repo.wd
+
+  name = posixpath.basename(posixpath.normpath(url.split(':', 1)[-1]))
+  if name.endswith('.git'):
+    name = name[:-len('.git')]
+  return name
+
+
+def parse_revs(repo, opts, args):
+  args = repo.git.rev_parse(*args).splitlines()
+  if len(args) == 1:
+      args = ['^' + args[0].lstrip('^'), 'HEAD']
+  if opts.first_parent:
+      args[:0] = ['--first-parent']
   return [repo.commit(c) for c in repo.git.rev_list('--reverse', *args).split()]
 
 
-def write_mail(out, repo, opts, revs):
-  ident = repo.git.var('GIT_AUTHOR_IDENT')
+def make_header(repo, opts, revs):
+  ident = unicode(repo.git.var('GIT_AUTHOR_IDENT'), 'utf-8', 'replace')
   me = ident[:ident.rindex('>') + 1]
-  reponame = os.path.basename(repo.wd)
-  objective_summary = '%d commit(s) to %s' % (len(revs), revs[-1].id_abbrev)
+  reponame = get_reponame(repo)
+
+  remote = get_default_remote(repo)
+  (sha, name) = repo.git.name_rev(revs[-1].id,
+                                  refs='refs/remotes/%s/*' % (remote,),
+                                  always=True).split()
+  prefix = 'remotes/' + remote + "/"
+  if name.startswith(prefix):
+      name = name[len(prefix):]
+      tip_name = '%s (%s)' % (name, revs[-1].id_abbrev)
+  else:
+      print >>sys.stderr, "WARNING: Can't find this commit in remote -- did you push?"
+      tip_name = revs[-1].id_abbrev
+
+  objective_summary = '%d commit(s) to %s' % (len(revs), tip_name)
   summary = ('%s (%s)' % (opts.summary, objective_summary) if opts.summary
              else objective_summary)
 
-  print >>out, 'From: ' + me
-  print >>out, 'To: ' + ', '.join(opts.reviewers)
-  print >>out, 'Cc: ' + CC_EMAIL
-  print >>out, 'Subject: %s review: %s' % (reponame, summary)
-  print >>out
-  print >>out, 'Dear %s,' % ", ".join(opts.reviewers)
-  print >>out
-  print >>out, 'At your convenience, please review the following commits.'
-  print >>out, 'Reply with any comments, or advance master when you are satisfied.'
-  print >>out
+  return [('From', Header(me)),
+          ('To', Header(', '.join(opts.reviewers))),
+          ('Cc', Header(CC_EMAIL)),
+          ('Subject', Header('%s review: %s' % (reponame, summary)))]
+
+
+def write_template(target, repo, opts):
+  ident = unicode(repo.git.var('GIT_AUTHOR_IDENT'), 'utf-8', 'replace')
+  me = ident[:ident.rindex('>') + 1]
+
+  print >>target, 'Dear %s,' % ", ".join(opts.reviewers)
+  print >>target
+  print >>target, 'At your convenience, please review the following commits.'
+  print >>target, 'Reply with any comments, or advance master when you are satisfied.'
+  print >>target
   if opts.message:
-    print >>out, opts.message
-    print >>out
-  print >>out, 'Thanks,'
-  print >>out, me
-  print >>out
-  print >>out
+    print >>target, opts.message
+    print >>target
+  print >>target, 'Testing:',
+  if opts.testing:
+    print >>target, opts.testing
+  else:
+    print >>target, '(No formal testing done, or none specified.)'
+  print >>target
+  print >>target, 'Thanks,'
+  print >>target, me
+
+
+def write_commitmsg(target, repo, opts, revs):
+
   if opts.format == 'oneline':
     for r in revs:
-      print >>out, repo.git.log('-n1', '--oneline', r)
+      print >>target, unicode(repo.git.log('-n1', '--oneline', r), 'utf-8', 'replace')
   elif opts.format == 'message' or opts.format is None and len(revs) > 1:
     for r in revs:
-      print >>out, repo.git.log('-n1', '--stat', r)
-      print >>out
+      if opts.first_parent:
+        print >>target, unicode(repo.git.log('-n1', r), 'utf-8', 'replace')
+        print >>target, unicode(repo.git.diff('--stat', str(r)+'^', r), 'utf-8', 'replace')
+      else:
+        print >>target, unicode(repo.git.log('-n1', '--stat', r), 'utf-8', 'replace')
+      print >>target
   elif opts.format == 'patch' or opts.format is None and len(revs) == 1:
-    print >>out, repo.git.show('--stat', '-p', *revs)
+    for r in revs:
+      if opts.first_parent:
+        print >>target, unicode(repo.git.log('-n1', r), 'utf-8', 'replace')
+        print >>target, unicode(repo.git.diff('--stat', '-p', str(r)+'^', r), 'utf-8', 'replace')
+      else:
+        print >>target, unicode(repo.git.log('-n1', '--stat', '-p', r), 'utf-8', 'replace')
+      print >>target
   else:
-    this_is_an_error
+    raise Exception("Bad format option.")
+
+
+def edit(repo, opts, revs):
+  headers = make_header(repo, opts, revs)
+
+  template = StringIO()
+  commitmsg = StringIO()
+  
+  write_template(template, repo, opts)
+  write_commitmsg(commitmsg, repo, opts, revs)
+  
+  temp = codecs.getwriter('utf-8')(tempfile.NamedTemporaryFile(prefix="review-"))
+
+  # Prepare editable buffer.
+
+  print >>temp, """# This is an editable review request.  All lines beginning with # will
+# be ignored.  To abort the commit, remove all lines from this buffer."""
+  print >>temp, "#"
+  for (key, value) in headers:
+    print >>temp, u"# %s: %s" % (key, value)
+  print >>temp
+  print >>temp, template.getvalue()
+  for line in commitmsg.getvalue().splitlines():
+    print >>temp, "# " + line
+  temp.flush()
+
+  # Open EDITOR to edit buffer.
+
+  editor = os.getenv('EDITOR','emacs')
+  subprocess.check_call(shlex.split(editor) + [temp.name])
+
+  # Check if buffer is empty, and if so abort.
+  
+  if (os.path.getsize(temp.name) == 0):
+    print >>sys.stderr, "Aborting due to empty buffer."
+    sys.exit(2)
+
+  # Reopen temp file, slurp it in, and reconstruct mail.
+
+  final = codecs.open(temp.name, 'r', 'utf-8')
+  msg = Message()
+  for (key, value) in headers:
+    msg[key] = value
+  msg.set_payload(
+    ("".join(line for line in final if not line.startswith("#")).strip() +
+     "\n\n" + commitmsg.getvalue()).encode('utf-8'),
+    'utf-8')
+
+  # Clean up.
+
+  temp.close()
+  final.close()
+  try:
+    os.unlink(temp.name)
+  except OSError:
+    pass
+  return msg
 
 
 def main(args):
   opts, args = parse_options(args)
   repo = git.Repo()
-  revs = parse_revs(repo, args[1:])
+  revs = parse_revs(repo, opts, args[1:])
   if not revs:
     print >>sys.stderr, '%s: no revisions specified' % os.path.basename(args[0])
     return 2
+
+  if opts.edit:
+    msg = edit(repo, opts, revs)
+
+  else: 
+    # Just build the message.
+    msg = Message()
+    for (key, value) in make_header(repo, opts, revs):
+      msg[key] = value
+
+    template = StringIO()
+    commitmsg = StringIO()
+
+    write_template(template, repo, opts)
+    write_commitmsg(commitmsg, repo, opts, revs)
+    msg.set_payload(
+      (template.getvalue() + "\n" + commitmsg.getvalue()).encode('utf-8'),
+      'utf-8')
+
+  # Send or print the message, as appropriate.
   if opts.stdout:
-    out = sys.stdout
+    for (key, value) in msg.items():
+      print >>sys.stdout, u"%s: %s" % (key, value)
+    print >>sys.stdout
+    print >>sys.stdout, msg.get_payload(decode=True),
   else:
-    outfd, outname = tempfile.mkstemp(prefix='review-')
-    out = file(outname, 'w')
-  write_mail(out, repo, opts, revs)
-  if not opts.stdout:
-    out.close()
-    subprocess.check_call(['/usr/sbin/sendmail', '-bm', '-t'],
-                          stdin=file(outname))
-
+    subprocess.Popen(['/usr/sbin/sendmail', '-bm', '-t'],
+                     stdin=subprocess.PIPE).communicate(msg.as_string())
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv))