# commands.py - command processing for mercurial

#

# Copyright 2005, 2006 Matt Mackall <mpm@selenic.com>

#

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

# of the GNU General Public License, incorporated herein by reference.

from demandload import demandload

from node import *

from i18n import gettext as _

demandload(globals(), "os re sys signal imp urllib pdb shlex")

demandload(globals(), "fancyopts ui hg util lock revlog bundlerepo")

demandload(globals(), "difflib patch tempfile time")

demandload(globals(), "traceback errno version atexit bz2")

demandload(globals(), "archival changegroup cmdutil hgweb.server sshserver")

class UnknownCommand(Exception):

    """Exception raised if command is not in the command table."""

class AmbiguousCommand(Exception):

    """Exception raised if command shortcut matches more than one command."""

def bail_if_changed(repo):

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

    if modified or added or removed or deleted:

        raise util.Abort(_("outstanding uncommitted changes"))

def relpath(repo, args):

    cwd = repo.getcwd()

    if cwd:

        return [util.normpath(os.path.join(cwd, x)) for x in args]

    return args

def logmessage(opts):

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

    message = opts['message']

    logfile = opts['logfile']

    if message and logfile:

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

                           'exclusive'))

    if not message and logfile:

        try:

            if logfile == '-':

                message = sys.stdin.read()

            else:

                message = open(logfile).read()

        except IOError, inst:

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

                             (logfile, inst.strerror))

    return message

def write_bundle(cg, filename=None, compress=True):

    """Write a bundle file and return its filename.

    Existing files will not be overwritten.

    If no filename is specified, a temporary file is created.

    bz2 compression can be turned off.

    The bundle file will be deleted in case of errors.

    """

    class nocompress(object):

        def compress(self, x):

            return x

        def flush(self):

            return ""

    fh = None

    cleanup = None

    try:

        if filename:

            if os.path.exists(filename):

                raise util.Abort(_("file '%s' already exists") % filename)

            fh = open(filename, "wb")

        else:

            fd, filename = tempfile.mkstemp(prefix="hg-bundle-", suffix=".hg")

            fh = os.fdopen(fd, "wb")

        cleanup = filename

        if compress:

            fh.write("HG10")

            z = bz2.BZ2Compressor(9)

        else:

            fh.write("HG10UN")

            z = nocompress()

        # parse the changegroup data, otherwise we will block

        # in case of sshrepo because we don't know the end of the stream

        # an empty chunkiter is the end of the changegroup

        empty = False

        while not empty:

            empty = True

            for chunk in changegroup.chunkiter(cg):

                empty = False

                fh.write(z.compress(changegroup.genchunk(chunk)))

            fh.write(z.compress(changegroup.closechunk()))

        fh.write(z.flush())

        cleanup = None

        return filename

    finally:

        if fh is not None:

            fh.close()

        if cleanup is not None:

            os.unlink(cleanup)

def setremoteconfig(ui, opts):

    "copy remote options to ui tree"

    if opts.get('ssh'):

        ui.setconfig("ui", "ssh", opts['ssh'])

    if opts.get('remotecmd'):

        ui.setconfig("ui", "remotecmd", opts['remotecmd'])

def help_(ui, name=None, with_version=False):

    """show help for a command, extension, or list of commands

    With no arguments, print a list of commands and short help.

    Given a command name, print help for that command.

    Given an extension name, print help for that extension, and the

    commands it provides."""

    option_lists = []

    def helpcmd(name):

        if with_version:

            version_(ui)

            ui.write('\n')

        aliases, i = findcmd(ui, name)

        # synopsis

        ui.write("%s\n\n" % i[2])

        # description

        doc = i[0].__doc__

        if not doc:

            doc = _("(No help text available)")

        if ui.quiet:

            doc = doc.splitlines(0)[0]

        ui.write("%s\n" % doc.rstrip())

        if not ui.quiet:

            # aliases

            if len(aliases) > 1:

                ui.write(_("\naliases: %s\n") % ', '.join(aliases[1:]))

            # options

            if i[1]:

                option_lists.append(("options", i[1]))

    def helplist(select=None):

        h = {}

        cmds = {}

        for c, e in table.items():

            f = c.split("|", 1)[0]

            if select and not select(f):

                continue

            if name == "shortlist" and not f.startswith("^"):

                continue

            f = f.lstrip("^")

            if not ui.debugflag and f.startswith("debug"):

                continue

            doc = e[0].__doc__

            if not doc:

                doc = _("(No help text available)")

            h[f] = doc.splitlines(0)[0].rstrip()

            cmds[f] = c.lstrip("^")

        fns = h.keys()

        fns.sort()

        m = max(map(len, fns))

        for f in fns:

            if ui.verbose:

                commands = cmds[f].replace("|",", ")

                ui.write(" %s:\n      %s\n"%(commands, h[f]))

            else:

                ui.write(' %-*s   %s\n' % (m, f, h[f]))

    def helpext(name):

        try:

            mod = findext(name)

        except KeyError:

            raise UnknownCommand(name)

        doc = (mod.__doc__ or _('No help text available')).splitlines(0)

        ui.write(_('%s extension - %s\n') % (name.split('.')[-1], doc[0]))

        for d in doc[1:]:

            ui.write(d, '\n')

        ui.status('\n')

        if ui.verbose:

            ui.status(_('list of commands:\n\n'))

        else:

            ui.status(_('list of commands (use "hg help -v %s" '

                        'to show aliases and global options):\n\n') % name)

        modcmds = dict.fromkeys([c.split('|', 1)[0] for c in mod.cmdtable])

        helplist(modcmds.has_key)

    if name and name != 'shortlist':

        try:

            helpcmd(name)

        except UnknownCommand:

            helpext(name)

    else:

        # program name

        if ui.verbose or with_version:

            version_(ui)

        else:

            ui.status(_("Mercurial Distributed SCM\n"))

        ui.status('\n')

        # list of commands

        if name == "shortlist":

            ui.status(_('basic commands (use "hg help" '

                        'for the full list or option "-v" for details):\n\n'))

        elif ui.verbose:

            ui.status(_('list of commands:\n\n'))

        else:

            ui.status(_('list of commands (use "hg help -v" '

                        'to show aliases and global options):\n\n'))

        helplist()

    # global options

    if ui.verbose:

        option_lists.append(("global options", globalopts))

    # list all option lists

    opt_output = []

    for title, options in option_lists:

        opt_output.append(("\n%s:\n" % title, None))

        for shortopt, longopt, default, desc in options:

            if "DEPRECATED" in desc and not ui.verbose: continue

            opt_output.append(("%2s%s" % (shortopt and "-%s" % shortopt,

                                          longopt and " --%s" % longopt),

                               "%s%s" % (desc,

                                         default

                                         and _(" (default: %s)") % default

                                         or "")))

    if opt_output:

        opts_len = max([len(line[0]) for line in opt_output if line[1]])

        for first, second in opt_output:

            if second:

                ui.write(" %-*s  %s\n" % (opts_len, first, second))

            else:

                ui.write("%s\n" % first)

# Commands start here, listed alphabetically

def add(ui, repo, *pats, **opts):

    """add the specified files on the next commit

    Schedule files to be version controlled and added to the repository.

    The files will be added to the repository at the next commit.

    If no names are given, add all files in the repository.

    """

    names = []

    for src, abs, rel, exact in cmdutil.walk(repo, pats, opts):

        if exact:

            if ui.verbose:

                ui.status(_('adding %s\n') % rel)

            names.append(abs)

        elif repo.dirstate.state(abs) == '?':

            ui.status(_('adding %s\n') % rel)

            names.append(abs)

    if not opts.get('dry_run'):

        repo.add(names)

def addremove(ui, repo, *pats, **opts):

    """add all new files, delete all missing files

    Add all new files and remove all missing files from the repository.

    New files are ignored if they match any of the patterns in .hgignore. As

    with add, these changes take effect at the next commit.

    Use the -s option to detect renamed files.  With a parameter > 0,

    this compares every removed file with every added file and records

    those similar enough as renames.  This option takes a percentage

    between 0 (disabled) and 100 (files must be identical) as its

    parameter.  Detecting renamed files this way can be expensive.

    """

    sim = float(opts.get('similarity') or 0)

    if sim < 0 or sim > 100:

        raise util.Abort(_('similarity must be between 0 and 100'))

    return cmdutil.addremove(repo, pats, opts, similarity=sim/100.)

def annotate(ui, repo, *pats, **opts):

    """show changeset information per file line

    List changes in files, showing the revision id responsible for each line

    This command is useful to discover who did a change or when a change took

    place.

    Without the -a option, annotate will avoid processing files it

    detects as binary. With -a, annotate will generate an annotation

    anyway, probably with undesirable results.

    """

    getdate = util.cachefunc(lambda x: util.datestr(x.date()))

    if not pats:

        raise util.Abort(_('at least one file name or pattern required'))

    opmap = [['user', lambda x: ui.shortuser(x.user())],

             ['number', lambda x: str(x.rev())],

             ['changeset', lambda x: short(x.node())],

             ['date', getdate], ['follow', lambda x: x.path()]]

    if (not opts['user'] and not opts['changeset'] and not opts['date']

        and not opts['follow']):

        opts['number'] = 1

    ctx = repo.changectx(opts['rev'])

    for src, abs, rel, exact in cmdutil.walk(repo, pats, opts,

                                             node=ctx.node()):

        fctx = ctx.filectx(abs)

        if not opts['text'] and util.binary(fctx.data()):

            ui.write(_("%s: binary file\n") % ((pats and rel) or abs))

            continue

        lines = fctx.annotate(follow=opts.get('follow'))

        pieces = []

        for o, f in opmap:

            if opts[o]:

                l = [f(n) for n, dummy in lines]

                if l:

                    m = max(map(len, l))

                    pieces.append(["%*s" % (m, x) for x in l])

        if pieces:

            for p, l in zip(zip(*pieces), lines):

                ui.write("%s: %s" % (" ".join(p), l[1]))

def archive(ui, repo, dest, **opts):

    '''create unversioned archive of a repository revision

    By default, the revision used is the parent of the working

    directory; use "-r" to specify a different revision.

    To specify the type of archive to create, use "-t".  Valid

    types are:

    "files" (default): a directory full of files

    "tar": tar archive, uncompressed

    "tbz2": tar archive, compressed using bzip2

    "tgz": tar archive, compressed using gzip

    "uzip": zip archive, uncompressed

    "zip": zip archive, compressed using deflate

    The exact name of the destination archive or directory is given

    using a format string; see "hg help export" for details.

    Each member added to an archive file has a directory prefix

    prepended.  Use "-p" to specify a format string for the prefix.

    The default is the basename of the archive, with suffixes removed.

    '''

    node = repo.changectx(opts['rev']).node()

    dest = cmdutil.make_filename(repo, dest, node)

    if os.path.realpath(dest) == repo.root:

        raise util.Abort(_('repository root cannot be destination'))

    dummy, matchfn, dummy = cmdutil.matchpats(repo, [], opts)

    kind = opts.get('type') or 'files'

    prefix = opts['prefix']

    if dest == '-':

        if kind == 'files':

            raise util.Abort(_('cannot archive plain files to stdout'))

        dest = sys.stdout

        if not prefix: prefix = os.path.basename(repo.root) + '-%h'

    prefix = cmdutil.make_filename(repo, prefix, node)

    archival.archive(repo, dest, node, kind, not opts['no_decode'],

                     matchfn, prefix)

def backout(ui, repo, rev, **opts):

    '''reverse effect of earlier changeset

    Commit the backed out changes as a new changeset.  The new

    changeset is a child of the backed out changeset.

    If you back out a changeset other than the tip, a new head is

    created.  This head is the parent of the working directory.  If

    you back out an old changeset, your working directory will appear

    old after the backout.  You should merge the backout changeset

    with another head.

    The --merge option remembers the parent of the working directory

    before starting the backout, then merges the new head with that

    changeset afterwards.  This saves you from doing the merge by

    hand.  The result of this merge is not committed, as for a normal

    merge.'''

    bail_if_changed(repo)

    op1, op2 = repo.dirstate.parents()

    if op2 != nullid:

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

    node = repo.lookup(rev)

    p1, p2 = repo.changelog.parents(node)

    if p1 == nullid:

        raise util.Abort(_('cannot back out a change with no parents'))

    if p2 != nullid:

        if not opts['parent']:

            raise util.Abort(_('cannot back out a merge changeset without '

                               '--parent'))

        p = repo.lookup(opts['parent'])

        if p not in (p1, p2):

            raise util.Abort(_('%s is not a parent of %s' %

                               (short(p), short(node))))

        parent = p

    else:

        if opts['parent']:

            raise util.Abort(_('cannot use --parent on non-merge changeset'))

        parent = p1

    hg.clean(repo, node, show_stats=False)

    revert_opts = opts.copy()

    revert_opts['all'] = True

    revert_opts['rev'] = hex(parent)

    revert(ui, repo, **revert_opts)

    commit_opts = opts.copy()

    commit_opts['addremove'] = False

    if not commit_opts['message'] and not commit_opts['logfile']:

        commit_opts['message'] = _("Backed out changeset %s") % (hex(node))

        commit_opts['force_editor'] = True

    commit(ui, repo, **commit_opts)

    def nice(node):

        return '%d:%s' % (repo.changelog.rev(node), short(node))

    ui.status(_('changeset %s backs out changeset %s\n') %

              (nice(repo.changelog.tip()), nice(node)))

    if op1 != node:

        if opts['merge']:

            ui.status(_('merging with changeset %s\n') % nice(op1))

            n = _lookup(repo, hex(op1))

            hg.merge(repo, n)

        else:

            ui.status(_('the backout changeset is a new head - '

                        'do not forget to merge\n'))

            ui.status(_('(use "backout --merge" '

                        'if you want to auto-merge)\n'))

def branch(ui, repo, label=None):

    """set or show the current branch name

    With <name>, set the current branch name. Otherwise, show the

    current branch name.

    """

    if label is not None:

        repo.opener("branch", "w").write(label)

    else:

        b = repo.workingctx().branch()

        if b:

            ui.write("%s\n" % b)

def branches(ui, repo):

    """list repository named branches

    List the repository's named branches.

    """

    b = repo.branchtags()

    l = [(-repo.changelog.rev(n), n, t) for t,n in b.items()]

    l.sort()

    for r, n, t in l:

        hexfunc = ui.debugflag and hex or short

        if ui.quiet:

            ui.write("%s\n" % t)

        else:

            ui.write("%-30s %s:%s\n" % (t, -r, hexfunc(n)))

def bundle(ui, repo, fname, dest=None, **opts):

    """create a changegroup file

    Generate a compressed changegroup file collecting changesets not

    found in the other repository.

    If no destination repository is specified the destination is assumed

    to have all the nodes specified by one or more --base parameters.

    The bundle file can then be transferred using conventional means and

    applied to another repository with the unbundle or pull command.

    This is useful when direct push and pull are not available or when

    exporting an entire repository is undesirable.