Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
-import sys, os, re, gitmergeonefile
+import sys, os, re
from shutil import copyfile
from stgit.exception import *
pass
class GRun(Run):
exc = GitRunException
-
+ def __init__(self, *cmd):
+ """Initialise the Run object and insert the 'git' command name.
+ """
+ Run.__init__(self, 'git', *cmd)
#
# Classes
def __init__(self, id_hash):
self.__id_hash = id_hash
- lines = GRun('git-cat-file', 'commit', id_hash).output_lines()
+ lines = GRun('cat-file', 'commit', id_hash).output_lines()
for i in range(len(lines)):
line = lines[i]
if not line:
return None
def get_parents(self):
- return GRun('git-rev-list', '--parents', '--max-count=1', self.__id_hash
+ return GRun('rev-list', '--parents', '--max-count=1', self.__id_hash
).output_one_line().split()[1:]
def get_author(self):
def get_conflicts():
"""Return the list of file conflicts
"""
- conflicts_file = os.path.join(basedir.get(), 'conflicts')
- if os.path.isfile(conflicts_file):
- f = file(conflicts_file)
- names = [line.strip() for line in f.readlines()]
- f.close()
- return names
- else:
- return None
+ names = set()
+ for line in GRun('ls-files', '-z', '--unmerged'
+ ).raw_output().split('\0')[:-1]:
+ stat, path = line.split('\t', 1)
+ names.add(path)
+ return list(names)
def exclude_files():
files = [os.path.join(basedir.get(), 'info', 'exclude')]
files.append(user_exclude)
return files
+def ls_files(files, tree = 'HEAD', full_name = True):
+ """Return the files known to GIT or raise an error otherwise. It also
+ converts the file to the full path relative the the .git directory.
+ """
+ if not files:
+ return []
+
+ args = []
+ if tree:
+ args.append('--with-tree=%s' % tree)
+ if full_name:
+ args.append('--full-name')
+ args.append('--')
+ args.extend(files)
+ try:
+ # use a set to avoid file names duplication due to different stages
+ fileset = set(GRun('ls-files', '--error-unmatch', *args).output_lines())
+ except GitRunException:
+ # just hide the details of the 'git ls-files' command we use
+ raise GitException, \
+ 'Some of the given paths are either missing or not known to GIT'
+ return list(fileset)
+
+def parse_git_ls(output):
+ """Parse the output of git diff-index, diff-files, etc. Doesn't handle
+ rename/copy output, so don't feed it output generated with the -M
+ or -C flags."""
+ t = None
+ for line in output.split('\0'):
+ if not line:
+ # There's a zero byte at the end of the output, which
+ # gives us an empty string as the last "line".
+ continue
+ if t == None:
+ mode_a, mode_b, sha1_a, sha1_b, t = line.split(' ')
+ else:
+ yield (t, line)
+ t = None
+
def tree_status(files = None, tree_id = 'HEAD', unknown = False,
- noexclude = True, verbose = False, diff_flags = []):
+ noexclude = True, verbose = False):
"""Get the status of all changed files, or of a selected set of
files. Returns a list of pairs - (status, filename).
- If 'files' is None, it will check all files, and optionally all
+ If 'not files', it will check all files, and optionally all
unknown files. If 'files' is a list, it will only check the files
in the list.
"""
- assert files == None or not unknown
+ assert not files or not unknown
if verbose:
out.start('Checking for changes in the working directory')
refresh_index()
+ if files is None:
+ files = []
cache_files = []
# unknown files
if unknown:
- cmd = ['git-ls-files', '-z', '--others', '--directory',
+ cmd = ['ls-files', '-z', '--others', '--directory',
'--no-empty-directory']
if not noexclude:
cmd += ['--exclude=%s' % s for s in
# conflicted files
conflicts = get_conflicts()
- if not conflicts:
- conflicts = []
cache_files += [('C', filename) for filename in conflicts
- if files == None or filename in files]
-
- # the rest
- args = diff_flags + [tree_id]
- if files != None:
- args += ['--'] + files
- for line in GRun('git-diff-index', *args).output_lines():
- fs = tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
- if fs[1] not in conflicts:
- cache_files.append(fs)
+ if not files or filename in files]
+ reported_files = set(conflicts)
+ files_left = [f for f in files if f not in reported_files]
+
+ # files in the index. Only execute this code if no files were
+ # specified when calling the function (i.e. report all files) or
+ # files were specified but already found in the previous step
+ if not files or files_left:
+ args = [tree_id]
+ if files_left:
+ args += ['--'] + files_left
+ for t, fn in parse_git_ls(GRun('diff-index', '-z', *args).raw_output()):
+ # the condition is needed in case files is emtpy and
+ # diff-index lists those already reported
+ if not fn in reported_files:
+ cache_files.append((t, fn))
+ reported_files.add(fn)
+ files_left = [f for f in files if f not in reported_files]
+
+ # files in the index but changed on (or removed from) disk. Only
+ # execute this code if no files were specified when calling the
+ # function (i.e. report all files) or files were specified but
+ # already found in the previous step
+ if not files or files_left:
+ args = []
+ if files_left:
+ args += ['--'] + files_left
+ for t, fn in parse_git_ls(GRun('diff-files', '-z', *args).raw_output()):
+ # the condition is needed in case files is empty and
+ # diff-files lists those already reported
+ if not fn in reported_files:
+ cache_files.append((t, fn))
+ reported_files.add(fn)
if verbose:
out.done()
- assert files == None or set(f for s,f in cache_files) <= set(files)
return cache_files
def local_changes(verbose = True):
def get_heads():
heads = []
hr = re.compile(r'^[0-9a-f]{40} refs/heads/(.+)$')
- for line in GRun('git-show-ref', '--heads').output_lines():
+ for line in GRun('show-ref', '--heads').output_lines():
m = hr.match(line)
heads.append(m.group(1))
return heads
Throw an exception if HEAD is detached."""
try:
return strip_prefix(
- 'refs/heads/', GRun('git-symbolic-ref', '-q', 'HEAD'
+ 'refs/heads/', GRun('symbolic-ref', '-q', 'HEAD'
).output_one_line())
except GitRunException:
raise DetachedHeadException()
# in the new head
__clear_head_cache()
try:
- GRun('git-symbolic-ref', 'HEAD', 'refs/heads/%s' % ref).run()
+ GRun('symbolic-ref', 'HEAD', 'refs/heads/%s' % ref).run()
except GitRunException:
raise GitException, 'Could not set head to "%s"' % ref
def set_ref(ref, val):
"""Point ref at a new commit object."""
try:
- GRun('git-update-ref', ref, val).run()
+ GRun('update-ref', ref, val).run()
except GitRunException:
raise GitException, 'Could not update %s to "%s".' % (ref, val)
def refresh_index():
"""Refresh index with stat() information from the working directory.
"""
- GRun('git-update-index', '-q', '--unmerged', '--refresh').run()
+ GRun('update-index', '-q', '--unmerged', '--refresh').run()
def rev_parse(git_id):
"""Parse the string and return a verified SHA1 id
"""
try:
- return GRun('git-rev-parse', '--verify', git_id
+ return GRun('rev-parse', '--verify', git_id
).discard_stderr().output_one_line()
except GitRunException:
raise GitException, 'Unknown revision: %s' % git_id
if branch_exists(new_branch):
raise GitException, 'Branch "%s" already exists' % new_branch
+ current_head_file = get_head_file()
current_head = get_head()
set_head_file(new_branch)
__set_head(current_head)
# a checkout isn't needed if new branch points to the current head
if tree_id:
- switch(tree_id)
+ try:
+ switch(tree_id)
+ except GitException:
+ # Tree switching failed. Revert the head file
+ set_head_file(current_head_file)
+ delete_branch(new_branch)
+ raise
if os.path.isfile(os.path.join(basedir.get(), 'MERGE_HEAD')):
os.remove(os.path.join(basedir.get(), 'MERGE_HEAD'))
if tree_id != get_head():
refresh_index()
try:
- GRun('git-read-tree', '-u', '-m', get_head(), tree_id).run()
+ GRun('read-tree', '-u', '-m', get_head(), tree_id).run()
except GitRunException:
- raise GitException, 'git-read-tree failed (local changes maybe?)'
+ raise GitException, 'read-tree failed (local changes maybe?)'
__head = tree_id
set_head_file(new_branch)
def delete_ref(ref):
if not ref_exists(ref):
raise GitException, '%s does not exist' % ref
- sha1 = GRun('git-show-ref', '-s', ref).output_one_line()
+ sha1 = GRun('show-ref', '-s', ref).output_one_line()
try:
- GRun('git-update-ref', '-d', ref, sha1).run()
+ GRun('update-ref', '-d', ref, sha1).run()
except GitRunException:
raise GitException, 'Failed to delete ref %s' % ref
if ref_exists(to_ref):
raise GitException, '"%s" already exists' % to_ref
- sha1 = GRun('git-show-ref', '-s', from_ref).output_one_line()
+ sha1 = GRun('show-ref', '-s', from_ref).output_one_line()
try:
- GRun('git-update-ref', to_ref, sha1, '0'*40).run()
+ GRun('update-ref', to_ref, sha1, '0'*40).run()
except GitRunException:
raise GitException, 'Failed to create new ref %s' % to_ref
try:
- GRun('git-update-ref', '-d', from_ref, sha1).run()
+ GRun('update-ref', '-d', from_ref, sha1).run()
except GitRunException:
raise GitException, 'Failed to delete ref %s' % from_ref
and os.path.exists(os.path.join(reflog_dir, from_name)):
rename(reflog_dir, from_name, to_name)
-def add(names):
- """Add the files or recursively add the directory contents
- """
- # generate the file list
- files = []
- for i in names:
- if not os.path.exists(i):
- raise GitException, 'Unknown file or directory: %s' % i
-
- if os.path.isdir(i):
- # recursive search. We only add files
- for root, dirs, local_files in os.walk(i):
- for name in [os.path.join(root, f) for f in local_files]:
- if os.path.isfile(name):
- files.append(os.path.normpath(name))
- elif os.path.isfile(i):
- files.append(os.path.normpath(i))
- else:
- raise GitException, '%s is not a file or directory' % i
-
- if files:
- try:
- GRun('git-update-index', '--add', '--').xargs(files)
- except GitRunException:
- raise GitException, 'Unable to add file'
-
-def __copy_single(source, target, target2=''):
- """Copy file or dir named 'source' to name target+target2"""
-
- # "source" (file or dir) must match one or more git-controlled file
- realfiles = GRun('git-ls-files', source).output_lines()
- if len(realfiles) == 0:
- raise GitException, '"%s" matches no git-controled files' % source
-
- if os.path.isdir(source):
- # physically copy the files, and record them to add them in one run
- newfiles = []
- re_string='^'+source+'/(.*)$'
- prefix_regexp = re.compile(re_string)
- for f in [f.strip() for f in realfiles]:
- m = prefix_regexp.match(f)
- if not m:
- raise Exception, '"%s" does not match "%s"' % (f, re_string)
- newname = target+target2+'/'+m.group(1)
- if not os.path.exists(os.path.dirname(newname)):
- os.makedirs(os.path.dirname(newname))
- copyfile(f, newname)
- newfiles.append(newname)
-
- add(newfiles)
- else: # files, symlinks, ...
- newname = target+target2
- copyfile(source, newname)
- add([newname])
-
-
-def copy(filespecs, target):
- if os.path.isdir(target):
- # target is a directory: copy each entry on the command line,
- # with the same name, into the target
- target = target.rstrip('/')
-
- # first, check that none of the children of the target
- # matching the command line aleady exist
- for filespec in filespecs:
- entry = target+ '/' + os.path.basename(filespec.rstrip('/'))
- if os.path.exists(entry):
- raise GitException, 'Target "%s" already exists' % entry
-
- for filespec in filespecs:
- filespec = filespec.rstrip('/')
- basename = '/' + os.path.basename(filespec)
- __copy_single(filespec, target, basename)
-
- elif os.path.exists(target):
- raise GitException, 'Target "%s" exists but is not a directory' % target
- elif len(filespecs) != 1:
- raise GitException, 'Cannot copy more than one file to non-directory'
-
- else:
- # at this point: len(filespecs)==1 and target does not exist
-
- # check target directory
- targetdir = os.path.dirname(target)
- if targetdir != '' and not os.path.isdir(targetdir):
- raise GitException, 'Target directory "%s" does not exist' % targetdir
-
- __copy_single(filespecs[0].rstrip('/'), target)
-
-
-def rm(files, force = False):
- """Remove a file from the repository
- """
- if not force:
- for f in files:
- if os.path.exists(f):
- raise GitException, '%s exists. Remove it first' %f
- if files:
- GRun('git-update-index', '--remove', '--').xargs(files)
- else:
- if files:
- GRun('git-update-index', '--force-remove', '--').xargs(files)
-
# Persons caching
__user = None
__author = None
rm_files = [x[1] for x in cache_files if x[0] in ['D']]
m_files = [x[1] for x in cache_files if x[0] in ['M']]
- GRun('git-update-index', '--add', '--').xargs(add_files)
- GRun('git-update-index', '--force-remove', '--').xargs(rm_files)
- GRun('git-update-index', '--').xargs(m_files)
+ GRun('update-index', '--add', '--').xargs(add_files)
+ GRun('update-index', '--force-remove', '--').xargs(rm_files)
+ GRun('update-index', '--').xargs(m_files)
return True
# write the index to repository
if tree_id == None:
- tree_id = GRun('git-write-tree').output_one_line()
+ tree_id = GRun('write-tree').output_one_line()
set_head = True
# the commit
env['GIT_COMMITTER_NAME'] = committer_name
if committer_email:
env['GIT_COMMITTER_EMAIL'] = committer_email
- commit_id = GRun('git-commit-tree', tree_id,
+ commit_id = GRun('commit-tree', tree_id,
*sum([['-p', p] for p in parents], [])
).env(env).raw_input(message).output_one_line()
if set_head:
diff_str = diff(files, rev1, rev2)
if diff_str:
try:
- GRun('git-apply', *index_opt).raw_input(
+ GRun('apply', *index_opt).raw_input(
diff_str).discard_stderr().no_output()
except GitRunException:
return False
return True
-def merge(base, head1, head2, recursive = False):
+stages_re = re.compile('^([0-7]+) ([0-9a-f]{40}) ([1-3])\t(.*)$', re.S)
+
+def merge_recursive(base, head1, head2):
"""Perform a 3-way merge between base, head1 and head2 into the
local tree
"""
refresh_index()
-
- err_output = None
- if recursive:
- # this operation tracks renames but it is slower (used in
- # general when pushing or picking patches)
- try:
- # discard output to mask the verbose prints of the tool
- GRun('git-merge-recursive', base, '--', head1, head2
- ).discard_output()
- except GitRunException, ex:
- err_output = str(ex)
- pass
- else:
- # the fast case where we don't track renames (used when the
- # distance between base and heads is small, i.e. folding or
- # synchronising patches)
- try:
- GRun('git-read-tree', '-u', '-m', '--aggressive',
- base, head1, head2).run()
- except GitRunException:
- raise GitException, 'git-read-tree failed (local changes maybe?)'
-
- # check the index for unmerged entries
- files = {}
- stages_re = re.compile('^([0-7]+) ([0-9a-f]{40}) ([1-3])\t(.*)$', re.S)
-
- for line in GRun('git-ls-files', '--unmerged', '--stage', '-z'
- ).raw_output().split('\0'):
- if not line:
- continue
-
- mode, hash, stage, path = stages_re.findall(line)[0]
-
- if not path in files:
- files[path] = {}
- files[path]['1'] = ('', '')
- files[path]['2'] = ('', '')
- files[path]['3'] = ('', '')
-
- files[path][stage] = (mode, hash)
-
- if err_output and not files:
- # if no unmerged files, there was probably a different type of
- # error and we have to abort the merge
- raise GitException, err_output
-
- # merge the unmerged files
- errors = False
- for path in files:
- # remove additional files that might be generated for some
- # newer versions of GIT
- for suffix in [base, head1, head2]:
- if not suffix:
- continue
- fname = path + '~' + suffix
- if os.path.exists(fname):
- os.remove(fname)
-
- stages = files[path]
- if gitmergeonefile.merge(stages['1'][1], stages['2'][1],
- stages['3'][1], path, stages['1'][0],
- stages['2'][0], stages['3'][0]) != 0:
- errors = True
-
- if errors:
- raise GitException, 'GIT index merging failed (possible conflicts)'
-
-def diff(files = None, rev1 = 'HEAD', rev2 = None, diff_flags = []):
+ p = GRun('merge-recursive', base, '--', head1, head2).env(
+ { 'GITHEAD_%s' % base: 'ancestor',
+ 'GITHEAD_%s' % head1: 'current',
+ 'GITHEAD_%s' % head2: 'patched'}).returns([0, 1])
+ output = p.output_lines()
+ if p.exitcode:
+ # There were conflicts
+ if config.get('stgit.autoimerge') == 'yes':
+ mergetool()
+ else:
+ conflicts = [l for l in output if l.startswith('CONFLICT')]
+ out.info(*conflicts)
+ raise GitException, "%d conflict(s)" % len(conflicts)
+
+def mergetool(files = ()):
+ """Invoke 'git mergetool' to resolve any outstanding conflicts. If 'not
+ files', all the files in an unmerged state will be processed."""
+ GRun('mergetool', *list(files)).returns([0, 1]).run()
+ # check for unmerged entries (prepend 'CONFLICT ' for consistency with
+ # merge_recursive())
+ conflicts = ['CONFLICT ' + f for f in get_conflicts()]
+ if conflicts:
+ out.info(*conflicts)
+ raise GitException, "%d conflict(s)" % len(conflicts)
+
+def diff(files = None, rev1 = 'HEAD', rev2 = None, diff_flags = [],
+ binary = True):
"""Show the diff between rev1 and rev2
"""
if not files:
files = []
+ if binary and '--binary' not in diff_flags:
+ diff_flags = diff_flags + ['--binary']
if rev1 and rev2:
- return GRun('git-diff-tree', '-p',
+ return GRun('diff-tree', '-p',
*(diff_flags + [rev1, rev2, '--'] + files)).raw_output()
elif rev1 or rev2:
refresh_index()
if rev2:
- return GRun('git-diff-index', '-p', '-R',
+ return GRun('diff-index', '-p', '-R',
*(diff_flags + [rev2, '--'] + files)).raw_output()
else:
- return GRun('git-diff-index', '-p',
+ return GRun('diff-index', '-p',
*(diff_flags + [rev1, '--'] + files)).raw_output()
else:
return ''
-# TODO: take another parameter representing a diff string as we
-# usually invoke git.diff() form the calling functions
-def diffstat(files = None, rev1 = 'HEAD', rev2 = None):
- """Return the diffstat between rev1 and rev2."""
- return GRun('git-apply', '--stat', '--summary'
- ).raw_input(diff(files, rev1, rev2)).raw_output()
-
def files(rev1, rev2, diff_flags = []):
"""Return the files modified between rev1 and rev2
"""
result = []
- for line in GRun('git-diff-tree', *(diff_flags + ['-r', rev1, rev2])
+ for line in GRun('diff-tree', *(diff_flags + ['-r', rev1, rev2])
).output_lines():
result.append('%s %s' % tuple(line.split(' ', 4)[-1].split('\t', 1)))
"""
result = []
- for line in GRun('git-diff-tree', '-r', rev1, rev2).output_lines():
+ for line in GRun('diff-tree', '-r', rev1, rev2).output_lines():
result.append(line.split(' ', 4)[-1].split('\t', 1)[-1])
return '\n'.join(result)
-def pretty_commit(commit_id = 'HEAD', diff_flags = []):
+def pretty_commit(commit_id = 'HEAD', flags = []):
"""Return a given commit (log + diff)
"""
- return GRun('git-diff-tree',
- *(diff_flags
- + ['--cc', '--always', '--pretty', '-r', commit_id])
- ).raw_output()
+ return GRun('show', *(flags + [commit_id])).raw_output()
def checkout(files = None, tree_id = None, force = False):
"""Check out the given or all files
"""
if tree_id:
try:
- GRun('git-read-tree', '--reset', tree_id).run()
+ GRun('read-tree', '--reset', tree_id).run()
except GitRunException:
- raise GitException, 'Failed git-read-tree --reset %s' % tree_id
+ raise GitException, 'Failed "git read-tree" --reset %s' % tree_id
- cmd = ['git-checkout-index', '-q', '-u']
+ cmd = ['checkout-index', '-q', '-u']
if force:
cmd.append('-f')
if files:
def switch(tree_id, keep = False):
"""Switch the tree to the given id
"""
- if not keep:
+ if keep:
+ # only update the index while keeping the local changes
+ GRun('read-tree', tree_id).run()
+ else:
refresh_index()
try:
- GRun('git-read-tree', '-u', '-m', get_head(), tree_id).run()
+ GRun('read-tree', '-u', '-m', get_head(), tree_id).run()
except GitRunException:
- raise GitException, 'git-read-tree failed (local changes maybe?)'
+ raise GitException, 'read-tree failed (local changes maybe?)'
__set_head(tree_id)
if not files:
__set_head(tree_id)
+def resolved(filenames, reset = None):
+ if reset:
+ stage = {'ancestor': 1, 'current': 2, 'patched': 3}[reset]
+ GRun('checkout-index', '--no-create', '--stage=%d' % stage,
+ '--stdin', '-z').input_nulterm(filenames).no_output()
+ GRun('update-index', '--add', '--').xargs(filenames)
+ for filename in filenames:
+ # update the access and modificatied times
+ os.utime(filename, None)
+
def fetch(repository = 'origin', refspec = None):
- """Fetches changes from the remote repository, using 'git-fetch'
+ """Fetches changes from the remote repository, using 'git fetch'
by default.
"""
# we update the HEAD
command = config.get('branch.%s.stgit.fetchcmd' % get_head_file()) or \
config.get('stgit.fetchcmd')
- GRun(*(command.split() + args)).run()
+ Run(*(command.split() + args)).run()
def pull(repository = 'origin', refspec = None):
- """Fetches changes from the remote repository, using 'git-pull'
+ """Fetches changes from the remote repository, using 'git pull'
by default.
"""
# we update the HEAD
command = config.get('branch.%s.stgit.pullcmd' % get_head_file()) or \
config.get('stgit.pullcmd')
- GRun(*(command.split() + args)).run()
+ Run(*(command.split() + args)).run()
def rebase(tree_id = None):
"""Rebase the current tree to the give tree_id. The tree_id
if command:
# clear the HEAD cache as the custom rebase command will update it
__clear_head_cache()
- GRun(*(command.split() + args)).run()
+ Run(*(command.split() + args)).run()
else:
# default rebasing
reset(tree_id = tree_id)
def repack():
"""Repack all objects into a single pack
"""
- GRun('git-repack', '-a', '-d', '-f').run()
+ GRun('repack', '-a', '-d', '-f').run()
def apply_patch(filename = None, diff = None, base = None,
- fail_dump = True):
+ fail_dump = True, reject = False):
"""Apply a patch onto the current or given index. There must not
be any local changes in the tree, otherwise the command fails
"""
else:
refresh_index()
+ cmd = ['apply', '--index']
+ if reject:
+ cmd += ['--reject']
try:
- GRun('git-apply', '--index').raw_input(diff).no_output()
+ GRun(*cmd).raw_input(diff).no_output()
except GitRunException:
if base:
switch(orig_head)
top = commit(message = 'temporary commit used for applying a patch',
parents = [base])
switch(orig_head)
- merge(base, orig_head, top)
+ merge_recursive(base, orig_head, top)
def clone(repository, local_dir):
"""Clone a remote repository. At the moment, just use the
- 'git-clone' script
+ 'git clone' script
"""
- GRun('git-clone', repository, local_dir).run()
+ GRun('clone', repository, local_dir).run()
def modifying_revs(files, base_rev, head_rev):
"""Return the revisions from the list modifying the given files."""
- return GRun('git-rev-list', '%s..%s' % (base_rev, head_rev), '--', *files
+ return GRun('rev-list', '%s..%s' % (base_rev, head_rev), '--', *files
).output_lines()
def refspec_localpart(refspec):
return m.group(1)
else:
raise GitException, 'Cannot parse refspec "%s"' % line
-
def __remotes_from_config():
return config.sections_matching(r'remote\.(.*)\.url')
"""Return a list of all refs in the current repository.
"""
- return [line.split()[1] for line in GRun('git-show-ref').output_lines()]
+ return [line.split()[1] for line in GRun('show-ref').output_lines()]
~mdw / stgit / blobdiff