import sys, os
from stgit.utils import *
-from stgit import git
+from stgit import git, basedir, templates
from stgit.config import config
f.seek(0); f.truncate()
f.writelines(lines)
-def edit_file(series, string, comment, show_patch = True):
- fname = '.stgit.msg'
- tmpl = os.path.join(git.base_dir, 'patchdescr.tmpl')
+def edit_file(series, line, comment, show_patch = True):
+ fname = '.stgitmsg.txt'
+ tmpl = templates.get_template('patchdescr.tmpl')
f = file(fname, 'w+')
- if string:
- print >> f, string
- elif os.path.isfile(tmpl):
- print >> f, file(tmpl).read().rstrip()
+ if line:
+ print >> f, line
+ elif tmpl:
+ print >> f, tmpl,
else:
print >> f
print >> f, __comment_prefix, comment
__clean_comments(f)
f.seek(0)
- string = f.read()
+ result = f.read()
f.close()
os.remove(fname)
- return string
+ return result
#
# Classes
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)
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_bottom(self):
return self.__get_field('bottom')
- def set_bottom(self, string, backup = False):
+ def set_bottom(self, value, backup = False):
if backup:
curr = self.__get_field('bottom')
- if curr != string:
- self.__set_field('bottom.old', curr)
- else:
- self.__set_field('bottom.old', None)
- self.__set_field('bottom', string)
+ self.__set_field('bottom.old', curr)
+ 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:
curr = self.__get_field('top')
- if curr != string:
- self.__set_field('top.old', curr)
- else:
- self.__set_field('top.old', None)
- self.__set_field('top', string)
+ 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
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:
def __init__(self, name = None):
"""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')
- self.__descr_file = os.path.join(self.__patch_dir, 'description')
+ 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
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
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.__patch_dir, 'protected'))
+ return os.path.isfile(os.path.join(self.__series_dir, 'protected'))
def protect(self):
- protect_file = os.path.join(self.__patch_dir, 'protected')
+ 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.__patch_dir, 'protected')
+ protect_file = os.path.join(self.__series_dir, 'protected')
if os.path.isfile(protect_file):
os.remove(protect_file)
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):
+ def init(self, create_at=False):
"""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 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
+ """
+ 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):
+ rename(os.path.join(self.__base_dir, 'patches'),
+ self.__name, to_stack.__name)
+ if os.path.exists(self.__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)
+
+ def clone(self, target_series):
+ """Clones a series
+ """
+ base = read_string(self.get_base_file())
+ Series(target_series).init(create_at = base)
+ 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 os.path.isdir(self.__patch_dir):
+ 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'
- patches.reverse()
for p in patches:
- self.delete_patch(p)
+ Patch(p, self.__patch_dir, self.__refs_dir).delete()
- if os.path.isfile(self.__applied_file):
+ if os.path.exists(self.__applied_file):
os.remove(self.__applied_file)
- if os.path.isfile(self.__unapplied_file):
+ if os.path.exists(self.__unapplied_file):
os.remove(self.__unapplied_file)
- if os.path.isfile(self.__current_file):
+ if os.path.exists(self.__current_file):
os.remove(self.__current_file)
- if os.path.isfile(self.__descr_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):
+ 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.isfile(self.__base_file):
- os.remove(self.__base_file)
+ if os.path.exists(self.__base_file):
+ remove_file_and_dirs(
+ os.path.join(self.__base_dir, 'refs', 'bases'), self.__name)
- def refresh_patch(self, message = None, edit = False, show_patch = False,
+ 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):
"""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()
- commit_id = git.commit(message = descr, parents = [patch.get_bottom()],
+ bottom = patch.get_bottom()
+
+ commit_id = git.commit(files = files,
+ 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)
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)
+ patch.restore_old_boundaries()
+
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):
"""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:
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)
+
+ self.refresh_patch(cache_update = False)
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)
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()
forwarded+=1
unapplied.remove(name)
+ if forwarded == 0:
+ return 0
+
git.switch(top)
append_strings(self.__applied_file, names[0:forwarded])
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:
+ 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)
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
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()
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())
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()
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)
~mdw / stgit / blobdiff