# keyword.py - $Keyword$ expansion for Mercurial

#

# Copyright 2007, 2008 Christian Ebert <blacktrash@gmx.net>

#

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

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

#

# $Id$

#

# Keyword expansion hack against the grain of a DSCM

#

# There are many good reasons why this is not needed in a distributed

# SCM, still it may be useful in very small projects based on single

# files (like LaTeX packages), that are mostly addressed to an audience

# not running a version control system.

#

# For in-depth discussion refer to

# <http://www.selenic.com/mercurial/wiki/index.cgi/KeywordPlan>.

#

# Keyword expansion is based on Mercurial's changeset template mappings.

#

# Binary files are not touched.

#

# Setup in hgrc:

#

#   [extensions]

#   # enable extension

#   keyword = /full/path/to/hgkw/keyword.py

#   # or, if script in canonical hgext folder:

#   # hgext.keyword =

#

# Files to act upon/ignore are specified in the [keyword] section.

# Customized keyword template mappings in the [keywordmaps] section.

#

# Run "hg help keyword" and "hg kwdemo" to get info on configuration.

'''keyword expansion in local repositories

This extension expands RCS/CVS-like or self-customized $Keywords$

in tracked text files selected by your configuration.

Keywords are only expanded in local repositories and not stored in

the change history. The mechanism can be regarded as a convenience

for the current user or for archive distribution.

Configuration is done in the [keyword] and [keywordmaps] sections

of hgrc files.

Example:

    [keyword]

    # expand keywords in every python file except those matching "x*"

    **.py =

    x*    = ignore

Note: the more specific you are in your filename patterns

      the less you lose speed in huge repos.

For [keywordmaps] template mapping and expansion demonstration and

control run "hg kwdemo".

An additional date template filter {date|utcdate} is provided.

The default template mappings (view with "hg kwdemo -d") can be replaced

with customized keywords and templates.

Again, run "hg kwdemo" to control the results of your config changes.

Before changing/disabling active keywords, run "hg kwshrink" to avoid

the risk of inadvertedly storing expanded keywords in the change history.

To force expansion after enabling it, or a configuration change, run

"hg kwexpand".

Also, when committing with the record extension or using mq's qrecord, be aware

that keywords cannot be updated. Again, run "hg kwexpand" on the files in

question to update keyword expansions after all changes have been checked in.

Expansions spanning more than one line and incremental expansions,

like CVS' $Log$, are not supported. A keyword template map

"Log = {desc}" expands to the first line of the changeset description.

        Or, better, use bundle/unbundle to share changes.

'''

from mercurial import commands, cmdutil, context, fancyopts

from mercurial import filelog, localrepo, revlog, templater, util

from mercurial.node import *

from mercurial.i18n import gettext as _

import getopt, os.path, re, shutil, sys, tempfile, time

# backwards compatibility hacks

try:

    # cmdutil.parse moves to dispatch._parse in 18a9fbb5cd78

    # also avoid name conflict with other dispatch package(s)

    from mercurial.dispatch import _parse

except ImportError:

    try:

        # commands.parse moves to cmdutil.parse in 0c61124ad877

        _parse = cmdutil.parse

    except AttributeError:

        _parse = commands.parse

def _wwrite(repo, f, data, mf):

    '''Makes repo.wwrite backwards compatible.'''

    # 656e06eebda7 removed file descriptor argument

    # 67982d3ee76c added flags argument

    try:

        repo.wwrite(f, data, mf.flags(f))

    except (AttributeError, TypeError):

        repo.wwrite(f, data)

def _normal(repo, files):

    '''Backwards compatible repo.dirstate.normal/update.'''

    # 6fd953d5faea introduced dirstate.normal()

    try:

        for f in files:

            repo.dirstate.normal(f)

    except AttributeError:

        repo.dirstate.update(files, 'n')

def _pathto(repo, f, cwd=None):

    '''kwfiles behaves similar to status, using pathto since 78b6add1f966.'''

    try:

        return repo.pathto(f, cwd)

    except AttributeError:

        return f

# commands.parse/cmdutil.parse returned nothing for

# "hg diff --rev" before 88803a69b24a due to bug in fancyopts

def _fancyopts(args, options, state):

    '''Fixed fancyopts from a9b7e425674f.'''

    namelist = []

    shortlist = ''

    argmap = {}

    defmap = {}

    for short, name, default, comment in options:

        # convert opts to getopt format

        oname = name

        name = name.replace('-', '_')

        argmap['-' + short] = argmap['--' + oname] = name

        defmap[name] = default

        # copy defaults to state

        if isinstance(default, list):

            state[name] = default[:]

        elif callable(default):

            print "whoa", name, default

            state[name] = None

        else:

            state[name] = default

        # does it take a parameter?

        if not (default is None or default is True or default is False):

            if short: short += ':'

            if oname: oname += '='

        if short:

            shortlist += short

        if name:

            namelist.append(oname)

    # parse arguments

    opts, args = getopt.getopt(args, shortlist, namelist)

    # transfer result to state

    for opt, val in opts:

        name = argmap[opt]

        t = type(defmap[name])

        if t is type(fancyopts):

            state[name] = defmap[name](val)

        elif t is type(1):

            state[name] = int(val)

        elif t is type(''):

            state[name] = val

        elif t is type([]):

            state[name].append(val)

        elif t is type(None) or t is type(False):

            state[name] = True

    # return unparsed args

    return args

fancyopts.fancyopts = _fancyopts

class kwtemplater(object):

    '''

    Sets up keyword templates, corresponding keyword regex, and

    provides keyword substitution functions.

    '''

    templates = {

        'Revision': '{node|short}',

        'Author': '{author|user}',

        'Date': '{date|utcdate}',

        'RCSFile': '{file|basename},v',

        'Source': '{root}/{file},v',

        'Id': '{file|basename},v {node|short} {date|utcdate} {author|user}',

        'Header': '{root}/{file},v {node|short} {date|utcdate} {author|user}',

    }

        self.ui = ui

        self.repo = repo

        self.matcher = util.matcher(repo.root, inc=inc, exc=exc)[1]

        self.commitnode = None

        self.path = ''

        kwmaps = self.ui.configitems('keywordmaps')

        if kwmaps: # override default templates

            kwmaps = [(k, templater.parsestring(v, quoted=False))

                      for (k, v) in kwmaps]

            self.templates = dict(kwmaps)

        escaped = map(re.escape, self.templates.keys())

        kwpat = r'\$(%s)(: [^$\n\r]*? )??\$' % '|'.join(escaped)

        self.re_kw = re.compile(kwpat)

        self.ct = self._changeset_templater()

    def _changeset_templater(self):

        '''Backwards compatible cmdutil.changeset_templater.'''

        # before 1e0b94cfba0e there was an extra "brinfo" argument

        try:

            return cmdutil.changeset_templater(self.ui, self.repo,

                                               False, '', False)

        except TypeError:

            return cmdutil.changeset_templater(self.ui, self.repo,

                                               False, None, '', False)

    def substitute(self, node, data, subfunc):

        '''Obtains file's changenode if commit node not given,

        and calls given substitution function.'''

        if self.commitnode:

            fnode = self.commitnode

        else:

            c = context.filectx(self.repo, self.path, fileid=node)

            fnode = c.node()

        def kwsub(mobj):

            '''Substitutes keyword using corresponding template.'''

            kw = mobj.group(1)

            self.ct.use_template(self.templates[kw])

            self.ui.pushbuffer()

            self.ct.show(changenode=fnode, root=self.repo.root, file=self.path)

        return subfunc(kwsub, data)

    def expand(self, node, data):

        '''Returns data with keywords expanded.'''

            return data

        return self.substitute(node, data, self.re_kw.sub)

    def process(self, node, data, expand):

        '''Returns a tuple: data, count.

        Count is number of keywords/keyword substitutions,

        telling caller whether to act on file containing data.'''

        if util.binary(data):

            return data, None

        if expand:

            return self.substitute(node, data, self.re_kw.subn)

        return data, self.re_kw.search(data)

    def shrink(self, text):

        '''Returns text with all keyword substitutions removed.'''

        if util.binary(text):

            return text

        return self.re_kw.sub(r'$\1$', text)

class kwfilelog(filelog.filelog):

    '''

    Subclass of filelog to hook into its read, add, cmp methods.

    Keywords are "stored" unexpanded, and processed on reading.

    '''

    def __init__(self, opener, path):

        super(kwfilelog, self).__init__(opener, path)

        _kwtemplater.path = path

    def kwctread(self, node, expand):

        '''Reads expanding and counting keywords, called from _overwrite.'''

        data = super(kwfilelog, self).read(node)

        return _kwtemplater.process(node, data, expand)

    def read(self, node):

        '''Expands keywords when reading filelog.'''

        data = super(kwfilelog, self).read(node)

        return _kwtemplater.expand(node, data)

    def add(self, text, meta, tr, link, p1=None, p2=None):

        '''Removes keyword substitutions when adding to filelog.'''

        text = _kwtemplater.shrink(text)

        return super(kwfilelog, self).add(text, meta, tr, link, p1=p1, p2=p2)

    def cmp(self, node, text):

        '''Removes keyword substitutions for comparison.'''

        text = _kwtemplater.shrink(text)

        if self.renamed(node):

            t2 = super(kwfilelog, self).read(node)

            return t2 != text

        return revlog.revlog.cmp(self, node, text)

def _iskwfile(f, link):

    return not link(f) and _kwtemplater.matcher(f)

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

    '''Bails out if [keyword] configuration is not active.

    Returns status of working directory.'''

    if _kwtemplater:

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

        return repo.status(files=files, match=match, list_clean=True)

    if ui.configitems('keyword'):

        raise util.Abort(_('[keyword] patterns cannot match'))

    raise util.Abort(_('no [keyword] patterns configured'))

def _overwrite(ui, repo, node=None, expand=True, files=None):

    '''Overwrites selected files expanding/shrinking keywords.'''

    ctx = repo.changectx(node)

    mf = ctx.manifest()

    if node is not None:   # commit

        _kwtemplater.commitnode = node

        files = [f for f in ctx.files() if f in mf]

        notify = ui.debug

    else:                  # kwexpand/kwshrink

        notify = ui.note

    candidates = [f for f in files if _iskwfile(f, mf.linkf)]

    if candidates:

        overwritten = []

        candidates.sort()

        action = expand and 'expanding' or 'shrinking'

        for f in candidates:

            fp = repo.file(f, kwmatch=True)

            data, kwfound = fp.kwctread(mf[f], expand)

            if kwfound: