X-Git-Url: https://git.distorted.org.uk/~mdw/stgit/blobdiff_plain/37a4d1bfabaca3dd947799f10c6cfc369a9edb5e..170f576bb9eac1dafc139de7b51226d78d31cbbe:/stgit/stack.py diff --git a/stgit/stack.py b/stgit/stack.py index 2d3bd22..c9d29b7 100644 --- a/stgit/stack.py +++ b/stgit/stack.py @@ -21,7 +21,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA import sys, os from stgit.utils import * -from stgit import git +from stgit import git, basedir from stgit.config import config @@ -64,13 +64,13 @@ def __clean_comments(f): f.seek(0); f.truncate() f.writelines(lines) -def edit_file(series, string, comment, show_patch = True): +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(basedir.get(), '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: @@ -88,7 +88,7 @@ def edit_file(series, string, comment, show_patch = True): 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:' + print >> f, __comment_prefix, 'vi: set textwidth=75 filetype=diff nobackup:' f.close() # the editor @@ -108,12 +108,12 @@ def edit_file(series, string, comment, show_patch = True): __clean_comments(f) f.seek(0) - string = f.read() + result = f.read() f.close() os.remove(fname) - return string + return result # # Classes @@ -122,10 +122,12 @@ def edit_file(series, string, comment, show_patch = True): class Patch: """Basic patch implementation """ - def __init__(self, name, patch_dir): - self.__patch_dir = patch_dir + def __init__(self, name, series_dir, refs_dir): + self.__series_dir = series_dir self.__name = name - self.__dir = os.path.join(self.__patch_dir, self.__name) + self.__dir = os.path.join(self.__series_dir, self.__name) + self.__refs_dir = refs_dir + self.__top_ref_file = os.path.join(self.__refs_dir, self.__name) def create(self): os.mkdir(self.__dir) @@ -136,50 +138,77 @@ class Patch: for f in os.listdir(self.__dir): os.remove(os.path.join(self.__dir, f)) os.rmdir(self.__dir) + os.remove(self.__top_ref_file) def get_name(self): return self.__name def rename(self, newname): olddir = self.__dir + old_ref_file = self.__top_ref_file self.__name = newname - self.__dir = os.path.join(self.__patch_dir, self.__name) + self.__dir = os.path.join(self.__series_dir, self.__name) + self.__top_ref_file = os.path.join(self.__refs_dir, self.__name) os.rename(olddir, self.__dir) + os.rename(old_ref_file, self.__top_ref_file) + + def __update_top_ref(self, ref): + write_string(self.__top_ref_file, ref) + + def update_top_ref(self): + top = self.get_top() + if top: + self.__update_top_ref(top) 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) + self.__update_top_ref(value) def restore_old_boundaries(self): bottom = self.__get_field('bottom.old') @@ -188,74 +217,107 @@ class Patch: if top and bottom: self.__set_field('bottom', bottom) self.__set_field('top', top) + self.__update_top_ref(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: + if config.has_option('stgit', 'authname'): + name = config.get('stgit', 'authname') + elif 'GIT_AUTHOR_NAME' in os.environ: + name = os.environ['GIT_AUTHOR_NAME'] + 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: + if config.has_option('stgit', 'authemail'): + address = config.get('stgit', 'authemail') + elif 'GIT_AUTHOR_EMAIL' in os.environ: + address = os.environ['GIT_AUTHOR_EMAIL'] + 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, date): + if not date and 'GIT_AUTHOR_DATE' in os.environ: + date = os.environ['GIT_AUTHOR_DATE'] + self.__set_field('authdate', date) 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: + if config.has_option('stgit', 'commname'): + name = config.get('stgit', 'commname') + elif 'GIT_COMMITTER_NAME' in os.environ: + name = os.environ['GIT_COMMITTER_NAME'] + 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: + if config.has_option('stgit', 'commemail'): + address = config.get('stgit', 'commemail') + elif 'GIT_COMMITTER_EMAIL' in os.environ: + address = os.environ['GIT_COMMITTER_EMAIL'] + 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() + self.__base_dir = basedir.get() + except git.GitException, ex: + raise StackException, 'GIT tree not initialised: %s' % ex + + self.__series_dir = os.path.join(self.__base_dir, 'patches', + self.__name) + self.__refs_dir = os.path.join(self.__base_dir, 'refs', 'patches', + self.__name) + self.__base_file = os.path.join(self.__base_dir, 'refs', 'bases', + self.__name) + + self.__applied_file = os.path.join(self.__series_dir, 'applied') + self.__unapplied_file = os.path.join(self.__series_dir, 'unapplied') + self.__current_file = os.path.join(self.__series_dir, 'current') + self.__descr_file = os.path.join(self.__series_dir, 'description') + + # where this series keeps its patches + self.__patch_dir = os.path.join(self.__series_dir, 'patches') + if not os.path.isdir(self.__patch_dir): + self.__patch_dir = self.__series_dir + + # if no __refs_dir, create and populate it (upgrade old repositories) + if self.is_initialised() and not os.path.isdir(self.__refs_dir): + os.makedirs(self.__refs_dir) + for patch in self.get_applied() + self.get_unapplied(): + self.get_patch(patch).update_top_ref() def get_branch(self): """Return the branch name for the Series object @@ -273,7 +335,7 @@ class Series: def get_patch(self, name): """Return a Patch object for the given name """ - return Patch(name, self.__patch_dir) + return Patch(name, self.__patch_dir, self.__refs_dir) def get_current(self): """Return a Patch object representing the topmost patch @@ -288,20 +350,44 @@ class Series: 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() return names def get_base_file(self): + self.__begin_stack_check() return self.__base_file + def get_protected(self): + return os.path.isfile(os.path.join(self.__series_dir, 'protected')) + + def protect(self): + protect_file = os.path.join(self.__series_dir, 'protected') + if not os.path.isfile(protect_file): + create_empty_file(protect_file) + + def unprotect(self): + protect_file = os.path.join(self.__series_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) @@ -338,14 +424,20 @@ class Series: if not crt: # we don't care, no patches applied return True - return git.get_head() == Patch(crt, self.__patch_dir).get_top() + return git.get_head() == Patch(crt, self.__patch_dir, + self.__refs_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(self.__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) @@ -354,21 +446,141 @@ class Series: create_empty_file(self.__applied_file) create_empty_file(self.__unapplied_file) + create_empty_file(self.__descr_file) + os.makedirs(os.path.join(self.__series_dir, 'patches')) + os.makedirs(self.__refs_dir) self.__begin_stack_check() - def refresh_patch(self, message = None, edit = False, show_patch = False, + def convert(self): + """Either convert to use a separate patch directory, or + unconvert to place the patches in the same directory with + series control files + """ + if self.__patch_dir == self.__series_dir: + print 'Converting old-style to new-style...', + sys.stdout.flush() + + self.__patch_dir = os.path.join(self.__series_dir, 'patches') + os.makedirs(self.__patch_dir) + + for p in self.get_applied() + self.get_unapplied(): + src = os.path.join(self.__series_dir, p) + dest = os.path.join(self.__patch_dir, p) + os.rename(src, dest) + + print 'done' + + else: + print 'Converting new-style to old-style...', + sys.stdout.flush() + + for p in self.get_applied() + self.get_unapplied(): + src = os.path.join(self.__patch_dir, p) + dest = os.path.join(self.__series_dir, p) + os.rename(src, dest) + + if not os.listdir(self.__patch_dir): + os.rmdir(self.__patch_dir) + print 'done' + else: + print 'Patch directory %s is not empty.' % self.__name + + self.__patch_dir = self.__series_dir + + 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.__series_dir): + os.rename(self.__series_dir, to_stack.__series_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, self.__refs_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 'Patch directory %s is not empty.' % self.__name + if not os.listdir(self.__series_dir): + os.rmdir(self.__series_dir) + else: + print 'Series directory %s is not empty.' % self.__name + if not os.listdir(self.__refs_dir): + os.rmdir(self.__refs_dir) + else: + print 'Refs directory %s is not empty.' % self.__refs_dir + + 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() if not name: raise StackException, 'No patches applied' - patch = Patch(name, self.__patch_dir) + patch = Patch(name, self.__patch_dir, self.__refs_dir) descr = patch.get_description() if not (message or descr): @@ -393,7 +605,8 @@ class Series: 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, @@ -402,14 +615,13 @@ class Series: 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 @@ -417,7 +629,8 @@ class Series: unapplied = False, show_patch = False, top = None, bottom = None, author_name = None, author_email = None, author_date = None, - committer_name = None, committer_email = None): + committer_name = None, committer_email = None, + before_existing = False): """Creates a new patch """ if self.__patch_applied(name) or self.__patch_unapplied(name): @@ -434,7 +647,7 @@ class Series: self.__begin_stack_check() - patch = Patch(name, self.__patch_dir) + patch = Patch(name, self.__patch_dir, self.__refs_dir) patch.create() if bottom: @@ -460,13 +673,18 @@ class Series: f.writelines([line + '\n' for line in patches]) f.close() else: - append_string(self.__applied_file, patch.get_name()) - self.__set_current(name) + if before_existing: + insert_string(self.__applied_file, patch.get_name()) + if not self.get_current(): + self.__set_current(name) + else: + append_string(self.__applied_file, patch.get_name()) + self.__set_current(name) def delete_patch(self, name): """Deletes a patch """ - patch = Patch(name, self.__patch_dir) + patch = Patch(name, self.__patch_dir, self.__refs_dir) if self.__patch_is_current(patch): self.pop_patch(name) @@ -483,6 +701,7 @@ class Series: f = file(self.__unapplied_file, 'w+') f.writelines([line + '\n' for line in unapplied]) f.close() + self.__begin_stack_check() def forward_patches(self, names): """Try to fast-forward an array of patches. @@ -499,7 +718,7 @@ class Series: for name in names: assert(name in unapplied) - patch = Patch(name, self.__patch_dir) + patch = Patch(name, self.__patch_dir, self.__refs_dir) head = top bottom = patch.get_bottom() @@ -508,17 +727,47 @@ class Series: # top != bottom always since we have a commit for each patch if head == bottom: # reset the backup information - patch.set_bottom(bottom, backup = True) + 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 + 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]) @@ -531,7 +780,27 @@ class Series: return forwarded - def push_patch(self, name): + def merged_patches(self, names): + """Test which patches were merged upstream by reverse-applying + them in reverse order. The function returns the list of + patches detected to have been applied. The state of the tree + is restored to the original one + """ + patches = [Patch(name, self.__patch_dir, self.__refs_dir) + for name in names] + patches.reverse() + + merged = [] + for p in patches: + if git.apply_diff(p.get_top(), p.get_bottom(), False): + merged.append(p.get_name()) + merged.reverse() + + git.reset() + + return merged + + def push_patch(self, name, empty = False): """Pushes a patch on the stack """ unapplied = self.get_unapplied() @@ -539,16 +808,25 @@ class Series: self.__begin_stack_check() - patch = Patch(name, self.__patch_dir) + patch = Patch(name, self.__patch_dir, self.__refs_dir) head = git.get_head() bottom = patch.get_bottom() top = patch.get_top() ex = None + modified = False # top != bottom always since we have a commit for each patch - if head == bottom: + if empty: + # just make an empty patch (top = bottom = HEAD). This + # option is useful to allow undoing already merged + # patches. The top is updated by refresh_patch since we + # need an empty commit + patch.set_bottom(head, backup = True) + patch.set_top(head, backup = True) + modified = True + elif head == bottom: # reset the backup information patch.set_bottom(bottom, backup = True) patch.set_top(top, backup = True) @@ -559,14 +837,21 @@ class Series: # 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) @@ -578,7 +863,7 @@ class Series: self.__set_current(name) # head == bottom case doesn't need to refresh the patch - if head != bottom: + if empty or 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 @@ -586,14 +871,16 @@ class Series: else: raise StackException, str(ex) + return modified + def undo_push(self): name = self.get_current() assert(name) - patch = Patch(name, self.__patch_dir) + patch = Patch(name, self.__patch_dir, self.__refs_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 @@ -602,7 +889,7 @@ class Series: applied.reverse() assert(name in applied) - patch = Patch(name, self.__patch_dir) + patch = Patch(name, self.__patch_dir, self.__refs_dir) git.switch(patch.get_bottom()) @@ -634,7 +921,7 @@ class Series: def empty_patch(self, name): """Returns True if the patch is empty """ - patch = Patch(name, self.__patch_dir) + patch = Patch(name, self.__patch_dir, self.__refs_dir) bottom = patch.get_bottom() top = patch.get_top() @@ -650,18 +937,21 @@ class Series: 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 if oldname in unapplied: - Patch(oldname, self.__patch_dir).rename(newname) + Patch(oldname, self.__patch_dir, self.__refs_dir).rename(newname) unapplied[unapplied.index(oldname)] = newname f = file(self.__unapplied_file, 'w+') f.writelines([line + '\n' for line in unapplied]) f.close() elif oldname in applied: - Patch(oldname, self.__patch_dir).rename(newname) + Patch(oldname, self.__patch_dir, self.__refs_dir).rename(newname) if oldname == self.get_current(): self.__set_current(newname)