1 """Function/variables common to all the commands
5 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License version 2 as
9 published by the Free Software Foundation.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 import sys, os, os.path, re
22 from optparse import OptionParser, make_option
24 from stgit.exception import *
25 from stgit.utils import *
26 from stgit.out import *
27 from stgit import stack, git, basedir
28 from stgit.config import config, file_extensions
33 # Command exception class
34 class CmdException(StgException):
38 class RevParseException(StgException):
39 """Revision spec parse error."""
43 """Parse a revision specification into its
44 patchname@branchname//patch_id parts. If no branch name has a slash
45 in it, also accept / instead of //."""
46 if '/' in ''.join(git.get_heads()):
47 # We have branch names with / in them.
48 branch_chars = r'[^@]'
51 # No / in branch names.
52 branch_chars = r'[^@/]'
53 patch_id_mark = r'(/|//)'
54 patch_re = r'(?P<patch>[^@/]+)'
55 branch_re = r'@(?P<branch>%s+)' % branch_chars
56 patch_id_re = r'%s(?P<patch_id>[a-z.]*)' % patch_id_mark
59 m = re.match(r'^%s$' % patch_id_re, rev)
61 return None, None, m.group('patch_id')
63 # Try path[@branch]//patch_id.
64 m = re.match(r'^%s(%s)?%s$' % (patch_re, branch_re, patch_id_re), rev)
66 return m.group('patch'), m.group('branch'), m.group('patch_id')
69 m = re.match(r'^%s(%s)?$' % (patch_re, branch_re), rev)
71 return m.group('patch'), m.group('branch'), None
73 # No, we can't parse that.
74 raise RevParseException
82 patch, branch, patch_id = parse_rev(rev)
86 series = stack.Series(branch)
88 patch = series.get_current()
90 raise CmdException, 'No patches applied'
91 if patch in series.get_applied() or patch in series.get_unapplied() or \
92 patch in series.get_hidden():
93 if patch_id in ['top', '', None]:
94 return series.get_patch(patch).get_top()
95 elif patch_id == 'bottom':
96 return series.get_patch(patch).get_bottom()
97 elif patch_id == 'top.old':
98 return series.get_patch(patch).get_old_top()
99 elif patch_id == 'bottom.old':
100 return series.get_patch(patch).get_old_bottom()
101 elif patch_id == 'log':
102 return series.get_patch(patch).get_log()
103 if patch == 'base' and patch_id == None:
104 return series.get_base()
105 except RevParseException:
107 return git.rev_parse(rev + '^{commit}')
109 def check_local_changes():
110 if git.local_changes():
111 raise CmdException, \
112 'local changes in the tree. Use "refresh" or "status --reset"'
114 def check_head_top_equal():
115 if not crt_series.head_top_equal():
117 """HEAD and top are not the same. This can happen if you
118 modify a branch with git. The "assimilate" command can
119 fix this situation.""")
121 def check_conflicts():
122 if os.path.exists(os.path.join(basedir.get(), 'conflicts')):
123 raise CmdException, \
124 'Unsolved conflicts. Please resolve them first or\n' \
125 ' revert the changes with "status --reset"'
127 def print_crt_patch(branch = None):
129 patch = crt_series.get_current()
131 patch = stack.Series(branch).get_current()
134 out.info('Now at patch "%s"' % patch)
136 out.info('No patches applied')
138 def resolved(filename, reset = None):
140 reset_file = filename + file_extensions()[reset]
141 if os.path.isfile(reset_file):
142 if os.path.isfile(filename):
144 os.rename(reset_file, filename)
146 git.update_cache([filename], force = True)
148 for ext in file_extensions().values():
150 if os.path.isfile(fn):
153 def resolved_all(reset = None):
154 conflicts = git.get_conflicts()
156 for filename in conflicts:
157 resolved(filename, reset)
158 os.remove(os.path.join(basedir.get(), 'conflicts'))
160 def push_patches(patches, check_merged = False):
161 """Push multiple patches onto the stack. This function is shared
162 between the push and pull commands
164 forwarded = crt_series.forward_patches(patches)
166 out.info('Fast-forwarded patches "%s" - "%s"'
167 % (patches[0], patches[forwarded - 1]))
169 out.info('Fast-forwarded patch "%s"' % patches[0])
171 names = patches[forwarded:]
173 # check for patches merged upstream
174 if names and check_merged:
175 out.start('Checking for patches merged upstream')
177 merged = crt_series.merged_patches(names)
179 out.done('%d found' % len(merged))
184 out.start('Pushing patch "%s"' % p)
187 crt_series.push_empty_patch(p)
188 out.done('merged upstream')
190 modified = crt_series.push_patch(p)
192 if crt_series.empty_patch(p):
193 out.done('empty patch')
199 def pop_patches(patches, keep = False):
200 """Pop the patches in the list from the stack. It is assumed that
201 the patches are listed in the stack reverse order.
203 if len(patches) == 0:
204 out.info('Nothing to push/pop')
207 if len(patches) == 1:
208 out.start('Popping patch "%s"' % p)
210 out.start('Popping patches "%s" - "%s"' % (patches[0], p))
211 crt_series.pop_patch(p, keep)
214 def parse_patches(patch_args, patch_list, boundary = 0, ordered = False):
215 """Parse patch_args list for patch names in patch_list and return
216 a list. The names can be individual patches and/or in the
217 patch1..patch2 format.
221 for name in patch_args:
222 pair = name.split('..')
224 if p and not p in patch_list:
225 raise CmdException, 'Unknown patch name: %s' % p
231 # patch range [p1]..[p2]
234 first = patch_list.index(pair[0])
239 last = patch_list.index(pair[1]) + 1
243 # only cross the boundary if explicitly asked
245 boundary = len(patch_list)
255 last = len(patch_list)
258 pl = patch_list[first:last]
260 pl = patch_list[(last - 1):(first + 1)]
263 raise CmdException, 'Malformed patch name: %s' % name
267 raise CmdException, 'Duplicate patch name: %s' % p
272 patches = [p for p in patch_list if p in patches]
276 def name_email(address):
277 """Return a tuple consisting of the name and email parsed from a
278 standard 'name <email>' or 'email (name)' string
280 address = re.sub('[\\\\"]', '\\\\\g<0>', address)
281 str_list = re.findall('^(.*)\s*<(.*)>\s*$', address)
283 str_list = re.findall('^(.*)\s*\((.*)\)\s*$', address)
285 raise CmdException, 'Incorrect "name <email>"/"email (name)" string: %s' % address
286 return ( str_list[0][1], str_list[0][0] )
290 def name_email_date(address):
291 """Return a tuple consisting of the name, email and date parsed
292 from a 'name <email> date' string
294 address = re.sub('[\\\\"]', '\\\\\g<0>', address)
295 str_list = re.findall('^(.*)\s*<(.*)>\s*(.*)\s*$', address)
297 raise CmdException, 'Incorrect "name <email> date" string: %s' % address
301 def address_or_alias(addr_str):
302 """Return the address if it contains an e-mail address or look up
303 the aliases in the config files.
305 def __address_or_alias(addr):
308 if addr.find('@') >= 0:
309 # it's an e-mail address
311 alias = config.get('mail.alias.'+addr)
315 raise CmdException, 'unknown e-mail alias: %s' % addr
317 addr_list = [__address_or_alias(addr.strip())
318 for addr in addr_str.split(',')]
319 return ', '.join([addr for addr in addr_list if addr])
321 def prepare_rebase():
323 applied = crt_series.get_applied()
325 out.start('Popping all applied patches')
326 crt_series.pop_patch(applied[0])
332 tree_id = git_id(target)
334 # it might be that we use a custom rebase command with its own
337 if tree_id == git.get_head():
338 out.info('Already at "%s", no need for rebasing.' % target)
341 out.start('Rebasing to "%s"' % target)
343 out.start('Rebasing to the default target')
344 git.rebase(tree_id = tree_id)
347 def post_rebase(applied, nopush, merged):
348 # memorize that we rebased to here
349 crt_series._set_field('orig-base', git.get_head())
350 # push the patches back
352 push_patches(applied, merged)
355 # Patch description/e-mail/diff parsing
357 def __end_descr(line):
358 return re.match('---\s*$', line) or re.match('diff -', line) or \
359 re.match('Index: ', line)
361 def __split_descr_diff(string):
362 """Return the description and the diff from the given string
367 for line in string.split('\n'):
369 if not __end_descr(line):
376 return (descr.rstrip(), diff)
378 def __parse_description(descr):
379 """Parse the patch description and return the new description and
380 author information (if any).
383 authname = authemail = authdate = None
385 descr_lines = [line.rstrip() for line in descr.split('\n')]
387 raise CmdException, "Empty patch description"
390 end = len(descr_lines)
392 # Parse the patch header
393 for pos in range(0, end):
394 if not descr_lines[pos]:
396 # check for a "From|Author:" line
397 if re.match('\s*(?:from|author):\s+', descr_lines[pos], re.I):
398 auth = re.findall('^.*?:\s+(.*)$', descr_lines[pos])[0]
399 authname, authemail = name_email(auth)
402 # check for a "Date:" line
403 if re.match('\s*date:\s+', descr_lines[pos], re.I):
404 authdate = re.findall('^.*?:\s+(.*)$', descr_lines[pos])[0]
410 subject = descr_lines[pos]
415 body = reduce(lambda x, y: x + '\n' + y, descr_lines[lasthdr:], '')
417 return (subject + body, authname, authemail, authdate)
420 """Parse the message object and return (description, authname,
421 authemail, authdate, diff)
423 from email.Header import decode_header, make_header
425 def __decode_header(header):
426 """Decode a qp-encoded e-mail header as per rfc2047"""
428 words_enc = decode_header(header)
429 hobj = make_header(words_enc)
430 except Exception, ex:
431 raise CmdException, 'header decoding error: %s' % str(ex)
432 return unicode(hobj).encode('utf-8')
435 if msg.has_key('from'):
436 authname, authemail = name_email(__decode_header(msg['from']))
438 authname = authemail = None
440 # '\n\t' can be found on multi-line headers
441 descr = __decode_header(msg['subject']).replace('\n\t', ' ')
442 authdate = msg['date']
444 # remove the '[*PATCH*]' expression in the subject
446 descr = re.findall('^(\[.*?[Pp][Aa][Tt][Cc][Hh].*?\])?\s*(.*)$',
449 raise CmdException, 'Subject: line not found'
451 # the rest of the message
453 for part in msg.walk():
454 if part.get_content_type() == 'text/plain':
455 msg_text += part.get_payload(decode = True)
457 rem_descr, diff = __split_descr_diff(msg_text)
459 descr += '\n\n' + rem_descr
461 # parse the description for author information
462 descr, descr_authname, descr_authemail, descr_authdate = \
463 __parse_description(descr)
465 authname = descr_authname
467 authemail = descr_authemail
469 authdate = descr_authdate
471 return (descr, authname, authemail, authdate, diff)
473 def parse_patch(fobj):
474 """Parse the input file and return (description, authname,
475 authemail, authdate, diff)
477 descr, diff = __split_descr_diff(fobj.read())
478 descr, authname, authemail, authdate = __parse_description(descr)
480 # we don't yet have an agreed place for the creation date.
482 return (descr, authname, authemail, authdate, diff)