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
19 from mailbox import UnixMailbox
20 from StringIO import StringIO
21 from optparse import OptionParser, make_option
23 from stgit.commands.common import *
24 from stgit.utils import *
25 from stgit.out import *
26 from stgit import stack, git
29 help = 'import a GNU diff file as a new patch'
30 usage = """%prog [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 directory = DirectoryHasRepository()
48 options = [make_option('-m', '--mail',
49 help = 'import the patch from a standard e-mail file',
50 action = 'store_true'),
51 make_option('-M', '--mbox',
52 help = 'import a series of patches from an mbox file',
53 action = 'store_true'),
54 make_option('-s', '--series',
55 help = 'import a series of patches',
56 action = 'store_true'),
57 make_option('-u', '--url',
58 help = 'import a patch from a URL',
59 action = 'store_true'),
60 make_option('-n', '--name',
61 help = 'use NAME as the patch name'),
62 make_option('-t', '--strip',
63 help = 'strip numbering and extension from patch name',
64 action = 'store_true'),
65 make_option('-i', '--ignore',
66 help = 'ignore the applied patches in the series',
67 action = 'store_true'),
68 make_option('--replace',
69 help = 'replace the unapplied patches in the series',
70 action = 'store_true'),
71 make_option('-b', '--base',
72 help = 'use BASE instead of HEAD for file importing'),
73 make_option('-e', '--edit',
74 help = 'invoke an editor for the patch description',
75 action = 'store_true'),
76 make_option('-p', '--showpatch',
77 help = 'show the patch content in the editor buffer',
78 action = 'store_true'),
79 make_option('-a', '--author', metavar = '"NAME <EMAIL>"',
80 help = 'use "NAME <EMAIL>" as the author details'),
81 make_option('--authname',
82 help = 'use AUTHNAME as the author name'),
83 make_option('--authemail',
84 help = 'use AUTHEMAIL as the author e-mail'),
85 make_option('--authdate',
86 help = 'use AUTHDATE as the author date'),
87 make_option('--commname',
88 help = 'use COMMNAME as the committer name'),
89 make_option('--commemail',
90 help = 'use COMMEMAIL as the committer e-mail')
91 ] + make_sign_options()
94 def __strip_patch_name(name):
95 stripped = re.sub('^[0-9]+-(.*)$', '\g<1>', name)
96 stripped = re.sub('^(.*)\.(diff|patch)$', '\g<1>', stripped)
100 def __replace_slashes_with_dashes(name):
101 stripped = name.replace('/', '-')
105 def __create_patch(filename, message, author_name, author_email,
106 author_date, diff, options):
107 """Create a new patch on the stack
112 patch = os.path.basename(filename)
116 patch = __strip_patch_name(patch)
119 if options.ignore or options.replace:
120 unacceptable_name = lambda name: False
122 unacceptable_name = crt_series.patch_exists
123 patch = make_patch_name(message, unacceptable_name)
125 # fix possible invalid characters in the patch name
126 patch = re.sub('[^\w.]+', '-', patch).strip('-')
128 if options.ignore and patch in crt_series.get_applied():
129 out.info('Ignoring already applied patch "%s"' % patch)
131 if options.replace and patch in crt_series.get_unapplied():
132 crt_series.delete_patch(patch)
134 # refresh_patch() will invoke the editor in this case, with correct
139 committer_name = committer_email = None
142 options.authname, options.authemail = name_email(options.author)
144 # override the automatically parsed settings
146 author_name = options.authname
147 if options.authemail:
148 author_email = options.authemail
150 author_date = options.authdate
152 committer_name = options.commname
153 if options.commemail:
154 committer_email = options.commemail
156 crt_series.new_patch(patch, message = message, can_edit = False,
157 author_name = author_name,
158 author_email = author_email,
159 author_date = author_date,
160 committer_name = committer_name,
161 committer_email = committer_email)
164 out.warn('No diff found, creating empty patch')
166 out.start('Importing patch "%s"' % patch)
168 git.apply_patch(diff = diff, base = git_id(options.base))
170 git.apply_patch(diff = diff)
171 crt_series.refresh_patch(edit = options.edit,
172 show_patch = options.showpatch,
173 sign_str = options.sign_str)
176 def __import_file(filename, options, patch = None):
177 """Import a patch from a file or standard input
186 msg = email.message_from_file(f)
187 except Exception, ex:
188 raise CmdException, 'error parsing the e-mail file: %s' % str(ex)
189 message, author_name, author_email, author_date, diff = \
192 message, author_name, author_email, author_date, diff = \
203 __create_patch(pname, message, author_name, author_email,
204 author_date, diff, options)
206 def __import_series(filename, options):
207 """Import a series of patches
209 applied = crt_series.get_applied()
213 patchdir = os.path.dirname(filename)
219 patch = re.sub('#.*$', '', line).strip()
222 patchfile = os.path.join(patchdir, patch)
223 patch = __replace_slashes_with_dashes(patch);
225 __import_file(patchfile, options, patch)
230 def __import_mbox(filename, options):
231 """Import a series from an mbox file
234 f = file(filename, 'rb')
236 f = StringIO(sys.stdin.read())
239 mbox = UnixMailbox(f, email.message_from_file)
240 except Exception, ex:
241 raise CmdException, 'error parsing the mbox file: %s' % str(ex)
244 message, author_name, author_email, author_date, diff = \
246 __create_patch(None, message, author_name, author_email,
247 author_date, diff, options)
251 def __import_url(url, options):
252 """Import a patch from a URL
258 parser.error('URL argument required')
260 patch = os.path.basename(urllib.unquote(url))
261 filename = os.path.join(tempfile.gettempdir(), patch)
262 urllib.urlretrieve(url, filename)
263 __import_file(filename, options)
265 def func(parser, options, args):
266 """Import a GNU diff file as a new patch
269 parser.error('incorrect number of arguments')
271 check_local_changes()
273 check_head_top_equal()
281 __import_series(filename, options)
283 __import_mbox(filename, options)
285 __import_url(filename, options)
287 __import_file(filename, options)