# 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, nullid, nullrev, short

from i18n import _

import os, sys, errno, re, tempfile

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

import match as matchmod

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

import changelog

import bookmarks

import encoding

import lock as lockmod

def parsealiases(cmd):

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

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()

    for e in keys:

        aliases = parsealiases(e)

        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

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

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

    choice = 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)

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):

    if 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):

        if ctx.sub(s).dirty():

            raise util.Abort(_("uncommitted changes in subrepo %s") % s)

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, inst:

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

                             (logfile, inst.strerror))

    return message

def mergeeditform(ctxorbool, baseform):

    """build appropriate editform from ctxorbool and baseform

    'cxtorbool' is one of a ctx to be committed, or a bool whether

    merging is committed.

    This returns editform 'baseform' with '.merge' if merging is

    committed, or one with '.normal' suffix otherwise.

    """

    if isinstance(ctxorbool, bool):

        if ctxorbool:

            return baseform + ".merge"

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

        return baseform + ".merge"

    return baseform + ".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)

    elif editform:

        return lambda r, c, s: commiteditor(r, c, s, editform=editform)

    else:

        return commiteditor

def loglimit(opts):

    """get the log limit according to option -l/--limit"""

    limit = opts.get('limit')

    if limit:

        try:

            limit = int(limit)

        except ValueError:

            raise util.Abort(_('limit must be a positive integer'))

        if limit <= 0:

            raise util.Abort(_('limit must be positive'))

    else:

        limit = None

    return limit

def makefilename(repo, pat, node, desc=None,

                  total=None, seqno=None, revwidth=None, pathname=None):

    node_expander = {

        'H': lambda: hex(node),

        'R': lambda: str(repo.changelog.rev(node)),

        'h': lambda: short(node),

        'm': lambda: re.sub('[^\w]', '_', str(desc))

        }

    expander = {

        '%': lambda: '%',

        'b': lambda: os.path.basename(repo.root),

        }

    try:

        if node:

            expander.update(node_expander)

        if node:

            expander['r'] = (lambda:

                    str(repo.changelog.rev(node)).zfill(revwidth or 0))

        if total is not None:

            expander['N'] = lambda: str(total)

        if seqno is not None:

            expander['n'] = lambda: str(seqno)

        if total is not None and seqno is not None:

            expander['n'] = lambda: str(seqno).zfill(len(str(total)))

        if pathname is not None:

            expander['s'] = lambda: os.path.basename(pathname)

            expander['d'] = lambda: os.path.dirname(pathname) or '.'

            expander['p'] = lambda: pathname

        newname = []

        patlen = len(pat)

        i = 0

        while i < patlen:

            c = pat[i]

            if c == '%':

                i += 1

                c = pat[i]

                c = expander[c]()

            newname.append(c)

            i += 1

        return ''.join(newname)

    except KeyError, inst:

        raise util.Abort(_("invalid format spec '%%%s' in output filename") %

                         inst.args[0])

def makefileobj(repo, pat, node=None, desc=None, total=None,

                seqno=None, revwidth=None, mode='wb', modemap=None,

                pathname=None):

    writable = mode not in ('r', 'rb')

    if not pat or pat == '-':

        fp = writable and repo.ui.fout or repo.ui.fin

        if util.safehasattr(fp, 'fileno'):

            return os.fdopen(os.dup(fp.fileno()), mode)

        else:

            # if this fp can't be duped properly, return

            # a dummy object that can be closed

            class wrappedfileobj(object):

                noop = lambda x: None

                def __init__(self, f):

                    self.f = f

                def __getattr__(self, attr):

                    if attr == 'close':

                        return self.noop

                    else:

                        return getattr(self.f, attr)

            return wrappedfileobj(fp)

    if util.safehasattr(pat, 'write') and writable:

        return pat

    if util.safehasattr(pat, 'read') and 'r' in mode:

        return pat

    fn = makefilename(repo, pat, node, desc, total, seqno, revwidth, pathname)

    if modemap is not None:

        mode = modemap.get(fn, mode)

        if mode == 'wb':

            modemap[fn] = 'ab'

    return open(fn, mode)

def openrevlog(repo, cmd, file_, opts):

    """opens the changelog, manifest, a filelog or a given revlog"""

    cl = opts['changelog']

    mf = opts['manifest']

    msg = None

    if cl and mf:

        msg = _('cannot specify --changelog and --manifest at the same time')

    elif cl or mf:

        if file_:

            msg = _('cannot specify filename with --changelog or --manifest')

        elif not repo:

            msg = _('cannot specify --changelog or --manifest '

                    'without a repository')

    if msg:

        raise util.Abort(msg)

    r = None

    if repo:

        if cl:

            r = repo.unfiltered().changelog

        elif mf:

            r = repo.manifest

        elif file_:

            filelog = repo.file(file_)

            if len(filelog):

                r = filelog

    if not r:

        if not file_:

            raise error.CommandError(cmd, _('invalid arguments'))

        if not os.path.isfile(file_):

            raise util.Abort(_("revlog '%s' not found") % file_)

        r = revlog.revlog(scmutil.opener(os.getcwd(), audit=False),

                          file_[:-2] + ".i")

    return r

def copy(ui, repo, pats, opts, rename=False):

    # called with the repo lock held

    #

    # hgsep => pathname that uses "/" to separate directories

    # ossep => pathname that uses os.sep to separate directories

    cwd = repo.getcwd()

    targets = {}

    after = opts.get("after")

    dryrun = opts.get("dry_run")

    wctx = repo[None]

    def walkpat(pat):

        srcs = []

        badstates = after and '?' or '?r'

        m = scmutil.match(repo[None], [pat], opts, globbed=True)

        for abs in repo.walk(m):

            state = repo.dirstate[abs]

            rel = m.rel(abs)

            exact = m.exact(abs)

            if state in badstates:

                if exact and state == '?':

                    ui.warn(_('%s: not copying - file is not managed\n') % rel)

                if exact and state == 'r':

                    ui.warn(_('%s: not copying - file has been marked for'

                              ' remove\n') % rel)

                continue

            # abs: hgsep

            # rel: ossep

            srcs.append((abs, rel, exact))

        return srcs

    # abssrc: hgsep

    # relsrc: ossep

    # otarget: ossep

    def copyfile(abssrc, relsrc, otarget, exact):

        abstarget = pathutil.canonpath(repo.root, cwd, otarget)

        if '/' in abstarget:

            # We cannot normalize abstarget itself, this would prevent

            # case only renames, like a => A.

            abspath, absname = abstarget.rsplit('/', 1)

            abstarget = repo.dirstate.normalize(abspath) + '/' + absname

        reltarget = repo.pathto(abstarget, cwd)

        target = repo.wjoin(abstarget)

        src = repo.wjoin(abssrc)

        state = repo.dirstate[abstarget]

        scmutil.checkportable(ui, abstarget)

        # check for collisions

        prevsrc = targets.get(abstarget)

        if prevsrc is not None:

            ui.warn(_('%s: not overwriting - %s collides with %s\n') %

                    (reltarget, repo.pathto(abssrc, cwd),

                     repo.pathto(prevsrc, cwd)))

            return

        # check for overwrites

        exists = os.path.lexists(target)

        samefile = False

        if exists and abssrc != abstarget:

            if (repo.dirstate.normalize(abssrc) ==

                repo.dirstate.normalize(abstarget)):

                if not rename:

                    ui.warn(_("%s: can't copy - same file\n") % reltarget)

                    return

                exists = False

                samefile = True

        if not after and exists or after and state in 'mn':

            if not opts['force']:

                ui.warn(_('%s: not overwriting - file exists\n') %

                        reltarget)

                return

        if after:

            if not exists:

                if rename: