Add patch editing command
[stgit] / stgit / commands / imprt.py
index 5e3eddd..717f373 100644 (file)
@@ -15,33 +15,66 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 """
 
-import sys, os
+import sys, os, re, email
+from mailbox import UnixMailbox
+from StringIO import StringIO
 from optparse import OptionParser, make_option
 
 from stgit.commands.common import *
 from stgit.utils import *
+from stgit.out import *
 from stgit import stack, git
 
 
 help = 'import a GNU diff file as a new patch'
-usage = """%prog [options] [<file>]
+usage = """%prog [options] [<file>|<url>]
 
 Create a new patch and apply the given GNU diff file (or the standard
 input). By default, the file name is used as the patch name but this
-can be overriden with the '--name' option. The patch can either be a
+can be overridden with the '--name' option. The patch can either be a
 normal file with the description at the top or it can have standard
 mail format, the Subject, From and Date headers being used for
-generating the patch information.
+generating the patch information. The command can also read series and
+mbox files.
+
+If a patch does not apply cleanly, the failed diff is written to the
+.stgit-failed.patch file and an empty StGIT patch is added to the
+stack.
 
 The patch description has to be separated from the data with a '---'
-line. For a normal file, if no author information is given, the first
-'Signed-off-by:' line is used."""
+line."""
 
 options = [make_option('-m', '--mail',
                        help = 'import the patch from a standard e-mail file',
                        action = 'store_true'),
+           make_option('-M', '--mbox',
+                       help = 'import a series of patches from an mbox file',
+                       action = 'store_true'),
+           make_option('-s', '--series',
+                       help = 'import a series of patches',
+                       action = 'store_true'),
+           make_option('-u', '--url',
+                       help = 'import a patch from a URL',
+                       action = 'store_true'),
            make_option('-n', '--name',
                        help = 'use NAME as the patch name'),
+           make_option('-t', '--strip',
+                       help = 'strip numbering and extension from patch name',
+                       action = 'store_true'),
+           make_option('-i', '--ignore',
+                       help = 'ignore the applied patches in the series',
+                       action = 'store_true'),
+           make_option('--replace',
+                       help = 'replace the unapplied patches in the series',
+                       action = 'store_true'),
+           make_option('-b', '--base',
+                       help = 'use BASE instead of HEAD for file importing'),
+           make_option('-e', '--edit',
+                       help = 'invoke an editor for the patch description',
+                       action = 'store_true'),
+           make_option('-p', '--showpatch',
+                       help = 'show the patch content in the editor buffer',
+                       action = 'store_true'),
            make_option('-a', '--author', metavar = '"NAME <EMAIL>"',
                        help = 'use "NAME <EMAIL>" as the author details'),
            make_option('--authname',
@@ -53,86 +86,180 @@ options = [make_option('-m', '--mail',
            make_option('--commname',
                        help = 'use COMMNAME as the committer name'),
            make_option('--commemail',
-                       help = 'use COMMEMAIL as the committer e-mail')]
+                       help = 'use COMMEMAIL as the committer e-mail')
+           ] + make_sign_options()
+
+
+def __strip_patch_name(name):
+    stripped = re.sub('^[0-9]+-(.*)$', '\g<1>', name)
+    stripped = re.sub('^(.*)\.(diff|patch)$', '\g<1>', stripped)
+
+    return stripped
+
+def __replace_slashes_with_dashes(name):
+    stripped = name.replace('/', '-')
 
+    return stripped
 
-def __parse_mail(filename = None):
-    """Parse the input file in a mail format and return (description,
-    authname, authemail, authdate)
+def __create_patch(filename, message, author_name, author_email,
+                   author_date, diff, options):
+    """Create a new patch on the stack
+    """
+    if options.name:
+        patch = options.name
+    elif filename:
+        patch = os.path.basename(filename)
+    else:
+        patch = ''
+    if options.strip:
+        patch = __strip_patch_name(patch)
+
+    if not patch:
+        if options.ignore or options.replace:
+            unacceptable_name = lambda name: False
+        else:
+            unacceptable_name = crt_series.patch_exists
+        patch = make_patch_name(message, unacceptable_name)
+    else:
+        # fix possible invalid characters in the patch name
+        patch = re.sub('[^\w.]+', '-', patch).strip('-')
+
+    if options.ignore and patch in crt_series.get_applied():
+        out.info('Ignoring already applied patch "%s"' % patch)
+        return
+    if options.replace and patch in crt_series.get_unapplied():
+        crt_series.delete_patch(patch)
+
+    # refresh_patch() will invoke the editor in this case, with correct
+    # patch content
+    if not message:
+        can_edit = False
+
+    committer_name = committer_email = None
+
+    if options.author:
+        options.authname, options.authemail = name_email(options.author)
+
+    # override the automatically parsed settings
+    if options.authname:
+        author_name = options.authname
+    if options.authemail:
+        author_email = options.authemail
+    if options.authdate:
+        author_date = options.authdate
+    if options.commname:
+        committer_name = options.commname
+    if options.commemail:
+        committer_email = options.commemail
+
+    crt_series.new_patch(patch, message = message, can_edit = False,
+                         author_name = author_name,
+                         author_email = author_email,
+                         author_date = author_date,
+                         committer_name = committer_name,
+                         committer_email = committer_email)
+
+    if not diff:
+        out.warn('No diff found, creating empty patch')
+    else:
+        out.start('Importing patch "%s"' % patch)
+        if options.base:
+            git.apply_patch(diff = diff, base = git_id(options.base))
+        else:
+            git.apply_patch(diff = diff)
+        crt_series.refresh_patch(edit = options.edit,
+                                 show_patch = options.showpatch,
+                                 sign_str = options.sign_str)
+        out.done()
+
+def __import_file(filename, options, patch = None):
+    """Import a patch from a file or standard input
     """
     if filename:
         f = file(filename)
     else:
         f = sys.stdin
 
-    descr = authname = authemail = authdate = None
-
-    # parse the headers
-    for line in f:
-        line = line.strip()
-        if re.match('from:\s+', line, re.I):
-            auth = re.findall('^.*?:\s+(.*)$', line)[0]
-            authname, authemail = name_email(auth)
-        elif re.match('date:\s+', line, re.I):
-            authdate = re.findall('^.*?:\s+(.*)$', line)[0]
-        elif re.match('subject:\s+', line, re.I):
-            descr = re.findall('^.*?:\s+(.*)$', line)[0]
-        elif line == '':
-            # end of headers
-            break
-
-    # remove extra '[*PATCH]', 'name:' in the subject
-    if descr:
-        descr = re.findall('^(\[[^\s]*PATCH.*?\])?\s*([^\s]*:)?\s*(.*)$',
-                           descr)[0][2]
-        descr += '\n\n'
+    if options.mail:
+        try:
+            msg = email.message_from_file(f)
+        except Exception, ex:
+            raise CmdException, 'error parsing the e-mail file: %s' % str(ex)
+        message, author_name, author_email, author_date, diff = \
+                 parse_mail(msg)
     else:
-        raise CmdException, 'Subject: line not found'
-
-    # the rest of the patch description
-    for line in f:
-        if re.match('----*\s*$', line) or re.match('diff -', line):
-            break
-        else:
-            descr += line
-    descr.rstrip()
+        message, author_name, author_email, author_date, diff = \
+                 parse_patch(f)
 
     if filename:
         f.close()
 
-    return (descr, authname, authemail, authdate)
+    if patch:
+        pname = patch
+    else:
+        pname = filename
+
+    __create_patch(pname, message, author_name, author_email,
+                   author_date, diff, options)
 
-def __parse_patch(filename = None):
-    """Parse the input file and return (description, authname,
-    authemail, authdate)
+def __import_series(filename, options):
+    """Import a series of patches
     """
+    applied = crt_series.get_applied()
+
     if filename:
         f = file(filename)
+        patchdir = os.path.dirname(filename)
     else:
         f = sys.stdin
+        patchdir = ''
 
-    authname = authemail = authdate = None
-
-    descr = ''
     for line in f:
-        # the first 'Signed-of-by:' is the author
-        if not authname and re.match('signed-off-by:\s+', line, re.I):
-            auth = re.findall('^.*?:\s+(.*)$', line)[0]
-            authname, authemail = name_email(auth)
-
-        if re.match('----*\s*$', line) or re.match('diff -', line):
-            break
-        else:
-            descr += line
-    descr.rstrip()
+        patch = re.sub('#.*$', '', line).strip()
+        if not patch:
+            continue
+        patchfile = os.path.join(patchdir, patch)
+        patch = __replace_slashes_with_dashes(patch);
 
-    if descr == '':
-        descr = None
+        __import_file(patchfile, options, patch)
 
     if filename:
         f.close()
 
-    return (descr, authname, authemail, authdate)
+def __import_mbox(filename, options):
+    """Import a series from an mbox file
+    """
+    if filename:
+        f = file(filename, 'rb')
+    else:
+        f = StringIO(sys.stdin.read())
+
+    try:
+        mbox = UnixMailbox(f, email.message_from_file)
+    except Exception, ex:
+        raise CmdException, 'error parsing the mbox file: %s' % str(ex)
+
+    for msg in mbox:
+        message, author_name, author_email, author_date, diff = \
+                 parse_mail(msg)
+        __create_patch(None, message, author_name, author_email,
+                       author_date, diff, options)
+
+    f.close()
+
+def __import_url(url, options):
+    """Import a patch from a URL
+    """
+    import urllib
+    import tempfile
+
+    if not url:
+        parser.error('URL argument required')
+
+    patch = os.path.basename(urllib.unquote(url))
+    filename = os.path.join(tempfile.gettempdir(), patch)
+    urllib.urlretrieve(url, filename)
+    __import_file(filename, options)
 
 def func(parser, options, args):
     """Import a GNU diff file as a new patch
@@ -146,51 +273,16 @@ def func(parser, options, args):
 
     if len(args) == 1:
         filename = args[0]
-        patch = os.path.basename(filename)
-    elif options.name:
-        filename = None
-        patch = options.name
     else:
-        raise CmdException, 'Unkown patch name'
-
-    # the defaults
-    message = author_name = author_email = author_date = committer_name = \
-              committer_email = None
-
-    if options.author:
-        options.authname, options.authemail = name_email(options.author)
+        filename = None
 
-    if options.mail:
-        message, author_name, author_email, author_date = \
-                 __parse_mail(filename)
+    if options.series:
+        __import_series(filename, options)
+    elif options.mbox:
+        __import_mbox(filename, options)
+    elif options.url:
+        __import_url(filename, options)
     else:
-        message, author_name, author_email, author_date = \
-                 __parse_patch(filename)
-
-    # override the automatically parsed settings
-    if options.authname:
-        author_name = options.authname
-    if options.authemail:
-        author_email = options.authemail
-    if options.authdate:
-        author_date = options.authdate
-    if options.commname:
-        committer_name = options.commname
-    if options.commemail:
-        committer_email = options.commemail
-
-    crt_series.new_patch(patch, message = message,
-                         author_name = author_name,
-                         author_email = author_email,
-                         author_date = author_date,
-                         committer_name = committer_name,
-                         committer_email = committer_email)
-
-    print 'Importing patch %s...' % patch,
-    sys.stdout.flush()
-
-    git.apply_patch(filename)
-    crt_series.refresh_patch()
+        __import_file(filename, options)
 
-    print 'done'
     print_crt_patch()