[stgit] / stgit / gitmergeonefile.py

"""Performs a 3-way merge for GIT files
"""

__copyright__ = """
Copyright (C) 2006, Catalin Marinas <catalin.marinas@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""

import sys, os
from stgit import basedir
from stgit.config import config, file_extensions, ConfigOption
from stgit.utils import append_string
from stgit.out import *
from stgit.run import *

class GitMergeException(Exception):
    pass


#
# Options
#
merger = ConfigOption('stgit', 'merger')
keeporig = ConfigOption('stgit', 'keeporig')

#
# Utility functions
#
def __str2none(x):
    if x == '':
        return None
    else:
        return x

class MRun(Run):
    exc = GitMergeException # use a custom exception class on errors

def __checkout_files(orig_hash, file1_hash, file2_hash,
                     path,
                     orig_mode, file1_mode, file2_mode):
    """Check out the files passed as arguments
    """
    global orig, src1, src2

    extensions = file_extensions()

    if orig_hash:
        orig = path + extensions['ancestor']
        tmp = MRun('git-unpack-file', orig_hash).output_one_line()
        os.chmod(tmp, int(orig_mode, 8))
        os.renames(tmp, orig)
    if file1_hash:
        src1 = path + extensions['current']
        tmp = MRun('git-unpack-file', file1_hash).output_one_line()
        os.chmod(tmp, int(file1_mode, 8))
        os.renames(tmp, src1)
    if file2_hash:
        src2 = path + extensions['patched']
        tmp = MRun('git-unpack-file', file2_hash).output_one_line()
        os.chmod(tmp, int(file2_mode, 8))
        os.renames(tmp, src2)

    if file1_hash and not os.path.exists(path):
        # the current file might be removed by GIT when it is a new
        # file added in both branches. Just re-generate it
        tmp = MRun('git-unpack-file', file1_hash).output_one_line()
        os.chmod(tmp, int(file1_mode, 8))
        os.renames(tmp, path)

def __remove_files(orig_hash, file1_hash, file2_hash):
    """Remove any temporary files
    """
    if orig_hash:
        os.remove(orig)
    if file1_hash:
        os.remove(src1)
    if file2_hash:
        os.remove(src2)

def __conflict(path):
    """Write the conflict file for the 'path' variable and exit
    """
    append_string(os.path.join(basedir.get(), 'conflicts'), path)


def interactive_merge(filename):
    """Run the interactive merger on the given file. Note that the
    index should not have any conflicts.
    """
    extensions = file_extensions()

    ancestor = filename + extensions['ancestor']
    current = filename + extensions['current']
    patched = filename + extensions['patched']

    if os.path.isfile(ancestor):
        three_way = True
        files_dict = {'branch1': current,
                      'ancestor': ancestor,
                      'branch2': patched,
                      'output': filename}
        imerger = config.get('stgit.i3merge')
    else:
        three_way = False
        files_dict = {'branch1': current,
                      'branch2': patched,
                      'output': filename}
        imerger = config.get('stgit.i2merge')

    if not imerger:
        raise GitMergeException, 'No interactive merge command configured'

    # check whether we have all the files for the merge
    for fn in [filename, current, patched]:
        if not os.path.isfile(fn):
            raise GitMergeException, \
                  'Cannot run the interactive merge: "%s" missing' % fn

    mtime = os.path.getmtime(filename)

    out.info('Trying the interactive %s merge'
             % (three_way and 'three-way' or 'two-way'))

    err = os.system(imerger % files_dict)
    if err != 0:
        raise GitMergeException, 'The interactive merge failed: %d' % err
    if not os.path.isfile(filename):
        raise GitMergeException, 'The "%s" file is missing' % filename
    if mtime == os.path.getmtime(filename):
        raise GitMergeException, 'The "%s" file was not modified' % filename


#
# Main algorithm
#
def merge(orig_hash, file1_hash, file2_hash,
          path,
          orig_mode, file1_mode, file2_mode):
    """Three-way merge for one file algorithm
    """
    __checkout_files(orig_hash, file1_hash, file2_hash,
                     path,
                     orig_mode, file1_mode, file2_mode)

    # file exists in origin
    if orig_hash:
        # modified in both
        if file1_hash and file2_hash:
            # if modes are the same (git-read-tree probably dealt with it)
            if file1_hash == file2_hash:
                if os.system('git-update-index --cacheinfo %s %s %s'
                             % (file1_mode, file1_hash, path)) != 0:
                    out.error('git-update-index failed')
                    __conflict(path)
                    return 1
                if os.system('git-checkout-index -u -f -- %s' % path):
                    out.error('git-checkout-index failed')
                    __conflict(path)
                    return 1
                if file1_mode != file2_mode:
                    out.error('File added in both, permissions conflict')
                    __conflict(path)
                    return 1
            # 3-way merge
            else:
                merge_ok = os.system(str(merger) % {'branch1': src1,
                                                    'ancestor': orig,
                                                    'branch2': src2,
                                                    'output': path }) == 0

                if merge_ok:
                    os.system('git-update-index -- %s' % path)
                    __remove_files(orig_hash, file1_hash, file2_hash)
                    return 0
                else:
                    out.error('Three-way merge tool failed for file "%s"'
                              % path)
                    # reset the cache to the first branch
                    os.system('git-update-index --cacheinfo %s %s %s'
                              % (file1_mode, file1_hash, path))

                    if config.get('stgit.autoimerge') == 'yes':
                        try:
                            interactive_merge(path)
                        except GitMergeException, ex:
                            # interactive merge failed
                            out.error(str(ex))
                            if str(keeporig) != 'yes':
                                __remove_files(orig_hash, file1_hash,
                                               file2_hash)
                            __conflict(path)
                            return 1
                        # successful interactive merge
                        os.system('git-update-index -- %s' % path)
                        __remove_files(orig_hash, file1_hash, file2_hash)
                        return 0
                    else:
                        # no interactive merge, just mark it as conflict
                        if str(keeporig) != 'yes':
                            __remove_files(orig_hash, file1_hash, file2_hash)
                        __conflict(path)
                        return 1

        # file deleted in both or deleted in one and unchanged in the other
        elif not (file1_hash or file2_hash) \
               or file1_hash == orig_hash or file2_hash == orig_hash:
            if os.path.exists(path):
                os.remove(path)
            __remove_files(orig_hash, file1_hash, file2_hash)
            return os.system('git-update-index --remove -- %s' % path)
        # file deleted in one and changed in the other
        else:
            # Do something here - we must at least merge the entry in
            # the cache, instead of leaving it in U(nmerged) state. In
            # fact, stg resolved does not handle that.

            # Do the same thing cogito does - remove the file in any case.
            os.system('git-update-index --remove -- %s' % path)

            #if file1_hash:
                ## file deleted upstream and changed in the patch. The
                ## patch is probably going to move the changes
                ## elsewhere.

                #os.system('git-update-index --remove -- %s' % path)
            #else:
                ## file deleted in the patch and changed upstream. We
                ## could re-delete it, but for now leave it there -
                ## and let the user check if he still wants to remove
                ## the file.

                ## reset the cache to the first branch
                #os.system('git-update-index --cacheinfo %s %s %s'
                #          % (file1_mode, file1_hash, path))
            __conflict(path)
            return 1

    # file does not exist in origin
    else:
        # file added in both
        if file1_hash and file2_hash:
            # files are the same
            if file1_hash == file2_hash:
                if os.system('git-update-index --add --cacheinfo %s %s %s'
                             % (file1_mode, file1_hash, path)) != 0:
                    out.error('git-update-index failed')
                    __conflict(path)
                    return 1
                if os.system('git-checkout-index -u -f -- %s' % path):
                    out.error('git-checkout-index failed')
                    __conflict(path)
                    return 1
                if file1_mode != file2_mode:
                    out.error('File "s" added in both, permissions conflict'
                              % path)
                    __conflict(path)
                    return 1
            # files added in both but different
            else:
                out.error('File "%s" added in branches but different' % path)
                # reset the cache to the first branch
                os.system('git-update-index --cacheinfo %s %s %s'
                          % (file1_mode, file1_hash, path))

                if config.get('stgit.autoimerge') == 'yes':
                    try:
                        interactive_merge(path)
                    except GitMergeException, ex:
                        # interactive merge failed
                        out.error(str(ex))
                        if str(keeporig) != 'yes':
                            __remove_files(orig_hash, file1_hash,
                                           file2_hash)
                        __conflict(path)
                        return 1
                    # successful interactive merge
                    os.system('git-update-index -- %s' % path)
                    __remove_files(orig_hash, file1_hash, file2_hash)
                    return 0
                else:
                    # no interactive merge, just mark it as conflict
                    if str(keeporig) != 'yes':
                        __remove_files(orig_hash, file1_hash, file2_hash)
                    __conflict(path)
                    return 1
        # file added in one
        elif file1_hash or file2_hash:
            if file1_hash:
                mode = file1_mode
                obj = file1_hash
            else:
                mode = file2_mode
                obj = file2_hash
            if os.system('git-update-index --add --cacheinfo %s %s %s'
                         % (mode, obj, path)) != 0:
                out.error('git-update-index failed')
                __conflict(path)
                return 1
            __remove_files(orig_hash, file1_hash, file2_hash)
            return os.system('git-checkout-index -u -f -- %s' % path)

    # Unhandled case
    out.error('Unhandled merge conflict: "%s" "%s" "%s" "%s" "%s" "%s" "%s"'
              % (orig_hash, file1_hash, file2_hash,
                 path,
                 orig_mode, file1_mode, file2_mode))
    __conflict(path)
    return 1
Commit	Line	Data
3659ef88 CM	1	"""Performs a 3-way merge for GIT files
	2	"""
	3
	4	__copyright__ = """
	5	Copyright (C) 2006, Catalin Marinas <catalin.marinas@gmail.com>
	6
	7	This program is free software; you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License version 2 as
	9	published by the Free Software Foundation.
	10
	11	This program is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
	15
	16	You should have received a copy of the GNU General Public License
	17	along with this program; if not, write to the Free Software
	18	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	"""
	20
	21	import sys, os
170f576b	22	from stgit import basedir
f7ed76a9	23	from stgit.config import config, file_extensions, ConfigOption
5e888f30 KH	24	from stgit.utils import append_string
5e888f30 KH	25	from stgit.out import *
f0de3f92	26	from stgit.run import *
3659ef88 CM	27
	28	class GitMergeException(Exception):
	29	pass
	30
	31
	32	#
	33	# Options
	34	#
eee7283e CM	35	merger = ConfigOption('stgit', 'merger')
eee7283e CM	36	keeporig = ConfigOption('stgit', 'keeporig')
3659ef88 CM	37
	38	#
	39	# Utility functions
	40	#
	41	def __str2none(x):
	42	if x == '':
	43	return None
	44	else:
	45	return x
	46
f0de3f92 KH	47	class MRun(Run):
f0de3f92 KH	48	exc = GitMergeException # use a custom exception class on errors
3659ef88 CM	49
	50	def __checkout_files(orig_hash, file1_hash, file2_hash,
	51	path,
	52	orig_mode, file1_mode, file2_mode):
	53	"""Check out the files passed as arguments
	54	"""
	55	global orig, src1, src2
	56
1e075406 CM	57	extensions = file_extensions()
1e075406 CM	58
3659ef88	59	if orig_hash:
1e075406	60	orig = path + extensions['ancestor']
f0de3f92	61	tmp = MRun('git-unpack-file', orig_hash).output_one_line()
3659ef88 CM	62	os.chmod(tmp, int(orig_mode, 8))
	63	os.renames(tmp, orig)
	64	if file1_hash:
1e075406	65	src1 = path + extensions['current']
f0de3f92	66	tmp = MRun('git-unpack-file', file1_hash).output_one_line()
3659ef88 CM	67	os.chmod(tmp, int(file1_mode, 8))
	68	os.renames(tmp, src1)
	69	if file2_hash:
1e075406	70	src2 = path + extensions['patched']
f0de3f92	71	tmp = MRun('git-unpack-file', file2_hash).output_one_line()
3659ef88 CM	72	os.chmod(tmp, int(file2_mode, 8))
	73	os.renames(tmp, src2)
	74
8d415553 CM	75	if file1_hash and not os.path.exists(path):
	76	# the current file might be removed by GIT when it is a new
	77	# file added in both branches. Just re-generate it
f0de3f92	78	tmp = MRun('git-unpack-file', file1_hash).output_one_line()
8d415553 CM	79	os.chmod(tmp, int(file1_mode, 8))
	80	os.renames(tmp, path)
	81
3659ef88 CM	82	def __remove_files(orig_hash, file1_hash, file2_hash):
	83	"""Remove any temporary files
	84	"""
	85	if orig_hash:
	86	os.remove(orig)
	87	if file1_hash:
	88	os.remove(src1)
	89	if file2_hash:
	90	os.remove(src2)
3659ef88	91
3659ef88 CM	92	def __conflict(path):
	93	"""Write the conflict file for the 'path' variable and exit
	94	"""
170f576b	95	append_string(os.path.join(basedir.get(), 'conflicts'), path)
3659ef88 CM	96
3659ef88 CM	97
f7ed76a9 CM	98	def interactive_merge(filename):
	99	"""Run the interactive merger on the given file. Note that the
	100	index should not have any conflicts.
	101	"""
f7ed76a9 CM	102	extensions = file_extensions()
	103
	104	ancestor = filename + extensions['ancestor']
	105	current = filename + extensions['current']
	106	patched = filename + extensions['patched']
	107
b6e961f2 CM	108	if os.path.isfile(ancestor):
	109	three_way = True
	110	files_dict = {'branch1': current,
	111	'ancestor': ancestor,
	112	'branch2': patched,
	113	'output': filename}
	114	imerger = config.get('stgit.i3merge')
	115	else:
	116	three_way = False
	117	files_dict = {'branch1': current,
	118	'branch2': patched,
	119	'output': filename}
	120	imerger = config.get('stgit.i2merge')
	121
	122	if not imerger:
	123	raise GitMergeException, 'No interactive merge command configured'
	124
	125	# check whether we have all the files for the merge
	126	for fn in [filename, current, patched]:
f7ed76a9 CM	127	if not os.path.isfile(fn):
f7ed76a9 CM	128	raise GitMergeException, \
b6e961f2	129	'Cannot run the interactive merge: "%s" missing' % fn
f7ed76a9 CM	130
	131	mtime = os.path.getmtime(filename)
	132
27ac2b7e KH	133	out.info('Trying the interactive %s merge'
27ac2b7e KH	134	% (three_way and 'three-way' or 'two-way'))
f7ed76a9	135
b6e961f2	136	err = os.system(imerger % files_dict)
f7ed76a9 CM	137	if err != 0:
	138	raise GitMergeException, 'The interactive merge failed: %d' % err
	139	if not os.path.isfile(filename):
	140	raise GitMergeException, 'The "%s" file is missing' % filename
	141	if mtime == os.path.getmtime(filename):
	142	raise GitMergeException, 'The "%s" file was not modified' % filename
	143
	144
3659ef88 CM	145	#
	146	# Main algorithm
	147	#
	148	def merge(orig_hash, file1_hash, file2_hash,
	149	path,
	150	orig_mode, file1_mode, file2_mode):
	151	"""Three-way merge for one file algorithm
	152	"""
	153	__checkout_files(orig_hash, file1_hash, file2_hash,
	154	path,
	155	orig_mode, file1_mode, file2_mode)
	156
	157	# file exists in origin
	158	if orig_hash:
	159	# modified in both
	160	if file1_hash and file2_hash:
	161	# if modes are the same (git-read-tree probably dealt with it)
	162	if file1_hash == file2_hash:
	163	if os.system('git-update-index --cacheinfo %s %s %s'
	164	% (file1_mode, file1_hash, path)) != 0:
27ac2b7e	165	out.error('git-update-index failed')
3659ef88 CM	166	__conflict(path)
	167	return 1
	168	if os.system('git-checkout-index -u -f -- %s' % path):
27ac2b7e	169	out.error('git-checkout-index failed')
3659ef88 CM	170	__conflict(path)
	171	return 1
	172	if file1_mode != file2_mode:
27ac2b7e	173	out.error('File added in both, permissions conflict')
3659ef88 CM	174	__conflict(path)
	175	return 1
	176	# 3-way merge
	177	else:
5b99888b CM	178	merge_ok = os.system(str(merger) % {'branch1': src1,
	179	'ancestor': orig,
	180	'branch2': src2,
	181	'output': path }) == 0
3659ef88 CM	182
	183	if merge_ok:
	184	os.system('git-update-index -- %s' % path)
	185	__remove_files(orig_hash, file1_hash, file2_hash)
	186	return 0
	187	else:
27ac2b7e KH	188	out.error('Three-way merge tool failed for file "%s"'
27ac2b7e KH	189	% path)
3659ef88 CM	190	# reset the cache to the first branch
	191	os.system('git-update-index --cacheinfo %s %s %s'
	192	% (file1_mode, file1_hash, path))
f7ed76a9	193
c73e63b7	194	if config.get('stgit.autoimerge') == 'yes':
f7ed76a9 CM	195	try:
	196	interactive_merge(path)
	197	except GitMergeException, ex:
	198	# interactive merge failed
f0b5d4dd	199	out.error(str(ex))
f7ed76a9 CM	200	if str(keeporig) != 'yes':
	201	__remove_files(orig_hash, file1_hash,
	202	file2_hash)
	203	__conflict(path)
	204	return 1
	205	# successful interactive merge
0f4eba6a	206	os.system('git-update-index -- %s' % path)
3659ef88	207	__remove_files(orig_hash, file1_hash, file2_hash)
f7ed76a9 CM	208	return 0
	209	else:
	210	# no interactive merge, just mark it as conflict
	211	if str(keeporig) != 'yes':
	212	__remove_files(orig_hash, file1_hash, file2_hash)
	213	__conflict(path)
	214	return 1
	215
3659ef88 CM	216	# file deleted in both or deleted in one and unchanged in the other
	217	elif not (file1_hash or file2_hash) \
	218	or file1_hash == orig_hash or file2_hash == orig_hash:
	219	if os.path.exists(path):
	220	os.remove(path)
	221	__remove_files(orig_hash, file1_hash, file2_hash)
	222	return os.system('git-update-index --remove -- %s' % path)
	223	# file deleted in one and changed in the other
	224	else:
	225	# Do something here - we must at least merge the entry in
	226	# the cache, instead of leaving it in U(nmerged) state. In
	227	# fact, stg resolved does not handle that.
	228
	229	# Do the same thing cogito does - remove the file in any case.
	230	os.system('git-update-index --remove -- %s' % path)
	231
	232	#if file1_hash:
	233	## file deleted upstream and changed in the patch. The
	234	## patch is probably going to move the changes
	235	## elsewhere.
	236
	237	#os.system('git-update-index --remove -- %s' % path)
	238	#else:
	239	## file deleted in the patch and changed upstream. We
	240	## could re-delete it, but for now leave it there -
	241	## and let the user check if he still wants to remove
	242	## the file.
	243
	244	## reset the cache to the first branch
	245	#os.system('git-update-index --cacheinfo %s %s %s'
	246	# % (file1_mode, file1_hash, path))
	247	__conflict(path)
	248	return 1
	249
	250	# file does not exist in origin
	251	else:
	252	# file added in both
	253	if file1_hash and file2_hash:
	254	# files are the same
	255	if file1_hash == file2_hash:
	256	if os.system('git-update-index --add --cacheinfo %s %s %s'
	257	% (file1_mode, file1_hash, path)) != 0:
27ac2b7e	258	out.error('git-update-index failed')
3659ef88 CM	259	__conflict(path)
	260	return 1
	261	if os.system('git-checkout-index -u -f -- %s' % path):
27ac2b7e	262	out.error('git-checkout-index failed')
3659ef88 CM	263	__conflict(path)
	264	return 1
	265	if file1_mode != file2_mode:
27ac2b7e KH	266	out.error('File "s" added in both, permissions conflict'
27ac2b7e KH	267	% path)
3659ef88 CM	268	__conflict(path)
3659ef88 CM	269	return 1
b6e961f2	270	# files added in both but different
3659ef88	271	else:
27ac2b7e	272	out.error('File "%s" added in branches but different' % path)
b6e961f2 CM	273	# reset the cache to the first branch
	274	os.system('git-update-index --cacheinfo %s %s %s'
	275	% (file1_mode, file1_hash, path))
	276
	277	if config.get('stgit.autoimerge') == 'yes':
	278	try:
	279	interactive_merge(path)
	280	except GitMergeException, ex:
	281	# interactive merge failed
f0b5d4dd	282	out.error(str(ex))
b6e961f2 CM	283	if str(keeporig) != 'yes':
	284	__remove_files(orig_hash, file1_hash,
	285	file2_hash)
	286	__conflict(path)
	287	return 1
	288	# successful interactive merge
	289	os.system('git-update-index -- %s' % path)
	290	__remove_files(orig_hash, file1_hash, file2_hash)
	291	return 0
	292	else:
	293	# no interactive merge, just mark it as conflict
	294	if str(keeporig) != 'yes':
	295	__remove_files(orig_hash, file1_hash, file2_hash)
	296	__conflict(path)
	297	return 1
3659ef88 CM	298	# file added in one
	299	elif file1_hash or file2_hash:
	300	if file1_hash:
	301	mode = file1_mode
	302	obj = file1_hash
	303	else:
	304	mode = file2_mode
	305	obj = file2_hash
	306	if os.system('git-update-index --add --cacheinfo %s %s %s'
	307	% (mode, obj, path)) != 0:
27ac2b7e	308	out.error('git-update-index failed')
3659ef88 CM	309	__conflict(path)
	310	return 1
	311	__remove_files(orig_hash, file1_hash, file2_hash)
	312	return os.system('git-checkout-index -u -f -- %s' % path)
	313
	314	# Unhandled case
27ac2b7e KH	315	out.error('Unhandled merge conflict: "%s" "%s" "%s" "%s" "%s" "%s" "%s"'
	316	% (orig_hash, file1_hash, file2_hash,
	317	path,
	318	orig_mode, file1_mode, file2_mode))
3659ef88 CM	319	__conflict(path)
3659ef88 CM	320	return 1