# 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 version 2 or any later version.

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

from lock import release

from i18n import _, gettext

import os, re, difflib, time, tempfile, errno

import hg, scmutil, util, revlog, extensions, copies, error, bookmarks

import patch, help, url, encoding, templatekw, discovery

import archival, changegroup, cmdutil, hbisect

import sshserver, hgweb, hgweb.server, commandserver

import match as matchmod

import merge as mergemod

import minirst, revset, fileset

import dagparser, context, simplemerge

import random, setdiscovery, treediscovery, dagutil

table = {}

command = cmdutil.command(table)

# common command options

globalopts = [

    ('R', 'repository', '',

     _('repository root directory or name of overlay bundle file'),

     _('REPO')),

    ('', 'cwd', '',

     _('change working directory'), _('DIR')),

    ('y', 'noninteractive', None,

     _('do not prompt, automatically pick the first choice for all prompts')),

    ('q', 'quiet', None, _('suppress output')),

    ('v', 'verbose', None, _('enable additional output')),

    ('', 'config', [],

     _('set/override config option (use \'section.name=value\')'),

     _('CONFIG')),

    ('', 'debug', None, _('enable debugging output')),

    ('', 'debugger', None, _('start debugger')),

    ('', 'encoding', encoding.encoding, _('set the charset encoding'),

     _('ENCODE')),

    ('', 'encodingmode', encoding.encodingmode,

     _('set the charset encoding mode'), _('MODE')),

    ('', 'traceback', None, _('always print a traceback on exception')),

    ('', 'time', None, _('time how long the command takes')),

    ('', 'profile', None, _('print command execution profile')),

    ('', 'version', None, _('output version information and exit')),

    ('h', 'help', None, _('display help and exit')),

]

dryrunopts = [('n', 'dry-run', None,

               _('do not perform actions, just print output'))]

remoteopts = [

    ('e', 'ssh', '',

     _('specify ssh command to use'), _('CMD')),

    ('', 'remotecmd', '',

     _('specify hg command to run on the remote side'), _('CMD')),

    ('', 'insecure', None,

     _('do not verify server certificate (ignoring web.cacerts config)')),

]

walkopts = [

    ('I', 'include', [],

     _('include names matching the given patterns'), _('PATTERN')),

    ('X', 'exclude', [],

     _('exclude names matching the given patterns'), _('PATTERN')),

]

commitopts = [

    ('m', 'message', '',

     _('use text as commit message'), _('TEXT')),

    ('l', 'logfile', '',

     _('read commit message from file'), _('FILE')),

]

commitopts2 = [

    ('d', 'date', '',

     _('record the specified date as commit date'), _('DATE')),

    ('u', 'user', '',

     _('record the specified user as committer'), _('USER')),

]

templateopts = [

    ('', 'style', '',

     _('display using template map file'), _('STYLE')),

    ('', 'template', '',

     _('display with template'), _('TEMPLATE')),

]

logopts = [

    ('p', 'patch', None, _('show patch')),

    ('g', 'git', None, _('use git extended diff format')),

    ('l', 'limit', '',

     _('limit number of changes displayed'), _('NUM')),

    ('M', 'no-merges', None, _('do not show merges')),

    ('', 'stat', None, _('output diffstat-style summary of changes')),

] + templateopts

diffopts = [

    ('a', 'text', None, _('treat all files as text')),

    ('g', 'git', None, _('use git extended diff format')),

    ('', 'nodates', None, _('omit dates from diff headers'))

]

diffopts2 = [

    ('p', 'show-function', None, _('show which function each change is in')),

    ('', 'reverse', None, _('produce a diff that undoes the changes')),

    ('w', 'ignore-all-space', None,

     _('ignore white space when comparing lines')),

    ('b', 'ignore-space-change', None,

     _('ignore changes in the amount of white space')),

    ('B', 'ignore-blank-lines', None,

     _('ignore changes whose lines are all blank')),

    ('U', 'unified', '',

     _('number of lines of context to show'), _('NUM')),

    ('', 'stat', None, _('output diffstat-style summary of changes')),

]

mergetoolopts = [

    ('t', 'tool', '', _('specify merge tool')),

]

similarityopts = [

    ('s', 'similarity', '',

     _('guess renamed files by similarity (0<=s<=100)'), _('SIMILARITY'))

]

subrepoopts = [

    ('S', 'subrepos', None,

     _('recurse into subrepositories'))

]

# Commands start here, listed alphabetically

@command('^add',

    walkopts + subrepoopts + dryrunopts,

    _('[OPTION]... [FILE]...'))

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:`forget`.

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

    .. container:: verbose

       An example showing how new (unknown) files are added

       automatically by :hg:`add`::

         $ ls

         foo.c

         $ hg status

         ? foo.c

         $ hg add

         adding foo.c

         $ hg status

         A foo.c

    Returns 0 if all files are successfully added.

    """

    m = scmutil.match(repo[None], pats, opts)

    rejected = cmdutil.add(ui, repo, m, opts.get('dry_run'),

                           opts.get('subrepos'), prefix="")

    return rejected and 1 or 0

@command('addremove',

    similarityopts + walkopts + dryrunopts,

    _('[OPTION]... [FILE]...'))

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/--similarity option to detect renamed files. With a

    parameter greater than 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. After using this option, :hg:`status -C` can be

    used to check which files were identified as moved or renamed.

    Returns 0 if all files are successfully added.

    """

    try:

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

    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 scmutil.addremove(repo, pats, opts, similarity=sim / 100.0)

@command('^annotate|blame',

    [('r', 'rev', '', _('annotate the specified revision'), _('REV')),

    ('', 'follow', None,

     _('follow copies/renames and list the filename (DEPRECATED)')),

    ('', 'no-follow', None, _("don't follow copies and renames")),

    ('a', 'text', None, _('treat all files as text')),

    ('u', 'user', None, _('list the author (long with -v)')),

    ('f', 'file', None, _('list the filename')),

    ('d', 'date', None, _('list the date (short with -q)')),

    ('n', 'number', None, _('list the revision number (default)')),

    ('c', 'changeset', None, _('list the changeset')),

    ('l', 'line-number', None, _('show line number at the first appearance'))

    ] + walkopts,

    _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'))

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

    """show changeset information by line for each file

    List changes in files, showing the revision id responsible for

    each line

    This command is useful for discovering when a change was made and

    by whom.

    Without the -a/--text option, annotate will avoid processing files

    it detects as binary. With -a, annotate will annotate the file

    anyway, although the results will probably be neither useful

    nor desirable.

    Returns 0 on success.

    """

    if opts.get('follow'):

        # --follow is deprecated and now just an alias for -f/--file

        # to mimic the behavior of Mercurial before version 1.5

        opts['file'] = True

    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 filename or pattern is 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),

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

             ('line_number', ':', lambda x: str(x[1])),

            ]

    if (not opts.get('user') and not opts.get('changeset')

        and not opts.get('date') and not opts.get('file')):

        opts['number'] = True

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

    if linenumber and (not opts.get('changeset')) and (not opts.get('number')):

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

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

    funcmap[0] = (funcmap[0][0], '') # no separator in front of first column

    def bad(x, y):

        raise util.Abort("%s: %s" % (x, y))

    ctx = scmutil.revsingle(repo, opts.get('rev'))

    m = scmutil.match(ctx, pats, opts)

    m.bad = bad

    follow = not opts.get('no_follow')

    for abs in ctx.walk(m):

        fctx = ctx[abs]

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

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

            continue

        lines = fctx.annotate(follow=follow, linenumber=linenumber)

        pieces = []

        for f, sep in funcmap:

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

            if l:

                sized = [(x, encoding.colwidth(x)) for x in l]

                ml = max([w for x, w in sized])

                pieces.append(["%s%s%s" % (sep, ' ' * (ml - w), x)

                               for x, w in sized])

        if pieces:

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

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

@command('archive',

    [('', 'no-decode', None, _('do not pass files through decoders')),

    ('p', 'prefix', '', _('directory prefix for files in archive'),

     _('PREFIX')),

    ('r', 'rev', '', _('revision to distribute'), _('REV')),

    ('t', 'type', '', _('type of distribution to create'), _('TYPE')),

    ] + subrepoopts + walkopts,

    _('[OPTION]... DEST'))

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

    '''create an unversioned archive of a repository revision

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

    directory; use -r/--rev to specify a different revision.

    The archive type is automatically detected based on file

    extension (or override using -t/--type).

    .. container:: verbose

      Examples:

      - create a zip file containing the 1.0 release::

          hg archive -r 1.0 project-1.0.zip

      - create a tarball excluding .hg files::

          hg archive project.tar.gz -X ".hg*"

    Valid types are:

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

    :``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/--prefix to specify a format string for the

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

    removed.

    Returns 0 on success.

    '''

    ctx = scmutil.revsingle(repo, opts.get('rev'))

    if not ctx:

        raise util.Abort(_('no working directory: please specify a revision'))

    node = ctx.node()

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

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

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

    kind = opts.get('type') or archival.guesskind(dest) or 'files'

    prefix = opts.get('prefix')

    if dest == '-':

        if kind == 'files':

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

        dest = cmdutil.makefileobj(repo, dest)

        if not prefix:

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

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

    matchfn = scmutil.match(ctx, [], opts)

    archival.archive(repo, dest, node, kind, not opts.get('no_decode'),

                     matchfn, prefix, subrepos=opts.get('subrepos'))

@command('backout',