# histedit.py - interactive history editing for mercurial

#

# Copyright 2009 Augie Fackler <raf@durin42.com>

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

"""Interactive history editing.

Inspired by git rebase --interactive.

"""

try:

    import cPickle as pickle

except ImportError:

    import pickle

import tempfile

import os

from mercurial import bookmarks

from mercurial import cmdutil

from mercurial import discovery

from mercurial import error

from mercurial import hg

from mercurial import node

from mercurial import patch

from mercurial import repair

from mercurial import scmutil

from mercurial import util

from mercurial.i18n import _

editcomment = """

# Edit history between %s and %s

#

# Commands:

#  p, pick = use commit

#  e, edit = use commit, but stop for amending

#  f, fold = use commit, but fold into previous commit (combines N and N-1)

#  d, drop = remove commit from history

#  m, mess = edit message without changing commit content

#

"""

def between(repo, old, new, keep):

    current = old

    while current != new:

        ctx = repo[current]

        if not keep and len(ctx.children()) > 1:

            raise util.Abort(_('cannot edit history that would orphan nodes'))

        if len(ctx.parents()) != 1 and ctx.parents()[1] != node.nullid:

            raise util.Abort(_("can't edit history with merges"))

        if not ctx.children():

            current = new

        else:

            current = ctx.children()[0].node()

            revs.append(current)

    if len(repo[current].children()) and not keep:

        raise util.Abort(_('cannot edit history that would orphan nodes'))

    return revs

def pick(ui, repo, ctx, ha, opts):

    oldctx = repo[ha]

    if oldctx.parents()[0] == ctx:

        ui.debug('node %s unchanged\n' % ha)

        return oldctx, [], [], []

    hg.update(repo, ctx.node())

    fd, patchfile = tempfile.mkstemp(prefix='hg-histedit-')

    fp = os.fdopen(fd, 'w')

    diffopts = patch.diffopts(ui, opts)

    diffopts.git = True

    diffopts.ignorews = False

    diffopts.ignorewsamount = False

    diffopts.ignoreblanklines = False

    gen = patch.diff(repo, oldctx.parents()[0].node(), ha, opts=diffopts)

    for chunk in gen:

        fp.write(chunk)

    fp.close()

    try:

        files = set()

        try:

            patch.patch(ui, repo, patchfile, files=files, eolmode=None)

            if not files:

                ui.warn(_('%s: empty changeset')

                             % node.hex(ha))

                return ctx, [], [], []

        finally:

            os.unlink(patchfile)

        raise util.Abort(_('Fix up the change and run '

                           'hg histedit --continue'))

def edit(ui, repo, ctx, ha, opts):

    oldctx = repo[ha]

    hg.update(repo, ctx.node())

    fd, patchfile = tempfile.mkstemp(prefix='hg-histedit-')

    fp = os.fdopen(fd, 'w')

    diffopts = patch.diffopts(ui, opts)

    diffopts.git = True

    diffopts.ignorews = False

    diffopts.ignorewsamount = False

    diffopts.ignoreblanklines = False

    gen = patch.diff(repo, oldctx.parents()[0].node(), ha, opts=diffopts)

    for chunk in gen:

        fp.write(chunk)

    fp.close()

    try:

        files = set()

        try:

            patch.patch(ui, repo, patchfile, files=files, eolmode=None)

        finally:

            os.unlink(patchfile)

        pass

    raise util.Abort(_('Make changes as needed, you may commit or record as '

                       'needed now.\nWhen you are finished, run hg'

                       ' histedit --continue to resume.'))

def fold(ui, repo, ctx, ha, opts):

    oldctx = repo[ha]

    hg.update(repo, ctx.node())

    fd, patchfile = tempfile.mkstemp(prefix='hg-histedit-')

    fp = os.fdopen(fd, 'w')

    diffopts = patch.diffopts(ui, opts)

    diffopts.git = True

    diffopts.ignorews = False

    diffopts.ignorewsamount = False

    diffopts.ignoreblanklines = False

    gen = patch.diff(repo, oldctx.parents()[0].node(), ha, opts=diffopts)

    for chunk in gen:

        fp.write(chunk)

    fp.close()

    try:

        files = set()

        try:

            patch.patch(ui, repo, patchfile, files=files, eolmode=None)

            if not files:

                ui.warn(_('%s: empty changeset')

                             % node.hex(ha))

                return ctx, [], [], []

        finally:

            os.unlink(patchfile)

        raise util.Abort(_('Fix up the change and run '

                           'hg histedit --continue'))

    return finishfold(ui, repo, ctx, oldctx, n, opts, [])

def finishfold(ui, repo, ctx, oldctx, newnode, opts, internalchanges):

    parent = ctx.parents()[0].node()

    hg.update(repo, parent)

    fd, patchfile = tempfile.mkstemp(prefix='hg-histedit-')

    fp = os.fdopen(fd, 'w')

    diffopts = patch.diffopts(ui, opts)

    diffopts.git = True

    diffopts.ignorews = False

    diffopts.ignorewsamount = False

    diffopts.ignoreblanklines = False

    gen = patch.diff(repo, parent, newnode, opts=diffopts)

    for chunk in gen:

        fp.write(chunk)

    fp.close()

    files = set()

    try:

        patch.patch(ui, repo, patchfile, files=files, eolmode=None)

    finally:

        os.unlink(patchfile)

    newmessage = '\n***\n'.join(

        [repo[r].description() for r in internalchanges] +

    # If the changesets are from the same author, keep it.

    if ctx.user() == oldctx.user():

        username = ctx.user()

    else:

        username = ui.username()

    newmessage = ui.edit(newmessage, username)

def drop(ui, repo, ctx, ha, opts):

def message(ui, repo, ctx, ha, opts):

    oldctx = repo[ha]

    hg.update(repo, ctx.node())

    fd, patchfile = tempfile.mkstemp(prefix='hg-histedit-')

    fp = os.fdopen(fd, 'w')

    diffopts = patch.diffopts(ui, opts)

    diffopts.git = True

    diffopts.ignorews = False

    diffopts.ignorewsamount = False

    diffopts.ignoreblanklines = False

    gen = patch.diff(repo, oldctx.parents()[0].node(), ha, opts=diffopts)

    for chunk in gen:

        fp.write(chunk)

    fp.close()

    try:

        files = set()

        try:

            patch.patch(ui, repo, patchfile, files=files, eolmode=None)

        finally:

            os.unlink(patchfile)

        raise util.Abort(_('Fix up the change and run '

                           'hg histedit --continue'))

    message = oldctx.description()

    message = ui.edit(message, ui.username())

    new = repo.commit(text=message, user=oldctx.user(), date=oldctx.date(),

                      extra=oldctx.extra())

    newctx = repo[new]

    if oldctx.node() != newctx.node():

        return newctx, [new], [oldctx.node()], []

    # We didn't make an edit, so just indicate no replaced nodes

    return newctx, [new], [], []

def makedesc(c):

    summary = ''

    if c.description():

        summary = c.description().splitlines()[0]

    line = 'pick %s %d %s' % (c.hex()[:12], c.rev(), summary)

    return line[:80]  # trim to 80 chars so it's not stupidly wide in my editor

actiontable = {'p': pick,

               'pick': pick,

               'e': edit,

               'edit': edit,

               'f': fold,

               'fold': fold,

               'd': drop,

               'drop': drop,

               'm': message,

               'mess': message,

               }

def histedit(ui, repo, *parent, **opts):

    """hg histedit <parent>

    """

    # TODO only abort if we try and histedit mq patches, not just

    # blanket if mq patches are applied somewhere

    mq = getattr(repo, 'mq', None)

    if mq and mq.applied:

        raise util.Abort(_('source has mq patches applied'))

    parent = list(parent) + opts.get('rev', [])

    if opts.get('outgoing'):

        if len(parent) > 1:

        elif parent:

            parent = parent[0]

        dest = ui.expandpath(parent or 'default-push', parent or 'default')

        dest, revs = hg.parseurl(dest, None)[:2]

        ui.status(_('comparing with %s\n') % util.hidepassword(dest))

        revs, checkout = hg.addbranchrevs(repo, repo, revs, None)

        other = hg.repository(hg.remoteui(repo, opts), dest)

        if revs:

            revs = [repo.lookup(rev) for rev in revs]

        parent = discovery.findcommonoutgoing(

            repo, other, [], force=opts.get('force')).missing[0:1]

    else:

        if opts.get('force'):

            raise util.Abort(_('--force only allowed with --outgoing'))

    if opts.get('continue', False):

        if len(parent) != 0:

            raise util.Abort(_('no arguments allowed with --continue'))

        (parentctxnode, created, replaced,

        currentparent, wantnull = repo.dirstate.parents()

        parentctx = repo[parentctxnode]

        # discover any nodes the user has added in the interim

        newchildren = [c for c in parentctx.children()

                       if c.node() not in existing]

        action, currentnode = rules.pop(0)

        while newchildren:

                tmpnodes.extend([n.node() for n in newchildren])

            else:

                created.extend([n.node() for n in newchildren])

            newchildren = filter(lambda x: x.node() not in existing,

                                 reduce(lambda x, y: x + y,

                                        map(lambda r: r.children(),

                                            newchildren)))

        m, a, r, d = repo.status()[:4]

        oldctx = repo[currentnode]

        message = oldctx.description()

        if action in ('e', 'edit', 'm', 'mess'):

            message = ui.edit(message, ui.username())

            message = 'fold-temp-revision %s' % currentnode

        new = None

        if m or a or r or d:

        if action in ('f', 'fold'):

            if new:

                tmpnodes.append(new)

            else:

                new = newchildren[-1]

            replaced.extend(replaced_)

            created.extend(created_)

            tmpnodes.extend(tmpnodes_)

        elif action not in ('d', 'drop'):

            if new != oldctx.node():

                replaced.append(oldctx.node())

            if new:

                if new != oldctx.node():

                    created.append(new)

                parentctx = repo[new]

    elif opts.get('abort', False):

        if len(parent) != 0:

            raise util.Abort(_('no arguments allowed with --abort'))

        (parentctxnode, created, replaced, tmpnodes,

         existing, rules, keep, tip, replacemap) = readstate(repo)

        ui.debug('restore wc to old tip %s\n' % node.hex(tip))

        hg.clean(repo, tip)

        ui.debug('should strip created nodes %s\n' %

                 ', '.join([node.hex(n)[:12] for n in created]))

        ui.debug('should strip temp nodes %s\n' %

                 ', '.join([node.hex(n)[:12] for n in tmpnodes]))

            for n in reversed(nodes):

                try:

                    repair.strip(ui, repo, n)

                except error.LookupError:

                    pass

        os.unlink(os.path.join(repo.path, 'histedit-state'))

        return

    else:

        cmdutil.bailifchanged(repo)

        if os.path.exists(os.path.join(repo.path, 'histedit-state')):

            raise util.Abort(_('history edit already in progress, try '

                               '--continue or --abort'))

        tip, empty = repo.dirstate.parents()

        if len(parent) != 1:

            raise util.Abort(_('histedit requires exactly one parent revision'))

        parent = scmutil.revsingle(repo, parent[0]).node()

        keep = opts.get('keep', False)

        revs = between(repo, parent, tip, keep)

        ctxs = [repo[r] for r in revs]