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.utils import *
25 from stgit import stack, git, basedir
26 from stgit.config import config, file_extensions
31 # Command exception class
32 class CmdException(Exception):
37 class RevParseException(Exception):
38 """Revision spec parse error."""
42 """Parse a revision specification into its
43 patchname@branchname//patch_id parts. If no branch name has a slash
44 in it, also accept / instead of //."""
45 files, dirs = list_files_and_dirs(os.path.join(basedir.get(),
48 # We have branch names with / in them.
49 branch_chars = r'[^@]'
52 # No / in branch names.
53 branch_chars = r'[^@/]'
54 patch_id_mark = r'(/|//)'
55 patch_re = r'(?P<patch>[^@/]+)'
56 branch_re = r'@(?P<branch>%s+)' % branch_chars
57 patch_id_re = r'%s(?P<patch_id>[a-z.]*)' % patch_id_mark
60 m = re.match(r'^%s$' % patch_id_re, rev)
62 return None, None, m.group('patch_id')
64 # Try path[@branch]//patch_id.
65 m = re.match(r'^%s(%s)?%s$' % (patch_re, branch_re, patch_id_re), rev)
67 return m.group('patch'), m.group('branch'), m.group('patch_id')
70 m = re.match(r'^%s(%s)?$' % (patch_re, branch_re), rev)
72 return m.group('patch'), m.group('branch'), None
74 # No, we can't parse that.
75 raise RevParseException
83 patch, branch, patch_id = parse_rev(rev)
87 series = stack.Series(branch)
89 patch = series.get_current()
91 raise CmdException, 'No patches applied'
92 if patch in series.get_applied() or patch in series.get_unapplied():
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 read_string(series.get_base_file())
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. You probably committed\n'
118 ' changes to the tree outside of StGIT. To bring them\n'
119 ' into StGIT, use the "assimilate" command')
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 print 'Now at patch "%s"' % patch
136 print '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 print 'Fast-forwarded patches "%s" - "%s"' % (patches[0],
167 patches[forwarded - 1])
169 print 'Fast-forwarded patch "%s"' % patches[0]
171 names = patches[forwarded:]
173 # check for patches merged upstream
175 print 'Checking for patches merged upstream...',
178 merged = crt_series.merged_patches(names)
180 print 'done (%d found)' % len(merged)
185 print 'Pushing patch "%s"...' % p,
189 crt_series.push_patch(p, empty = True)
190 print 'done (merged upstream)'
192 modified = crt_series.push_patch(p)
194 if crt_series.empty_patch(p):
195 print 'done (empty patch)'
197 print 'done (modified)'
201 def pop_patches(patches, keep = False):
202 """Pop the patches in the list from the stack. It is assumed that
203 the patches are listed in the stack reverse order.
205 if len(patches) == 0:
206 print 'nothing to push/pop'
209 if len(patches) == 1:
210 print 'Popping patch "%s"...' % p,
212 print 'Popping "%s" - "%s" patches...' % (patches[0], p),
215 crt_series.pop_patch(p, keep)
219 def parse_patches(patch_args, patch_list, boundary = 0, ordered = False):
220 """Parse patch_args list for patch names in patch_list and return
221 a list. The names can be individual patches and/or in the
222 patch1..patch2 format.
226 for name in patch_args:
227 pair = name.split('..')
229 if p and not p in patch_list:
230 raise CmdException, 'Unknown patch name: %s' % p
236 # patch range [p1]..[p2]
239 first = patch_list.index(pair[0])
244 last = patch_list.index(pair[1]) + 1
248 # only cross the boundary if explicitly asked
250 boundary = len(patch_list)
260 last = len(patch_list)
263 pl = patch_list[first:last]
265 pl = patch_list[(last - 1):(first + 1)]
268 raise CmdException, 'Malformed patch name: %s' % name
272 raise CmdException, 'Duplicate patch name: %s' % p
277 patches = [p for p in patch_list if p in patches]
281 def name_email(address):
282 """Return a tuple consisting of the name and email parsed from a
283 standard 'name <email>' or 'email (name)' string
285 address = re.sub('[\\\\"]', '\\\\\g<0>', address)
286 str_list = re.findall('^(.*)\s*<(.*)>\s*$', address)
288 str_list = re.findall('^(.*)\s*\((.*)\)\s*$', address)
290 raise CmdException, 'Incorrect "name <email>"/"email (name)" string: %s' % address
291 return ( str_list[0][1], str_list[0][0] )
295 def name_email_date(address):
296 """Return a tuple consisting of the name, email and date parsed
297 from a 'name <email> date' string
299 address = re.sub('[\\\\"]', '\\\\\g<0>', address)
300 str_list = re.findall('^(.*)\s*<(.*)>\s*(.*)\s*$', address)
302 raise CmdException, 'Incorrect "name <email> date" string: %s' % address
306 def patch_name_from_msg(msg):
307 """Return a string to be used as a patch name. This is generated
308 from the first 30 characters of the top line of the string passed
313 subject_line = msg[:30].lstrip().split('\n', 1)[0].lower()
314 return re.sub('[\W]+', '-', subject_line).strip('-')
316 def make_patch_name(msg, unacceptable, default_name = 'patch',
318 """Return a patch name generated from the given commit message,
319 guaranteed to make unacceptable(name) be false. If the commit
320 message is empty, base the name on default_name instead."""
321 patchname = patch_name_from_msg(msg)
323 patchname = default_name
324 if alternative and unacceptable(patchname):
326 while unacceptable('%s-%d' % (patchname, suffix)):
328 patchname = '%s-%d' % (patchname, suffix)