# commands.py - command processing for 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, incorporated herein by reference.

from node import *

from i18n import _

import os, re, sys, urllib

import hg, util, revlog, bundlerepo, extensions

import difflib, patch, time, help, mdiff, tempfile

import errno, version, socket

import archival, changegroup, cmdutil, hgweb.server, sshserver, hbisect

# 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. To

    undo an add before that, see hg revert.

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

    """

    rejected = None

    exacts = {}

    names = []

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

                                             badmatch=util.always):

        if exact:

            if ui.verbose:

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

            names.append(abs)

            exacts[abs] = 1

        elif abs not in repo.dirstate:

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

            names.append(abs)

    if not opts.get('dry_run'):

        rejected = repo.add(names)

        rejected = [p for p in rejected if p in exacts]

    return rejected and 1 or 0

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.

    """

    try:

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

    except ValueError:

        raise util.Abort(_('similarity must be a number'))

    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.

    """

    datefunc = ui.quiet and util.shortdate or util.datestr

    getdate = util.cachefunc(lambda x: datefunc(x[0].date()))

    if not pats:

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

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

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

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

             ('date', getdate),

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

            ]

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

        and not opts['follow']):

        opts['number'] = 1

    linenumber = opts.get('line_number') is not None

    if (linenumber and (not opts['changeset']) and (not opts['number'])):

        raise util.Abort(_('at least one of -n/-c is required for -l'))

    funcmap = [func for op, func in opmap if opts.get(op)]

    if linenumber:

        lastfunc = funcmap[-1]

        funcmap[-1] = lambda x: "%s:%s" % (lastfunc(x), x[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'),

                              linenumber=linenumber)

        pieces = []

        for f in funcmap:

            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.

    '''

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

    if not ctx:

        raise util.Abort(_('repository has no revisions'))

    node = ctx.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, node=None, rev=None, **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 will be the new tip and you should merge this

    backout changeset with another head (current one by default).

    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.

    See 'hg help dates' for a list of formats valid for -d/--date.

    '''

    if rev and node:

        raise util.Abort(_("please specify just one revision"))

    if not rev:

        rev = node

    if not rev:

        raise util.Abort(_("please specify a revision to backout"))

    date = opts.get('date')

    if date:

        opts['date'] = util.parsedate(date)

    cmdutil.bail_if_changed(repo)

    node = repo.lookup(rev)

    op1, op2 = repo.dirstate.parents()

    a = repo.changelog.ancestor(op1, node)

    if a != node:

        raise util.Abort(_('cannot back out change on a different branch'))

    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['date'] = None

    revert_opts['all'] = True

    revert_opts['rev'] = hex(parent)

    revert_opts['no_backup'] = None

    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") % (short(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:

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

        if opts['merge']:

            ui.status(_('merging with changeset %s\n') % nice(repo.changelog.tip()))

            hg.merge(repo, hex(repo.changelog.tip()))

        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 bisect(ui, repo, rev=None, extra=None,

               reset=None, good=None, bad=None, skip=None, noupdate=None):

    """subdivision search of changesets

    This command helps to find changesets which introduce problems.

    To use, mark the earliest changeset you know exhibits the problem

    as bad, then mark the latest changeset which is free from the

    problem as good. Bisect will update your working directory to a

    revision for testing. Once you have performed tests, mark the

    working directory as bad or good and bisect will either update to

    another candidate changeset or announce that it has found the bad

    revision.

    """

    # backward compatibility

    if rev in "good bad reset init".split():

        ui.warn(_("(use of 'hg bisect <cmd>' is deprecated)\n"))

        cmd, rev, extra = rev, extra, None

        if cmd == "good":

            good = True

        elif cmd == "bad":

            bad = True

        else:

            reset = True

    elif extra or good + bad + skip + reset > 1:

        raise util.Abort("Incompatible arguments")

    if reset:

        p = repo.join("bisect.state")

        if os.path.exists(p):

            os.unlink(p)

        return

    # load state

    state = {'good': [], 'bad': [], 'skip': []}

    if os.path.exists(repo.join("bisect.state")):

        for l in repo.opener("bisect.state"):

            kind, node = l[:-1].split()

            node = repo.lookup(node)

            if kind not in state:

                raise util.Abort(_("unknown bisect kind %s") % kind)

            state[kind].append(node)

    # update state

    node = repo.lookup(rev or '.')

    if good:

        state['good'].append(node)

    elif bad:

        state['bad'].append(node)

    elif skip:

        state['skip'].append(node)

    # save state

    f = repo.opener("bisect.state", "w", atomictemp=True)

    wlock = repo.wlock()

    try:

        for kind in state:

            for node in state[kind]:

                f.write("%s %s\n" % (kind, hg.hex(node)))

        f.rename()

    finally:

        del wlock

    if not state['good'] or not state['bad']:

        return

    # actually bisect

    node, changesets, good = hbisect.bisect(repo.changelog, state)

    if changesets == 0:

        ui.write(_("The first %s revision is:\n") % (good and "good" or "bad"))

        displayer = cmdutil.show_changeset(ui, repo, {})

        displayer.show(changenode=node)

    elif node is not None:

        # compute the approximate number of remaining tests

        tests, size = 0, 2

        while size <= changesets:

            tests, size = tests + 1, size * 2

        rev = repo.changelog.rev(node)

        ui.write(_("Testing changeset %s:%s "

                   "(%s changesets remaining, ~%s tests)\n")

                 % (rev, hg.short(node), changesets, tests))

        if not noupdate:

            cmdutil.bail_if_changed(repo)

            return hg.clean(repo, node)

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

    """set or show the current branch name

    With no argument, show the current branch name. With one argument,

    set the working directory branch name (the branch does not exist in

    the repository until the next commit).

    Unless --force is specified, branch will not let you set a

    branch name that shadows an existing branch.

    Use the command 'hg update' to switch to an existing branch.

    """

    if label:

        if not opts.get('force') and label in repo.branchtags():

            if label not in [p.branch() for p in repo.workingctx().parents()]:

                raise util.Abort(_('a branch of the same name already exists'

                                   ' (use --force to override)'))

        repo.dirstate.setbranch(util.fromlocal(label))

        ui.status(_('marked working directory as branch %s\n') % label)

    else:

        ui.write("%s\n" % util.tolocal(repo.dirstate.branch()))

def branches(ui, repo, active=False):

    """list repository named branches

    List the repository's named branches, indicating which ones are

    inactive.  If active is specified, only show active branches.

    A branch is considered active if it contains unmerged heads.

    Use the command 'hg update' to switch to an existing branch.

    """

    b = repo.branchtags()

    heads = dict.fromkeys(repo.heads(), 1)

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

    l.sort()

    l.reverse()

    for ishead, r, n, t in l:

        if active and not ishead:

            # If we're only displaying active branches, abort the loop on

            # encountering the first inactive head

            break

        else:

            hexfunc = ui.debugflag and hex or short

            if ui.quiet:

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

            else:

                spaces = " " * (30 - util.locallen(t))

                # The code only gets here if inactive branches are being

                # displayed or the branch is active.

                isinactive = ((not ishead) and " (inactive)") or ''

                ui.write("%s%s %s:%s%s\n" % (t, spaces, r, hexfunc(n), isinactive))

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.

    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.

    Applying bundles preserves all changeset contents including

    permissions, copy/rename information, and revision history.

    """

    revs = opts.get('rev') or None

    if revs:

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

    if base:

        if dest:

            raise util.Abort(_("--base is incompatible with specifiying "

                               "a destination"))

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

        # create the right base

        # XXX: nodesbetween / changegroup* should be "fixed" instead

        o = []

        has = {nullid: None}

        for n in base:

            has.update(repo.changelog.reachable(n))

        if revs:

            visit = list(revs)

        else:

            visit = repo.changelog.heads()

        seen = {}

        while visit:

            n = visit.pop(0)

            parents = [p for p in repo.changelog.parents(n) if p not in has]

            if len(parents) == 0:

                o.insert(0, n)

            else:

                for p in parents:

                    if p not in seen:

                        seen[p] = 1

                        visit.append(p)

    else:

        cmdutil.setremoteconfig(ui, opts)

        dest, revs, checkout = hg.parseurl(

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

        other = hg.repository(ui, dest)

        o = repo.findoutgoing(other, force=opts['force'])

    if revs:

        cg = repo.changegroupsubset(o, revs, 'bundle')

    else:

        cg = repo.changegroup(o, 'bundle')

    changegroup.writebundle(cg, fname, "HG10BZ")

def cat(ui, repo, file1, *pats, **opts):

    """output the current or given revision of files

    Print the specified files as they were at the given revision.

    If no revision is given, the parent of the working directory is used,

    or tip if no revision is checked out.

    Output may be to a file, in which case the name of the file is

    given using a format string.  The formatting rules are the same as

    for the export command, with the following additions:

    %s   basename of file being printed

    %d   dirname of file being printed, or '.' if in repo root

    %p   root-relative path name of file being printed

    """

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

    err = 1

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

                                             ctx.node()):

        fp = cmdutil.make_file(repo, opts['output'], ctx.node(), pathname=abs)

        data = ctx.filectx(abs).data()

        if opts.get('decode'):

            data = repo.wwritedata(abs, data)

        fp.write(data)

        err = 0