# cmdutil.py - help for command processing in mercurial

#

# Copyright 2005-2007 Matt Mackall <mpm@selenic.com>

#

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

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

from node import hex, bin, nullid, nullrev, short

from i18n import _

import os, sys, errno, re, tempfile, cStringIO, shutil

import util, scmutil, templater, patch, error, templatekw, revlog, copies

import match as matchmod

import repair, graphmod, revset, phases, obsolete, pathutil

import changelog

import bookmarks

import encoding

import formatter

import crecord as crecordmod

import lock as lockmod

def ishunk(x):

    hunkclasses = (crecordmod.uihunk, patch.recordhunk)

    return isinstance(x, hunkclasses)

def newandmodified(chunks, originalchunks):

    newlyaddedandmodifiedfiles = set()

    for chunk in chunks:

        if ishunk(chunk) and chunk.header.isnewfile() and chunk not in \

            originalchunks:

            newlyaddedandmodifiedfiles.add(chunk.header.filename())

    return newlyaddedandmodifiedfiles

def parsealiases(cmd):

    return cmd.lstrip("^").split("|")

def setupwrapcolorwrite(ui):

    # wrap ui.write so diff output can be labeled/colorized

    def wrapwrite(orig, *args, **kw):

        label = kw.pop('label', '')

        for chunk, l in patch.difflabel(lambda: args):

            orig(chunk, label=label + l)

    oldwrite = ui.write

    def wrap(*args, **kwargs):

        return wrapwrite(oldwrite, *args, **kwargs)

    setattr(ui, 'write', wrap)

    return oldwrite

def filterchunks(ui, originalhunks, usecurses, testfile, operation=None):

    if usecurses:

        if testfile:

            recordfn = crecordmod.testdecorator(testfile,

                                                crecordmod.testchunkselector)

        else:

            recordfn = crecordmod.chunkselector

        return crecordmod.filterpatch(ui, originalhunks, recordfn, operation)

    else:

        return patch.filterpatch(ui, originalhunks, operation)

def recordfilter(ui, originalhunks, operation=None):

    """ Prompts the user to filter the originalhunks and return a list of

    selected hunks.

    *operation* is used for ui purposes to indicate the user

    what kind of filtering they are doing: reverting, commiting, shelving, etc.

    *operation* has to be a translated string.

    """

    usecurses =  ui.configbool('experimental', 'crecord', False)

    testfile = ui.config('experimental', 'crecordtest', None)

    oldwrite = setupwrapcolorwrite(ui)

    try:

        newchunks = filterchunks(ui, originalhunks, usecurses, testfile,

                                 operation)

    finally:

        ui.write = oldwrite

    return newchunks

def dorecord(ui, repo, commitfunc, cmdsuggest, backupall,

            filterfn, *pats, **opts):

    import merge as mergemod

    if not ui.interactive():

        if cmdsuggest:

            msg = _('running non-interactively, use %s instead') % cmdsuggest

        else:

            msg = _('running non-interactively')

        raise util.Abort(msg)

    # make sure username is set before going interactive

    if not opts.get('user'):

        ui.username() # raise exception, username not provided

    def recordfunc(ui, repo, message, match, opts):

        """This is generic record driver.

        Its job is to interactively filter local changes, and

        accordingly prepare working directory into a state in which the

        job can be delegated to a non-interactive commit command such as

        'commit' or 'qrefresh'.

        After the actual job is done by non-interactive command, the

        working directory is restored to its original state.

        In the end we'll record interesting changes, and everything else

        will be left in place, so the user can continue working.

        """

        checkunfinished(repo, commit=True)

        merge = len(repo[None].parents()) > 1

        if merge:

            raise util.Abort(_('cannot partially commit a merge '

                               '(use "hg commit" instead)'))

        status = repo.status(match=match)

        diffopts = patch.difffeatureopts(ui, opts=opts, whitespace=True)

        diffopts.nodates = True

        diffopts.git = True

        originaldiff =  patch.diff(repo, changes=status, opts=diffopts)

        originalchunks = patch.parsepatch(originaldiff)

        # 1. filter patch, so we have intending-to apply subset of it

        try:

            chunks = filterfn(ui, originalchunks)

        except patch.PatchError as err:

            raise util.Abort(_('error parsing patch: %s') % err)

        # We need to keep a backup of files that have been newly added and

        # modified during the recording process because there is a previous

        # version without the edit in the workdir

        newlyaddedandmodifiedfiles = newandmodified(chunks, originalchunks)

        contenders = set()

        for h in chunks:

            try:

                contenders.update(set(h.files()))

            except AttributeError:

                pass

        changed = status.modified + status.added + status.removed

        newfiles = [f for f in changed if f in contenders]

        if not newfiles:

            ui.status(_('no changes to record\n'))

            return 0

        modified = set(status.modified)

        # 2. backup changed files, so we can restore them in the end

        if backupall:

            tobackup = changed

        else:

            tobackup = [f for f in newfiles if f in modified or f in \

                    newlyaddedandmodifiedfiles]

        backups = {}

        if tobackup:

            backupdir = repo.join('record-backups')

            try:

                os.mkdir(backupdir)

            except OSError as err:

                if err.errno != errno.EEXIST:

                    raise

        try:

            # backup continues

            for f in tobackup:

                fd, tmpname = tempfile.mkstemp(prefix=f.replace('/', '_')+'.',

                                               dir=backupdir)

                os.close(fd)

                ui.debug('backup %r as %r\n' % (f, tmpname))

                util.copyfile(repo.wjoin(f), tmpname)

                shutil.copystat(repo.wjoin(f), tmpname)

                backups[f] = tmpname

            fp = cStringIO.StringIO()

            for c in chunks:

                fname = c.filename()

                if fname in backups:

                    c.write(fp)

            dopatch = fp.tell()

            fp.seek(0)

            [os.unlink(repo.wjoin(c)) for c in newlyaddedandmodifiedfiles]

            # 3a. apply filtered patch to clean repo  (clean)

            if backups:

                # Equivalent to hg.revert

                choices = lambda key: key in backups

                mergemod.update(repo, repo.dirstate.p1(),

                        False, True, choices)

            # 3b. (apply)

            if dopatch:

                try:

                    ui.debug('applying patch\n')

                    ui.debug(fp.getvalue())

                    patch.internalpatch(ui, repo, fp, 1, eolmode=None)

                except patch.PatchError as err:

                    raise util.Abort(str(err))

            del fp

            # 4. We prepared working directory according to filtered

            #    patch. Now is the time to delegate the job to

            #    commit/qrefresh or the like!

            # Make all of the pathnames absolute.

            newfiles = [repo.wjoin(nf) for nf in newfiles]

            return commitfunc(ui, repo, *newfiles, **opts)

        finally:

            # 5. finally restore backed-up files

            try:

                dirstate = repo.dirstate

                for realname, tmpname in backups.iteritems():

                    ui.debug('restoring %r to %r\n' % (tmpname, realname))

                    if dirstate[realname] == 'n':

                        # without normallookup, restoring timestamp

                        # may cause partially committed files

                        # to be treated as unmodified

                        dirstate.normallookup(realname)

                    util.copyfile(tmpname, repo.wjoin(realname))

                    # Our calls to copystat() here and above are a

                    # hack to trick any editors that have f open that

                    # we haven't modified them.

                    #

                    # Also note that this racy as an editor could

                    # notice the file's mtime before we've finished

                    # writing it.

                    shutil.copystat(tmpname, repo.wjoin(realname))

                    os.unlink(tmpname)

                if tobackup:

                    os.rmdir(backupdir)

            except OSError:

                pass

    def recordinwlock(ui, repo, message, match, opts):

        wlock = repo.wlock()

        try:

            return recordfunc(ui, repo, message, match, opts)

        finally:

            wlock.release()

    return commit(ui, repo, recordinwlock, pats, opts)

def findpossible(cmd, table, strict=False):

    """

    Return cmd -> (aliases, command table entry)

    for each matching command.

    Return debug commands (or their aliases) only if no normal command matches.

    """

    choice = {}

    debugchoice = {}

    if cmd in table:

        # short-circuit exact matches, "log" alias beats "^log|history"

        keys = [cmd]

    else:

        keys = table.keys()

    allcmds = []

    for e in keys:

        aliases = parsealiases(e)

        allcmds.extend(aliases)

        found = None

        if cmd in aliases:

            found = cmd

        elif not strict:

            for a in aliases:

                if a.startswith(cmd):

                    found = a

                    break

        if found is not None:

            if aliases[0].startswith("debug") or found.startswith("debug"):

                debugchoice[found] = (aliases, table[e])

            else:

                choice[found] = (aliases, table[e])

    if not choice and debugchoice:

        choice = debugchoice

    return choice, allcmds

def findcmd(cmd, table, strict=True):

    """Return (aliases, command table entry) for command string."""

    choice, allcmds = findpossible(cmd, table, strict)

    if cmd in choice:

        return choice[cmd]

    if len(choice) > 1:

        clist = choice.keys()

        clist.sort()

        raise error.AmbiguousCommand(cmd, clist)

    if choice:

        return choice.values()[0]

    raise error.UnknownCommand(cmd, allcmds)

def findrepo(p):

    while not os.path.isdir(os.path.join(p, ".hg")):

        oldp, p = p, os.path.dirname(p)

        if p == oldp:

            return None

    return p

def bailifchanged(repo, merge=True):

    if merge and repo.dirstate.p2() != nullid:

        raise util.Abort(_('outstanding uncommitted merge'))

    modified, added, removed, deleted = repo.status()[:4]

    if modified or added or removed or deleted:

        raise util.Abort(_('uncommitted changes'))

    ctx = repo[None]

    for s in sorted(ctx.substate):

        ctx.sub(s).bailifchanged()

def logmessage(ui, opts):

    """ get the log message according to -m and -l option """

    message = opts.get('message')

    logfile = opts.get('logfile')

    if message and logfile:

        raise util.Abort(_('options --message and --logfile are mutually '

                           'exclusive'))

    if not message and logfile:

        try:

            if logfile == '-':

                message = ui.fin.read()

            else:

                message = '\n'.join(util.readfile(logfile).splitlines())

        except IOError as inst:

            raise util.Abort(_("can't read commit message '%s': %s") %

                             (logfile, inst.strerror))

    return message

def mergeeditform(ctxorbool, baseformname):

    """return appropriate editform name (referencing a committemplate)

    'ctxorbool' is either a ctx to be committed, or a bool indicating whether

    merging is committed.

    This returns baseformname with '.merge' appended if it is a merge,

    otherwise '.normal' is appended.

    """

    if isinstance(ctxorbool, bool):

        if ctxorbool:

            return baseformname + ".merge"

    elif 1 < len(ctxorbool.parents()):

        return baseformname + ".merge"

    return baseformname + ".normal"

def getcommiteditor(edit=False, finishdesc=None, extramsg=None,

                    editform='', **opts):

    """get appropriate commit message editor according to '--edit' option

    'finishdesc' is a function to be called with edited commit message

    (= 'description' of the new changeset) just after editing, but

    before checking empty-ness. It should return actual text to be

    stored into history. This allows to change description before

    storing.

    'extramsg' is a extra message to be shown in the editor instead of

    'Leave message empty to abort commit' line. 'HG: ' prefix and EOL

    is automatically added.

    'editform' is a dot-separated list of names, to distinguish

    the purpose of commit text editing.

    'getcommiteditor' returns 'commitforceeditor' regardless of

    'edit', if one of 'finishdesc' or 'extramsg' is specified, because

    they are specific for usage in MQ.

    """

    if edit or finishdesc or extramsg:

        return lambda r, c, s: commitforceeditor(r, c, s,

                                                 finishdesc=finishdesc,

                                                 extramsg=extramsg,

                                                 editform=editform)