import sys, os
from stgit.utils import *
-from stgit import git
+from stgit import git, basedir, templates
from stgit.config import config
f.writelines(lines)
def edit_file(series, line, comment, show_patch = True):
- fname = '.stgit.msg'
- tmpl = os.path.join(git.get_base_dir(), 'patchdescr.tmpl')
+ fname = '.stgitmsg.txt'
+ tmpl = templates.get_template('patchdescr.tmpl')
f = file(fname, 'w+')
if line:
print >> f, line
- elif os.path.isfile(tmpl):
- print >> f, file(tmpl).read().rstrip()
+ elif tmpl:
+ print >> f, tmpl,
else:
print >> f
print >> f, __comment_prefix, comment
class Patch:
"""Basic patch implementation
"""
- def __init__(self, name, series_dir):
+ def __init__(self, name, series_dir, refs_dir):
self.__series_dir = series_dir
self.__name = 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)
+ self.__log_ref_file = os.path.join(self.__refs_dir,
+ self.__name + '.log')
def create(self):
os.mkdir(self.__dir)
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)
+ if os.path.exists(self.__log_ref_file):
+ os.remove(self.__log_ref_file)
def get_name(self):
return self.__name
def rename(self, newname):
olddir = self.__dir
+ old_top_ref_file = self.__top_ref_file
+ old_log_ref_file = self.__log_ref_file
self.__name = newname
self.__dir = os.path.join(self.__series_dir, self.__name)
+ self.__top_ref_file = os.path.join(self.__refs_dir, self.__name)
+ self.__log_ref_file = os.path.join(self.__refs_dir,
+ self.__name + '.log')
os.rename(olddir, self.__dir)
+ os.rename(old_top_ref_file, self.__top_ref_file)
+ if os.path.exists(old_log_ref_file):
+ os.rename(old_log_ref_file, self.__log_ref_file)
+
+ def __update_top_ref(self, ref):
+ write_string(self.__top_ref_file, ref)
+
+ def __update_log_ref(self, ref):
+ write_string(self.__log_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)
def set_bottom(self, value, backup = False):
if backup:
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.old', curr)
self.__set_field('bottom', value)
def get_old_top(self):
def set_top(self, value, backup = False):
if backup:
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.old', curr)
self.__set_field('top', value)
+ self.__update_top_ref(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)
+ self.__update_top_ref(top)
return True
else:
return False
return self.__get_field('authname')
def set_authname(self, name):
- if not name and config.has_option('stgit', 'authname'):
- name = config.get('stgit', 'authname')
+ 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, address):
- if not address and config.has_option('stgit', 'authemail'):
- address = config.get('stgit', 'authemail')
+ 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, authdate):
- self.__set_field('authdate', authdate)
+ 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, name):
- if not name and config.has_option('stgit', 'commname'):
- name = config.get('stgit', 'commname')
+ 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, address):
- if not address and config.has_option('stgit', 'commemail'):
- address = config.get('stgit', 'commemail')
+ 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)
+ def get_log(self):
+ return self.__get_field('log')
+
+ def set_log(self, value, backup = False):
+ self.__set_field('log', value)
+ self.__update_log_ref(value)
+
class Series:
"""Class including the operations on series
self.__name = name
else:
self.__name = git.get_head_file()
- base_dir = git.get_base_dir()
+ self.__base_dir = basedir.get()
except git.GitException, ex:
raise StackException, 'GIT tree not initialised: %s' % ex
- self.__series_dir = os.path.join(base_dir, 'patches',
+ self.__series_dir = os.path.join(self.__base_dir, 'patches',
self.__name)
- self.__base_file = os.path.join(base_dir, 'refs', 'bases',
+ 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')
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()
+
+ # trash directory
+ self.__trash_dir = os.path.join(self.__series_dir, 'trash')
+ if self.is_initialised() and not os.path.isdir(self.__trash_dir):
+ os.makedirs(self.__trash_dir)
+
def get_branch(self):
"""Return the branch name for the Series object
"""
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_patch(self):
+ """Return a Patch object representing the topmost patch, or
+ None if there is no such patch."""
+ crt = self.get_current()
+ if not crt:
+ return None
+ return Patch(crt, self.__patch_dir, self.__refs_dir)
def get_current(self):
- """Return a Patch object representing the topmost patch
- """
+ """Return the name of the topmost patch, or None if there is
+ no such patch."""
if os.path.isfile(self.__current_file):
name = read_string(self.__current_file)
else:
return names
def get_base_file(self):
+ self.__begin_stack_check()
return self.__base_file
def get_protected(self):
"""
return name in self.get_unapplied()
+ def patch_exists(self, name):
+ """Return true if there is a patch with the given name, false
+ otherwise."""
+ return self.__patch_applied(name) or self.__patch_applied(name)
+
def __begin_stack_check(self):
"""Save the current HEAD into .git/refs/heads/base if the stack
is empty
def head_top_equal(self):
"""Return true if the head and the top are the same
"""
- crt = self.get_current()
+ crt = self.get_current_patch()
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() == crt.get_top()
def is_initialised(self):
"""Checks if series is already initialised
"""
return os.path.isdir(self.__patch_dir)
- def init(self):
+ def init(self, create_at=False):
"""Initialises the stgit series
"""
- bases_dir = os.path.join(git.get_base_dir(), 'refs', 'bases')
+ bases_dir = os.path.join(self.__base_dir, 'refs', 'bases')
- if self.is_initialised():
+ if os.path.exists(self.__patch_dir):
raise StackException, self.__patch_dir + ' already exists'
+ if os.path.exists(self.__refs_dir):
+ raise StackException, self.__refs_dir + ' already exists'
+ if os.path.exists(self.__base_file):
+ raise StackException, self.__base_file + ' already exists'
+
+ if (create_at!=False):
+ git.create_branch(self.__name, create_at)
+
os.makedirs(self.__patch_dir)
- if not os.path.isdir(bases_dir):
- os.makedirs(bases_dir)
+ create_dirs(bases_dir)
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 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
"""
git.rename_branch(self.__name, to_name)
if os.path.isdir(self.__series_dir):
- os.rename(self.__series_dir, to_stack.__series_dir)
+ rename(os.path.join(self.__base_dir, 'patches'),
+ self.__name, to_stack.__name)
if os.path.exists(self.__base_file):
- os.rename(self.__base_file, to_stack.__base_file)
+ rename(os.path.join(self.__base_dir, 'refs', 'bases'),
+ self.__name, to_stack.__name)
+ if os.path.exists(self.__refs_dir):
+ rename(os.path.join(self.__base_dir, 'refs', 'patches'),
+ self.__name, to_stack.__name)
self.__init__(to_name)
"""Clones a series
"""
base = read_string(self.get_base_file())
- git.create_branch(target_series, tree_id = base)
- Series(target_series).init()
+ Series(target_series).init(create_at = base)
new_series = Series(target_series)
# generate an artificial description file
raise StackException, \
'Cannot delete: the series still contains patches'
for p in patches:
- Patch(p, self.__patch_dir).delete()
+ Patch(p, self.__patch_dir, self.__refs_dir).delete()
+
+ # remove the trash directory
+ for fname in os.listdir(self.__trash_dir):
+ os.remove(fname)
+ os.rmdir(self.__trash_dir)
if os.path.exists(self.__applied_file):
os.remove(self.__applied_file)
else:
print 'Patch directory %s is not empty.' % self.__name
if not os.listdir(self.__series_dir):
- os.rmdir(self.__series_dir)
+ remove_dirs(os.path.join(self.__base_dir, 'patches'),
+ self.__name)
else:
print 'Series directory %s is not empty.' % self.__name
+ if not os.listdir(self.__refs_dir):
+ remove_dirs(os.path.join(self.__base_dir, 'refs', 'patches'),
+ self.__name)
+ else:
+ print 'Refs directory %s is not empty.' % self.__refs_dir
if os.path.exists(self.__base_file):
- os.remove(self.__base_file)
+ remove_file_and_dirs(
+ os.path.join(self.__base_dir, 'refs', 'bases'), self.__name)
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):
+ committer_name = None, committer_email = None,
+ backup = False, sign_str = None, log = 'refresh'):
"""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):
if not committer_email:
committer_email = patch.get_commemail()
+ if sign_str:
+ descr = '%s\n%s: %s <%s>\n' % (descr.rstrip(), sign_str,
+ committer_name, committer_email)
+
+ bottom = patch.get_bottom()
+
commit_id = git.commit(files = files,
- message = descr, parents = [patch.get_bottom()],
+ message = descr, parents = [bottom],
cache_update = cache_update,
allowempty = True,
author_name = author_name,
committer_name = committer_name,
committer_email = committer_email)
- patch.set_top(commit_id)
+ patch.set_bottom(bottom, backup = backup)
+ patch.set_top(commit_id, backup = backup)
patch.set_description(descr)
patch.set_authname(author_name)
patch.set_authemail(author_email)
patch.set_commname(committer_name)
patch.set_commemail(committer_email)
+ if log:
+ self.log_patch(patch, log)
+
return commit_id
+ def undo_refresh(self):
+ """Undo the patch boundaries changes caused by 'refresh'
+ """
+ name = self.get_current()
+ assert(name)
+
+ patch = Patch(name, self.__patch_dir, self.__refs_dir)
+ old_bottom = patch.get_old_bottom()
+ old_top = patch.get_old_top()
+
+ # the bottom of the patch is not changed by refresh. If the
+ # old_bottom is different, there wasn't any previous 'refresh'
+ # command (probably only a 'push')
+ if old_bottom != patch.get_bottom() or old_top == patch.get_top():
+ raise StackException, 'No refresh undo information available'
+
+ git.reset(tree_id = old_top, check_out = False)
+ if patch.restore_old_boundaries():
+ self.log_patch(patch, 'undo')
+
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):
+ committer_name = None, committer_email = None,
+ before_existing = False, refresh = True):
"""Creates a new patch
"""
if self.__patch_applied(name) or self.__patch_unapplied(name):
self.__begin_stack_check()
- patch = Patch(name, self.__patch_dir)
+ patch = Patch(name, self.__patch_dir, self.__refs_dir)
patch.create()
if bottom:
patch.set_commemail(committer_email)
if unapplied:
+ self.log_patch(patch, 'new')
+
patches = [patch.get_name()] + self.get_unapplied()
f = file(self.__unapplied_file, 'w+')
f.writelines([line + '\n' for line in patches])
f.close()
+ elif before_existing:
+ self.log_patch(patch, 'new')
+
+ 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)
+ if refresh:
+ self.refresh_patch(cache_update = False, log = 'new')
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)
elif not name in self.get_unapplied():
raise StackException, 'Unknown patch "%s"' % name
+ # save the commit id to a trash file
+ write_string(os.path.join(self.__trash_dir, name), patch.get_top())
+
patch.delete()
unapplied = self.get_unapplied()
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.
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()
# top != bottom always since we have a commit for each patch
if head == bottom:
- # reset the backup information
+ # reset the backup information. No logging since the
+ # patch hasn't changed
patch.set_bottom(head, backup = True)
patch.set_top(top, backup = True)
patch.set_bottom(head, backup = True)
patch.set_top(top, backup = True)
+
+ self.log_patch(patch, 'push(f)')
else:
top = head
# stop the fast-forwarding, must do a real merge
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()):
+ 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()
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()
modified = False
# top != bottom always since we have a commit for each patch
- if head == bottom:
- # reset the backup information
+ 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. No need for logging
patch.set_bottom(bottom, backup = True)
patch.set_top(top, backup = True)
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
- self.refresh_patch(cache_update = False)
+ if modified:
+ log = 'push(m)'
+ else:
+ log = 'push'
+ self.refresh_patch(cache_update = False, log = log)
else:
raise StackException, str(ex)
name = self.get_current()
assert(name)
- patch = Patch(name, self.__patch_dir)
+ patch = Patch(name, self.__patch_dir, self.__refs_dir)
+ old_bottom = patch.get_old_bottom()
+ old_top = patch.get_old_top()
+
+ # the top of the patch is changed by a push operation only
+ # together with the bottom (otherwise the top was probably
+ # modified by 'refresh'). If they are both unchanged, there
+ # was a fast forward
+ if old_bottom == patch.get_bottom() and old_top != patch.get_top():
+ raise StackException, 'No push undo information available'
+
git.reset()
self.pop_patch(name)
- return patch.restore_old_boundaries()
+ ret = patch.restore_old_boundaries()
+ if ret:
+ self.log_patch(patch, 'undo')
+
+ return ret
- def pop_patch(self, name):
+ def pop_patch(self, name, keep = False):
"""Pops the top patch from the stack
"""
applied = self.get_applied()
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())
+ # only keep the local changes
+ if keep and not git.apply_diff(git.get_head(), patch.get_bottom()):
+ raise StackException, \
+ 'Failed to pop patches while preserving the local changes'
+
+ git.switch(patch.get_bottom(), keep)
# save the new applied list
idx = applied.index(name) + 1
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()
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)
f.close()
else:
raise StackException, 'Unknown patch "%s"' % oldname
+
+ def log_patch(self, patch, message):
+ """Generate a log commit for a patch
+ """
+ top = git.get_commit(patch.get_top())
+ msg = '%s\t%s' % (message, top.get_id_hash())
+
+ old_log = patch.get_log()
+ if old_log:
+ parents = [old_log]
+ else:
+ parents = []
+
+ log = git.commit(message = msg, parents = parents,
+ cache_update = False, tree_id = top.get_tree(),
+ allowempty = True)
+ patch.set_log(log)