# 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 shutil imp urllib pdb shlex")

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

demandload(globals(), "fnmatch difflib patch random signal tempfile time")

demandload(globals(), "traceback errno socket version struct atexit sets bz2")

demandload(globals(), "archival cStringIO changegroup")

demandload(globals(), "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 walkchangerevs(ui, repo, pats, opts):

    '''Iterate over files and the revs they changed in.

    Callers most commonly need to iterate backwards over the history

    it is interested in.  Doing so has awful (quadratic-looking)

    performance, so we use iterators in a "windowed" way.

    We walk a window of revisions in the desired order.  Within the

    window, we first walk forwards to gather data, then in the desired

    order (usually backwards) to display it.

    This function returns an (iterator, getchange, matchfn) tuple.  The

    getchange function returns the changelog entry for a numeric

    revision.  The iterator yields 3-tuples.  They will be of one of

    the following forms:

    "window", incrementing, lastrev: stepping through a window,

    positive if walking forwards through revs, last rev in the

    sequence iterated over - use to reset state for the current window

    "add", rev, fns: out-of-order traversal of the given file names

    fns, which changed during revision rev - use to gather data for

    possible display

    "iter", rev, None: in-order traversal of the revs earlier iterated

    over with "add" - use to display data'''

    def increasing_windows(start, end, windowsize=8, sizelimit=512):

        if start < end:

            while start < end:

                yield start, min(windowsize, end-start)

                start += windowsize

                if windowsize < sizelimit:

                    windowsize *= 2

        else:

            while start > end:

                yield start, min(windowsize, start-end-1)

                start -= windowsize

                if windowsize < sizelimit:

                    windowsize *= 2

    files, matchfn, anypats = cmdutil.matchpats(repo, pats, opts)

    follow = opts.get('follow') or opts.get('follow_first')

    if repo.changelog.count() == 0:

        return [], False, matchfn

    if follow:

        defrange = '%s:0' % repo.changectx().rev()

    else:

        defrange = 'tip:0'

    revs = map(int, cmdutil.revrange(ui, repo, opts['rev'] or [defrange]))

    wanted = {}

    slowpath = anypats

    fncache = {}

    chcache = {}

    def getchange(rev):

        ch = chcache.get(rev)

        if ch is None:

            chcache[rev] = ch = repo.changelog.read(repo.lookup(str(rev)))

        return ch

    if not slowpath and not files:

        # No files, no patterns.  Display all revs.

        wanted = dict(zip(revs, revs))

    copies = []

    if not slowpath:

        # Only files, no patterns.  Check the history of each file.

        def filerevgen(filelog, node):

            cl_count = repo.changelog.count()

            if node is None:

                last = filelog.count() - 1

            else:

                last = filelog.rev(node)

            for i, window in increasing_windows(last, -1):

                revs = []

                for j in xrange(i - window, i + 1):

                    n = filelog.node(j)

                    revs.append((filelog.linkrev(n),

                                 follow and filelog.renamed(n)))

                revs.reverse()

                for rev in revs:

                    # only yield rev for which we have the changelog, it can

                    # happen while doing "hg log" during a pull or commit

                    if rev[0] < cl_count:

                        yield rev

        def iterfiles():

            for filename in files:

                yield filename, None

            for filename_node in copies:

                yield filename_node

        minrev, maxrev = min(revs), max(revs)

        for file_, node in iterfiles():

            filelog = repo.file(file_)

            # A zero count may be a directory or deleted file, so

            # try to find matching entries on the slow path.

            if filelog.count() == 0:

                slowpath = True

                break

            for rev, copied in filerevgen(filelog, node):

                if rev <= maxrev:

                    if rev < minrev:

                        break

                    fncache.setdefault(rev, [])

                    fncache[rev].append(file_)

                    wanted[rev] = 1

                    if follow and copied:

                        copies.append(copied)

    if slowpath:

        if follow:

            raise util.Abort(_('can only follow copies/renames for explicit '

                               'file names'))

        # The slow path checks files modified in every changeset.

        def changerevgen():

            for i, window in increasing_windows(repo.changelog.count()-1, -1):

                for j in xrange(i - window, i + 1):

                    yield j, getchange(j)[3]

        for rev, changefiles in changerevgen():

            matches = filter(matchfn, changefiles)

            if matches:

                fncache[rev] = matches

                wanted[rev] = 1

    class followfilter:

        def __init__(self, onlyfirst=False):

            self.startrev = -1

            self.roots = []

            self.onlyfirst = onlyfirst

        def match(self, rev):

            def realparents(rev):

                if self.onlyfirst:

                    return repo.changelog.parentrevs(rev)[0:1]

                else:

                    return filter(lambda x: x != -1, repo.changelog.parentrevs(rev))

            if self.startrev == -1:

                self.startrev = rev

                return True

            if rev > self.startrev:

                # forward: all descendants

                if not self.roots:

                    self.roots.append(self.startrev)

                for parent in realparents(rev):

                    if parent in self.roots:

                        self.roots.append(rev)

                        return True

            else:

                # backwards: all parents

                if not self.roots:

                    self.roots.extend(realparents(self.startrev))

                if rev in self.roots:

                    self.roots.remove(rev)

                    self.roots.extend(realparents(rev))

                    return True

            return False

    # it might be worthwhile to do this in the iterator if the rev range

    # is descending and the prune args are all within that range

    for rev in opts.get('prune', ()):

        rev = repo.changelog.rev(repo.lookup(rev))

        ff = followfilter()

        stop = min(revs[0], revs[-1])

        for x in range(rev, stop-1, -1):

            if ff.match(x) and wanted.has_key(x):

                del wanted[x]

    def iterate():

        if follow and not files:

            ff = followfilter(onlyfirst=opts.get('follow_first'))

            def want(rev):

                if ff.match(rev) and rev in wanted:

                    return True

                return False

        else:

            def want(rev):

                return rev in wanted

        for i, window in increasing_windows(0, len(revs)):

            yield 'window', revs[0] < revs[-1], revs[-1]

            nrevs = [rev for rev in revs[i:i+window] if want(rev)]

            srevs = list(nrevs)

            srevs.sort()

            for rev in srevs:

                fns = fncache.get(rev) or filter(matchfn, getchange(rev)[3])

                yield 'add', rev, fns

            for rev in nrevs:

                yield 'iter', rev, None

    return iterate(), getchange, matchfn

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 trimuser(ui, name, rev, revcache):

    """trim the name of the user who committed a change"""

    user = revcache.get(rev)

    if user is None:

        user = revcache[rev] = ui.shortuser(name)

    return user

class changeset_printer(object):

    '''show changeset information when templating not requested.'''

    def __init__(self, ui, repo):

        self.ui = ui

        self.repo = repo

    def show(self, rev=0, changenode=None, brinfo=None):

        '''show a single changeset or file revision'''

        log = self.repo.changelog

        if changenode is None:

            changenode = log.node(rev)

        elif not rev:

            rev = log.rev(changenode)

        if self.ui.quiet:

            self.ui.write("%d:%s\n" % (rev, short(changenode)))

            return

        changes = log.read(changenode)

        date = util.datestr(changes[2])

        hexfunc = self.ui.debugflag and hex or short

        parents = [(log.rev(p), hexfunc(p)) for p in log.parents(changenode)

                   if self.ui.debugflag or p != nullid]

        if (not self.ui.debugflag and len(parents) == 1 and

            parents[0][0] == rev-1):

            parents = []

        self.ui.write(_("changeset:   %d:%s\n") % (rev, hexfunc(changenode)))

        for tag in self.repo.nodetags(changenode):

            self.ui.status(_("tag:         %s\n") % tag)

        for parent in parents:

            self.ui.write(_("parent:      %d:%s\n") % parent)

        if brinfo and changenode in brinfo:

            br = brinfo[changenode]

            self.ui.write(_("branch:      %s\n") % " ".join(br))

        self.ui.debug(_("manifest:    %d:%s\n") %

                      (self.repo.manifest.rev(changes[0]), hex(changes[0])))

        self.ui.status(_("user:        %s\n") % changes[1])

        self.ui.status(_("date:        %s\n") % date)

        if self.ui.debugflag:

            files = self.repo.status(log.parents(changenode)[0], changenode)[:3]

            for key, value in zip([_("files:"), _("files+:"), _("files-:")],

                                  files):

                if value:

                    self.ui.note("%-12s %s\n" % (key, " ".join(value)))

        else:

            self.ui.note(_("files:       %s\n") % " ".join(changes[3]))

        description = changes[4].strip()

        if description:

            if self.ui.verbose:

                self.ui.status(_("description:\n"))

                self.ui.status(description)

                self.ui.status("\n\n")

            else:

                self.ui.status(_("summary:     %s\n") %

                               description.splitlines()[0])

        self.ui.status("\n")

def show_changeset(ui, repo, opts):

    '''show one changeset.  uses template or regular display.  caller

    can pass in 'style' and 'template' options in opts.'''

    tmpl = opts.get('template')

    if tmpl:

        tmpl = templater.parsestring(tmpl, quoted=False)

    else:

        tmpl = ui.config('ui', 'logtemplate')

        if tmpl: tmpl = templater.parsestring(tmpl)

    mapfile = opts.get('style') or ui.config('ui', 'style')

    if tmpl or mapfile:

        if mapfile:

            if not os.path.isfile(mapfile):

                mapname = templater.templatepath('map-cmdline.' + mapfile)

                if not mapname: mapname = templater.templatepath(mapfile)

                if mapname: mapfile = mapname

        try:

            t = templater.changeset_templater(ui, repo, mapfile)

        except SyntaxError, inst:

            raise util.Abort(inst.args[0])

        if tmpl: t.use_template(tmpl)

        return t

    return changeset_printer(ui, repo)

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 show_version(ui):

    """output version and copyright information"""

    ui.write(_("Mercurial Distributed SCM (version %s)\n")

             % version.get_version())

    ui.status(_(

        "\nCopyright (C) 2005, 2006 Matt Mackall <mpm@selenic.com>\n"

        "This is free software; see the source for copying conditions. "

        "There is NO\nwarranty; "

        "not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"

    ))

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:

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