2 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License version 2 as
6 published by the Free Software Foundation.
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
13 You should have received a copy of the GNU General Public License
14 along with this program; if not, write to the Free Software
15 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 import sys, os, re, email, tarfile
19 from mailbox import UnixMailbox
20 from StringIO import StringIO
21 from stgit.argparse import opt
22 from stgit.commands.common import *
23 from stgit.utils import *
24 from stgit.out import *
25 from stgit import argparse, stack, git
28 help = 'Import a GNU diff file as a new patch'
30 usage = ['[options] [<file>|<url>]']
32 Create a new patch and apply the given GNU diff file (or the standard
33 input). By default, the file name is used as the patch name but this
34 can be overridden with the '--name' option. The patch can either be a
35 normal file with the description at the top or it can have standard
36 mail format, the Subject, From and Date headers being used for
37 generating the patch information. The command can also read series and
40 If a patch does not apply cleanly, the failed diff is written to the
41 .stgit-failed.patch file and an empty StGIT patch is added to the
44 The patch description has to be separated from the data with a '---'
47 args = [argparse.files]
49 opt('-m', '--mail', action = 'store_true',
50 short = 'Import the patch from a standard e-mail file'),
51 opt('-M', '--mbox', action = 'store_true',
52 short = 'Import a series of patches from an mbox file'),
53 opt('-s', '--series', action = 'store_true',
54 short = 'Import a series of patches', long = """
55 Import a series of patches from a series file or a tar archive."""),
56 opt('-u', '--url', action = 'store_true',
57 short = 'Import a patch from a URL'),
59 short = 'Use NAME as the patch name'),
60 opt('-p', '--strip', type = 'int', metavar = 'N',
61 short = 'Remove N leading slashes from diff paths (default 1)'),
62 opt('-t', '--stripname', action = 'store_true',
63 short = 'Strip numbering and extension from patch name'),
64 opt('-i', '--ignore', action = 'store_true',
65 short = 'Ignore the applied patches in the series'),
66 opt('--replace', action = 'store_true',
67 short = 'Replace the unapplied patches in the series'),
68 opt('-b', '--base', args = [argparse.commit],
69 short = 'Use BASE instead of HEAD for file importing'),
70 opt('--reject', action = 'store_true',
71 short = 'leave the rejected hunks in corresponding *.rej files'),
72 opt('-e', '--edit', action = 'store_true',
73 short = 'Invoke an editor for the patch description'),
74 opt('-d', '--showdiff', action = 'store_true',
75 short = 'Show the patch content in the editor buffer'),
76 opt('-a', '--author', metavar = '"NAME <EMAIL>"',
77 short = 'Use "NAME <EMAIL>" as the author details'),
79 short = 'Use AUTHNAME as the author name'),
81 short = 'Use AUTHEMAIL as the author e-mail'),
83 short = 'Use AUTHDATE as the author date'),
84 ] + argparse.sign_options()
86 directory = DirectoryHasRepository(log = True)
88 def __strip_patch_name(name):
89 stripped = re.sub('^[0-9]+-(.*)$', '\g<1>', name)
90 stripped = re.sub('^(.*)\.(diff|patch)$', '\g<1>', stripped)
94 def __replace_slashes_with_dashes(name):
95 stripped = name.replace('/', '-')
99 def __create_patch(filename, message, author_name, author_email,
100 author_date, diff, options):
101 """Create a new patch on the stack
106 patch = os.path.basename(filename)
109 if options.stripname:
110 patch = __strip_patch_name(patch)
113 if options.ignore or options.replace:
114 unacceptable_name = lambda name: False
116 unacceptable_name = crt_series.patch_exists
117 patch = make_patch_name(message, unacceptable_name)
119 # fix possible invalid characters in the patch name
120 patch = re.sub('[^\w.]+', '-', patch).strip('-')
122 if options.ignore and patch in crt_series.get_applied():
123 out.info('Ignoring already applied patch "%s"' % patch)
125 if options.replace and patch in crt_series.get_unapplied():
126 crt_series.delete_patch(patch, keep_log = True)
128 # refresh_patch() will invoke the editor in this case, with correct
134 options.authname, options.authemail = name_email(options.author)
136 # override the automatically parsed settings
138 author_name = options.authname
139 if options.authemail:
140 author_email = options.authemail
142 author_date = options.authdate
144 crt_series.new_patch(patch, message = message, can_edit = False,
145 author_name = author_name,
146 author_email = author_email,
147 author_date = author_date)
150 out.warn('No diff found, creating empty patch')
152 out.start('Importing patch "%s"' % patch)
154 base = git_id(crt_series, options.base)
157 git.apply_patch(diff = diff, base = base, reject = options.reject,
158 strip = options.strip)
159 crt_series.refresh_patch(edit = options.edit,
160 show_patch = options.showdiff,
161 sign_str = options.sign_str,
165 def __mkpatchname(name, suffix):
166 if name.lower().endswith(suffix.lower()):
167 return name[:-len(suffix)]
170 def __get_handle_and_name(filename):
171 """Return a file object and a patch name derived from filename
173 # see if it's a gzip'ed or bzip2'ed patch
175 for copen, ext in [(gzip.open, '.gz'), (bz2.BZ2File, '.bz2')]:
180 return (f, __mkpatchname(filename, ext))
185 return (open(filename), filename)
187 def __import_file(filename, options, patch = None):
188 """Import a patch from a file or standard input
192 (f, pname) = __get_handle_and_name(filename)
203 msg = email.message_from_file(f)
204 except Exception, ex:
205 raise CmdException, 'error parsing the e-mail file: %s' % str(ex)
206 message, author_name, author_email, author_date, diff = \
209 message, author_name, author_email, author_date, diff = \
210 parse_patch(f.read(), contains_diff = True)
215 __create_patch(pname, message, author_name, author_email,
216 author_date, diff, options)
218 def __import_series(filename, options):
219 """Import a series of patches
221 applied = crt_series.get_applied()
224 if tarfile.is_tarfile(filename):
225 __import_tarfile(filename, options)
228 patchdir = os.path.dirname(filename)
234 patch = re.sub('#.*$', '', line).strip()
237 patchfile = os.path.join(patchdir, patch)
238 patch = __replace_slashes_with_dashes(patch);
240 __import_file(patchfile, options, patch)
245 def __import_mbox(filename, options):
246 """Import a series from an mbox file
249 f = file(filename, 'rb')
251 f = StringIO(sys.stdin.read())
254 mbox = UnixMailbox(f, email.message_from_file)
255 except Exception, ex:
256 raise CmdException, 'error parsing the mbox file: %s' % str(ex)
259 message, author_name, author_email, author_date, diff = \
261 __create_patch(None, message, author_name, author_email,
262 author_date, diff, options)
266 def __import_url(url, options):
267 """Import a patch from a URL
273 raise CmdException('URL argument required')
275 patch = os.path.basename(urllib.unquote(url))
276 filename = os.path.join(tempfile.gettempdir(), patch)
277 urllib.urlretrieve(url, filename)
278 __import_file(filename, options)
280 def __import_tarfile(tar, options):
281 """Import patch series from a tar archive
286 if not tarfile.is_tarfile(tar):
287 raise CmdException, "%s is not a tarfile!" % tar
289 t = tarfile.open(tar, 'r')
292 # verify paths in the tarfile are safe
294 if n.startswith('/'):
295 raise CmdException, "Absolute path found in %s" % tar
296 if n.find("..") > -1:
297 raise CmdException, "Relative path found in %s" % tar
299 # find the series file
302 if m.endswith('/series') or m == 'series':
306 raise CmdException, "no 'series' file found in %s" % tar
308 # unpack into a tmp dir
309 tmpdir = tempfile.mkdtemp('.stg')
313 __import_series(os.path.join(tmpdir, seriesfile), options)
316 shutil.rmtree(tmpdir)
318 def func(parser, options, args):
319 """Import a GNU diff file as a new patch
322 parser.error('incorrect number of arguments')
324 check_local_changes()
326 check_head_top_equal(crt_series)
333 if not options.url and filename:
334 filename = os.path.abspath(filename)
335 directory.cd_to_topdir()
338 __import_series(filename, options)
340 __import_mbox(filename, options)
342 __import_url(filename, options)
344 __import_file(filename, options)
346 print_crt_patch(crt_series)