class StackException(Exception):
pass
+class FilterUntil:
+ def __init__(self):
+ self.should_print = True
+ def __call__(self, x, until_test, prefix):
+ if until_test(x):
+ self.should_print = False
+ if self.should_print:
+ return x[0:len(prefix)] != prefix
+ return False
+
#
# Functions
#
__comment_prefix = 'STG:'
+__patch_prefix = 'STG_PATCH:'
def __clean_comments(f):
"""Removes lines marked for status in a commit file
f.seek(0)
# remove status-prefixed lines
- lines = filter(lambda x: x[0:len(__comment_prefix)] != __comment_prefix,
- f.readlines())
+ lines = f.readlines()
+
+ patch_filter = FilterUntil()
+ until_test = lambda t: t == (__patch_prefix + '\n')
+ lines = [l for l in lines if patch_filter(l, until_test, __comment_prefix)]
+
# remove empty lines at the end
while len(lines) != 0 and lines[-1] == '\n':
del lines[-1]
f.seek(0); f.truncate()
f.writelines(lines)
-def edit_file(string, comment):
+def edit_file(series, line, comment, show_patch = True):
fname = '.stgit.msg'
- tmpl = os.path.join(git.base_dir, 'patchdescr.tmpl')
+ tmpl = os.path.join(git.get_base_dir(), 'patchdescr.tmpl')
f = file(fname, 'w+')
- if string:
- print >> f, string
+ if line:
+ print >> f, line
elif os.path.isfile(tmpl):
print >> f, file(tmpl).read().rstrip()
else:
% __comment_prefix
print >> f, __comment_prefix, \
'Trailing empty lines will be automatically removed.'
+
+ if show_patch:
+ print >> f, __patch_prefix
+ # series.get_patch(series.get_current()).get_top()
+ git.diff([], series.get_patch(series.get_current()).get_bottom(), None, f)
+
+ #Vim modeline must be near the end.
+ print >> f, __comment_prefix, 'vi: set textwidth=75 filetype=diff nobackup:'
f.close()
# the editor
- if 'EDITOR' in os.environ:
+ if config.has_option('stgit', 'editor'):
+ editor = config.get('stgit', 'editor')
+ elif 'EDITOR' in os.environ:
editor = os.environ['EDITOR']
else:
editor = 'vi'
__clean_comments(f)
f.seek(0)
- string = f.read()
+ result = f.read()
f.close()
os.remove(fname)
- return string
+ return result
#
# Classes
def __get_field(self, name, multiline = False):
id_file = os.path.join(self.__dir, name)
if os.path.isfile(id_file):
- string = read_string(id_file, multiline)
- if string == '':
+ line = read_string(id_file, multiline)
+ if line == '':
return None
else:
- return string
+ return line
else:
return None
- def __set_field(self, name, string, multiline = False):
+ def __set_field(self, name, value, multiline = False):
fname = os.path.join(self.__dir, name)
- if string and string != '':
- write_string(fname, string, multiline)
+ if value and value != '':
+ write_string(fname, value, multiline)
elif os.path.isfile(fname):
os.remove(fname)
+ def get_old_bottom(self):
+ return self.__get_field('bottom.old')
+
def get_bottom(self):
return self.__get_field('bottom')
- def set_bottom(self, string, backup = False):
+ def set_bottom(self, value, backup = False):
if backup:
- self.__set_field('bottom.old', self.__get_field('bottom'))
- self.__set_field('bottom', string)
+ curr = self.__get_field('bottom')
+ if curr != value:
+ self.__set_field('bottom.old', curr)
+ else:
+ self.__set_field('bottom.old', None)
+ self.__set_field('bottom', value)
+
+ def get_old_top(self):
+ return self.__get_field('top.old')
def get_top(self):
return self.__get_field('top')
- def set_top(self, string, backup = False):
+ def set_top(self, value, backup = False):
if backup:
- self.__set_field('top.old', self.__get_field('top'))
- self.__set_field('top', string)
+ curr = self.__get_field('top')
+ if curr != value:
+ self.__set_field('top.old', curr)
+ else:
+ self.__set_field('top.old', None)
+ self.__set_field('top', value)
def restore_old_boundaries(self):
bottom = self.__get_field('bottom.old')
if top and bottom:
self.__set_field('bottom', bottom)
self.__set_field('top', top)
+ return True
else:
- raise StackException, 'No patch undo information'
+ return False
def get_description(self):
return self.__get_field('description', True)
- def set_description(self, string):
- self.__set_field('description', string, True)
+ def set_description(self, line):
+ self.__set_field('description', line, True)
def get_authname(self):
return self.__get_field('authname')
- def set_authname(self, string):
- if not string and config.has_option('stgit', 'authname'):
- string = config.get('stgit', 'authname')
- self.__set_field('authname', string)
+ def set_authname(self, name):
+ if not name and config.has_option('stgit', 'authname'):
+ name = config.get('stgit', 'authname')
+ self.__set_field('authname', name)
def get_authemail(self):
return self.__get_field('authemail')
- def set_authemail(self, string):
- if not string and config.has_option('stgit', 'authemail'):
- string = config.get('stgit', 'authemail')
- self.__set_field('authemail', string)
+ def set_authemail(self, address):
+ if not address and config.has_option('stgit', 'authemail'):
+ address = config.get('stgit', 'authemail')
+ self.__set_field('authemail', address)
def get_authdate(self):
return self.__get_field('authdate')
- def set_authdate(self, string):
- self.__set_field('authdate', string)
+ def set_authdate(self, authdate):
+ self.__set_field('authdate', authdate)
def get_commname(self):
return self.__get_field('commname')
- def set_commname(self, string):
- if not string and config.has_option('stgit', 'commname'):
- string = config.get('stgit', 'commname')
- self.__set_field('commname', string)
+ def set_commname(self, name):
+ if not name and config.has_option('stgit', 'commname'):
+ name = config.get('stgit', 'commname')
+ self.__set_field('commname', name)
def get_commemail(self):
return self.__get_field('commemail')
- def set_commemail(self, string):
- if not string and config.has_option('stgit', 'commemail'):
- string = config.get('stgit', 'commemail')
- self.__set_field('commemail', string)
+ def set_commemail(self, address):
+ if not address and config.has_option('stgit', 'commemail'):
+ address = config.get('stgit', 'commemail')
+ self.__set_field('commemail', address)
class Series:
"""Class including the operations on series
"""
def __init__(self, name = None):
- """Takes a series name as the parameter. A valid .git/patches/name
- directory should exist
+ """Takes a series name as the parameter.
"""
- if name:
- self.__name = name
- else:
- self.__name = git.get_head_file()
-
- if self.__name:
- self.__patch_dir = os.path.join(git.base_dir, 'patches',
- self.__name)
- self.__base_file = os.path.join(git.base_dir, 'refs', 'bases',
- self.__name)
- self.__applied_file = os.path.join(self.__patch_dir, 'applied')
- self.__unapplied_file = os.path.join(self.__patch_dir, 'unapplied')
- self.__current_file = os.path.join(self.__patch_dir, 'current')
+ try:
+ if name:
+ self.__name = name
+ else:
+ self.__name = git.get_head_file()
+ base_dir = git.get_base_dir()
+ except git.GitException, ex:
+ raise StackException, 'GIT tree not initialised: %s' % ex
+
+ self.__patch_dir = os.path.join(base_dir, 'patches',
+ self.__name)
+ self.__base_file = os.path.join(base_dir, 'refs', 'bases',
+ self.__name)
+ self.__applied_file = os.path.join(self.__patch_dir, 'applied')
+ self.__unapplied_file = os.path.join(self.__patch_dir, 'unapplied')
+ self.__current_file = os.path.join(self.__patch_dir, 'current')
+ self.__descr_file = os.path.join(self.__patch_dir, 'description')
+
+ def get_branch(self):
+ """Return the branch name for the Series object
+ """
+ return self.__name
def __set_current(self, name):
"""Sets the topmost patch
return name
def get_applied(self):
+ if not os.path.isfile(self.__applied_file):
+ raise StackException, 'Branch "%s" not initialised' % self.__name
f = file(self.__applied_file)
names = [line.strip() for line in f.readlines()]
f.close()
return names
def get_unapplied(self):
+ if not os.path.isfile(self.__unapplied_file):
+ raise StackException, 'Branch "%s" not initialised' % self.__name
f = file(self.__unapplied_file)
names = [line.strip() for line in f.readlines()]
f.close()
def get_base_file(self):
return self.__base_file
+ def get_protected(self):
+ return os.path.isfile(os.path.join(self.__patch_dir, 'protected'))
+
+ def protect(self):
+ protect_file = os.path.join(self.__patch_dir, 'protected')
+ if not os.path.isfile(protect_file):
+ create_empty_file(protect_file)
+
+ def unprotect(self):
+ protect_file = os.path.join(self.__patch_dir, 'protected')
+ if os.path.isfile(protect_file):
+ os.remove(protect_file)
+
+ def get_description(self):
+ if os.path.isfile(self.__descr_file):
+ return read_string(self.__descr_file)
+ else:
+ return ''
+
def __patch_is_current(self, patch):
return patch.get_name() == read_string(self.__current_file)
return True
return git.get_head() == Patch(crt, self.__patch_dir).get_top()
+ def is_initialised(self):
+ """Checks if series is already initialised
+ """
+ return os.path.isdir(self.__patch_dir)
+
def init(self):
"""Initialises the stgit series
"""
- bases_dir = os.path.join(git.base_dir, 'refs', 'bases')
+ bases_dir = os.path.join(git.get_base_dir(), 'refs', 'bases')
- if os.path.isdir(self.__patch_dir):
+ if self.is_initialised():
raise StackException, self.__patch_dir + ' already exists'
os.makedirs(self.__patch_dir)
create_empty_file(self.__applied_file)
create_empty_file(self.__unapplied_file)
+ create_empty_file(self.__descr_file)
self.__begin_stack_check()
- def refresh_patch(self, message = None, edit = False,
+ def rename(self, to_name):
+ """Renames a series
+ """
+ to_stack = Series(to_name)
+
+ if to_stack.is_initialised():
+ raise StackException, '"%s" already exists' % to_stack.get_branch()
+ if os.path.exists(to_stack.__base_file):
+ os.remove(to_stack.__base_file)
+
+ git.rename_branch(self.__name, to_name)
+
+ if os.path.isdir(self.__patch_dir):
+ os.rename(self.__patch_dir, to_stack.__patch_dir)
+ if os.path.exists(self.__base_file):
+ os.rename(self.__base_file, to_stack.__base_file)
+
+ self.__init__(to_name)
+
+ def clone(self, target_series):
+ """Clones a series
+ """
+ base = read_string(self.get_base_file())
+ git.create_branch(target_series, tree_id = base)
+ Series(target_series).init()
+ new_series = Series(target_series)
+
+ # generate an artificial description file
+ write_string(new_series.__descr_file, 'clone of "%s"' % self.__name)
+
+ # clone self's entire series as unapplied patches
+ patches = self.get_applied() + self.get_unapplied()
+ patches.reverse()
+ for p in patches:
+ patch = self.get_patch(p)
+ new_series.new_patch(p, message = patch.get_description(),
+ can_edit = False, unapplied = True,
+ bottom = patch.get_bottom(),
+ top = patch.get_top(),
+ author_name = patch.get_authname(),
+ author_email = patch.get_authemail(),
+ author_date = patch.get_authdate())
+
+ # fast forward the cloned series to self's top
+ new_series.forward_patches(self.get_applied())
+
+ def delete(self, force = False):
+ """Deletes an stgit series
+ """
+ if self.is_initialised():
+ patches = self.get_unapplied() + self.get_applied()
+ if not force and patches:
+ raise StackException, \
+ 'Cannot delete: the series still contains patches'
+ for p in patches:
+ Patch(p, self.__patch_dir).delete()
+
+ if os.path.exists(self.__applied_file):
+ os.remove(self.__applied_file)
+ if os.path.exists(self.__unapplied_file):
+ os.remove(self.__unapplied_file)
+ if os.path.exists(self.__current_file):
+ os.remove(self.__current_file)
+ if os.path.exists(self.__descr_file):
+ os.remove(self.__descr_file)
+ if not os.listdir(self.__patch_dir):
+ os.rmdir(self.__patch_dir)
+ else:
+ print 'Series directory %s is not empty.' % self.__name
+
+ if os.path.exists(self.__base_file):
+ os.remove(self.__base_file)
+
+ def refresh_patch(self, files = None, message = None, edit = False,
+ show_patch = False,
+ cache_update = True,
author_name = None, author_email = None,
author_date = None,
- committer_name = None, committer_email = None,
- commit_only = False):
+ committer_name = None, committer_email = None):
"""Generates a new commit for the given patch
"""
name = self.get_current()
descr = message
if not message and edit:
- descr = edit_file(descr.rstrip(), \
+ descr = edit_file(self, descr.rstrip(), \
'Please edit the description for patch "%s" ' \
- 'above.' % name)
+ 'above.' % name, show_patch)
if not author_name:
author_name = patch.get_authname()
if not committer_email:
committer_email = patch.get_commemail()
- commit_id = git.commit(message = descr, parents = [patch.get_bottom()],
+ commit_id = git.commit(files = files,
+ message = descr, parents = [patch.get_bottom()],
+ cache_update = cache_update,
allowempty = True,
author_name = author_name,
author_email = author_email,
committer_name = committer_name,
committer_email = committer_email)
- if not commit_only:
- patch.set_top(commit_id)
- patch.set_description(descr)
- patch.set_authname(author_name)
- patch.set_authemail(author_email)
- patch.set_authdate(author_date)
- patch.set_commname(committer_name)
- patch.set_commemail(committer_email)
+ patch.set_top(commit_id)
+ patch.set_description(descr)
+ patch.set_authname(author_name)
+ patch.set_authemail(author_email)
+ patch.set_authdate(author_date)
+ patch.set_commname(committer_name)
+ patch.set_commemail(committer_email)
return commit_id
- def new_patch(self, name, message = None, edit = False,
+ def new_patch(self, name, message = None, can_edit = True,
+ unapplied = False, show_patch = False,
+ top = None, bottom = None,
author_name = None, author_email = None, author_date = None,
committer_name = None, committer_email = None):
"""Creates a new patch
if self.__patch_applied(name) or self.__patch_unapplied(name):
raise StackException, 'Patch "%s" already exists' % name
- if not message:
- descr = edit_file(None, \
+ if not message and can_edit:
+ descr = edit_file(self, None, \
'Please enter the description for patch "%s" ' \
- 'above.' % name)
+ 'above.' % name, show_patch)
else:
descr = message
patch = Patch(name, self.__patch_dir)
patch.create()
- patch.set_bottom(head)
- patch.set_top(head)
+
+ if bottom:
+ patch.set_bottom(bottom)
+ else:
+ patch.set_bottom(head)
+ if top:
+ patch.set_top(top)
+ else:
+ patch.set_top(head)
+
patch.set_description(descr)
patch.set_authname(author_name)
patch.set_authemail(author_email)
patch.set_commname(committer_name)
patch.set_commemail(committer_email)
- append_string(self.__applied_file, patch.get_name())
- self.__set_current(name)
+ if unapplied:
+ patches = [patch.get_name()] + self.get_unapplied()
+
+ f = file(self.__unapplied_file, 'w+')
+ f.writelines([line + '\n' for line in patches])
+ f.close()
+ else:
+ append_string(self.__applied_file, patch.get_name())
+ self.__set_current(name)
def delete_patch(self, name):
"""Deletes a patch
f.writelines([line + '\n' for line in unapplied])
f.close()
+ def forward_patches(self, names):
+ """Try to fast-forward an array of patches.
+
+ On return, patches in names[0:returned_value] have been pushed on the
+ stack. Apply the rest with push_patch
+ """
+ unapplied = self.get_unapplied()
+ self.__begin_stack_check()
+
+ forwarded = 0
+ top = git.get_head()
+
+ for name in names:
+ assert(name in unapplied)
+
+ patch = Patch(name, self.__patch_dir)
+
+ head = top
+ bottom = patch.get_bottom()
+ top = patch.get_top()
+
+ # top != bottom always since we have a commit for each patch
+ if head == bottom:
+ # reset the backup information
+ patch.set_bottom(head, backup = True)
+ patch.set_top(top, backup = True)
+
+ else:
+ head_tree = git.get_commit(head).get_tree()
+ bottom_tree = git.get_commit(bottom).get_tree()
+ if head_tree == bottom_tree:
+ # We must just reparent this patch and create a new commit
+ # for it
+ descr = patch.get_description()
+ author_name = patch.get_authname()
+ author_email = patch.get_authemail()
+ author_date = patch.get_authdate()
+ committer_name = patch.get_commname()
+ committer_email = patch.get_commemail()
+
+ top_tree = git.get_commit(top).get_tree()
+
+ top = git.commit(message = descr, parents = [head],
+ cache_update = False,
+ tree_id = top_tree,
+ allowempty = True,
+ author_name = author_name,
+ author_email = author_email,
+ author_date = author_date,
+ committer_name = committer_name,
+ committer_email = committer_email)
+
+ patch.set_bottom(head, backup = True)
+ patch.set_top(top, backup = True)
+ else:
+ top = head
+ # stop the fast-forwarding, must do a real merge
+ break
+
+ forwarded+=1
+ unapplied.remove(name)
+
+ if forwarded == 0:
+ return 0
+
+ git.switch(top)
+
+ append_strings(self.__applied_file, names[0:forwarded])
+
+ f = file(self.__unapplied_file, 'w+')
+ f.writelines([line + '\n' for line in unapplied])
+ f.close()
+
+ self.__set_current(name)
+
+ return forwarded
+
def push_patch(self, name):
"""Pushes a patch on the stack
"""
top = patch.get_top()
ex = None
+ modified = False
# top != bottom always since we have a commit for each patch
if head == bottom:
# The current patch is empty after merge.
patch.set_bottom(head, backup = True)
patch.set_top(head, backup = True)
- # merge/refresh can fail but the patch needs to be pushed
- try:
- git.merge(bottom, head, top)
- except git.GitException, ex:
- print >> sys.stderr, \
- 'The merge failed during "push". ' \
- 'Use "refresh" after fixing the conflicts'
- pass
+
+ # Try the fast applying first. If this fails, fall back to the
+ # three-way merge
+ if not git.apply_diff(bottom, top):
+ # if git.apply_diff() fails, the patch requires a diff3
+ # merge and can be reported as modified
+ modified = True
+
+ # merge can fail but the patch needs to be pushed
+ try:
+ git.merge(bottom, head, top)
+ except git.GitException, ex:
+ print >> sys.stderr, \
+ 'The merge failed during "push". ' \
+ 'Use "refresh" after fixing the conflicts'
append_string(self.__applied_file, name)
self.__set_current(name)
- if not ex:
- # if the merge was OK and no conflicts, just refresh the patch
- self.refresh_patch()
- else:
- raise StackException, str(ex)
+ # head == bottom case doesn't need to refresh the patch
+ if head != bottom:
+ if not ex:
+ # if the merge was OK and no conflicts, just refresh the patch
+ # The GIT cache was already updated by the merge operation
+ self.refresh_patch(cache_update = False)
+ else:
+ raise StackException, str(ex)
+
+ return modified
def undo_push(self):
name = self.get_current()
assert(name)
patch = Patch(name, self.__patch_dir)
+ git.reset()
self.pop_patch(name)
- patch.restore_old_boundaries()
+ return patch.restore_old_boundaries()
def pop_patch(self, name):
"""Pops the top patch from the stack
if bottom == top:
return True
- elif git.Commit(top).get_tree() == git.Commit(bottom).get_tree():
+ elif git.get_commit(top).get_tree() \
+ == git.get_commit(bottom).get_tree():
return True
return False
applied = self.get_applied()
unapplied = self.get_unapplied()
+ if oldname == newname:
+ raise StackException, '"To" name and "from" name are the same'
+
if newname in applied or newname in unapplied:
raise StackException, 'Patch "%s" already exists' % newname