# keyword.py - $Keyword$ expansion for Mercurial

#

# Copyright 2007-2015 Christian Ebert <blacktrash@gmx.net>

#

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

# GNU General Public License version 2 or any later version.

#

# $Id$

#

# Keyword expansion hack against the grain of a Distributed SCM

#

# 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

# <https://mercurial-scm.org/wiki/KeywordPlan>.

#

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

#

# Binary files are not touched.

#

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

'''expand keywords in tracked files

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.

Keywords expand to the changeset data pertaining to the latest change

relative to the working directory parent of each file.

Configuration is done in the [keyword], [keywordset] and [keywordmaps]

sections of hgrc files.

Example::

    [keyword]

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

    **.py =

    x*    = ignore

    [keywordset]

    # prefer svn- over cvs-like default keywordmaps

    svn = True

.. note::

   The more specific you are in your filename patterns the less you

   lose speed in huge repositories.

For [keywordmaps] template mapping and expansion demonstration and

control run :hg:`kwdemo`. See :hg:`help templates` for a list of

available templates and filters.

Three additional date template filters are provided:

:``utcdate``:    "2006/09/18 15:13:13"

:``svnutcdate``: "2006-09-18 15:13:13Z"

:``svnisodate``: "2006-09-18 08:13:13 -700 (Mon, 18 Sep 2006)"

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 configuration changes.

Before changing/disabling active keywords, you must run :hg:`kwshrink`

to avoid storing expanded keywords in the change history.

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

:hg:`kwexpand`.

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.

'''

from __future__ import absolute_import

import os

import re

import tempfile

import weakref

from mercurial.i18n import _

from mercurial.hgweb import webcommands

from mercurial import (

    cmdutil,

    context,

    dispatch,

    error,

    extensions,

    filelog,

    localrepo,

    logcmdutil,

    match,

    patch,

    pathutil,

    pycompat,

    registrar,

    scmutil,

    templatefilters,

    util,

)

cmdtable = {}

command = registrar.command(cmdtable)

# Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for

# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should

# be specifying the version(s) of Mercurial they are tested with, or

# leave the attribute unspecified.

testedwith = 'ships-with-hg-core'

# hg commands that do not act on keywords

nokwcommands = ('add addremove annotate bundle export grep incoming init log'

                ' outgoing push tip verify convert email glog')

# webcommands that do not act on keywords

nokwwebcommands = ('annotate changeset rev filediff diff comparison')

# hg commands that trigger expansion only when writing to working dir,

# not when reading filelog, and unexpand when reading from working dir

restricted = ('merge kwexpand kwshrink record qrecord resolve transplant'

              ' unshelve rebase graft backout histedit fetch')

# names of extensions using dorecord

recordextensions = 'record'

colortable = {

    'kwfiles.enabled': 'green bold',

    'kwfiles.deleted': 'cyan bold underline',

    'kwfiles.enabledunknown': 'green',

    'kwfiles.ignored': 'bold',

    'kwfiles.ignoredunknown': 'none'

}

templatefilter = registrar.templatefilter()

configtable = {}

configitem = registrar.configitem(configtable)

configitem('keywordset', 'svn',

    default=False,

)

# date like in cvs' $Date

@templatefilter('utcdate')

def utcdate(text):

    '''Date. Returns a UTC-date in this format: "2009/08/18 11:00:13".

    '''

# date like in svn's $Date

@templatefilter('svnisodate')

def svnisodate(text):

    '''Date. Returns a date in this format: "2009-08-18 13:00:13

    +0200 (Tue, 18 Aug 2009)".

    '''

# date like in svn's $Id

@templatefilter('svnutcdate')

def svnutcdate(text):

    '''Date. Returns a UTC-date in this format: "2009-08-18

    11:00:13Z".

    '''

# make keyword tools accessible

kwtools = {'hgcmd': ''}

def _defaultkwmaps(ui):

    '''Returns default keywordmaps according to keywordset configuration.'''

    templates = {

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

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

    }

    kwsets = ({

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

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

        'RCSFile': '{file|basename},v', # kept for backwards compatibility

                                        # with hg-keyword

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

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

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

    }, {

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

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

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

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

        'LastChangedDate': '{date|svnisodate}',

    })

    templates.update(kwsets[ui.configbool('keywordset', 'svn')])

    return templates

def _shrinktext(text, subfunc):

    '''Helper for keyword expansion removal in text.

    Depending on subfunc also returns number of substitutions.'''

    return subfunc(r'$\1$', text)

def _preselect(wstatus, changed):

    '''Retrieves modified and added files from a working directory state

    and returns the subset of each contained in given changed files

    retrieved from a change context.'''

    modified = [f for f in wstatus.modified if f in changed]

    added = [f for f in wstatus.added if f in changed]

    return modified, added

class kwtemplater(object):

    '''

    Sets up keyword templates, corresponding keyword regex, and

    provides keyword substitution functions.

    '''

    def __init__(self, ui, repo, inc, exc):

        self.ui = ui

        self._repo = weakref.ref(repo)

        self.match = match.match(repo.root, '', [], inc, exc)

        self.restrict = kwtools['hgcmd'] in restricted.split()

        self.postcommit = False

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

        if kwmaps: # override default templates

            self.templates = dict(kwmaps)

        else:

            self.templates = _defaultkwmaps(self.ui)

    @property

    def repo(self):

        return self._repo()

    @util.propertycache

    def escape(self):

        '''Returns bar-separated and escaped keywords.'''

        return '|'.join(map(re.escape, self.templates.keys()))

    @util.propertycache

    def rekw(self):

        '''Returns regex for unexpanded keywords.'''

        return re.compile(r'\$(%s)\$' % self.escape)

    @util.propertycache

    def rekwexp(self):

        '''Returns regex for expanded keywords.'''

        return re.compile(r'\$(%s): [^$\n\r]*? \$' % self.escape)

    def substitute(self, data, path, ctx, subfunc):

        '''Replaces keywords in data with expanded template.'''

        def kwsub(mobj):

            kw = mobj.group(1)

            ct = logcmdutil.maketemplater(self.ui, self.repo,

                                          self.templates[kw])

            self.ui.pushbuffer()

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

            ekw = templatefilters.firstline(self.ui.popbuffer())

            return '$%s: %s $' % (kw, ekw)

        return subfunc(kwsub, data)

    def linkctx(self, path, fileid):

        '''Similar to filelog.linkrev, but returns a changectx.'''

        return self.repo.filectx(path, fileid=fileid).changectx()

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

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

        if not self.restrict and self.match(path) and not util.binary(data):

            ctx = self.linkctx(path, node)

            return self.substitute(data, path, ctx, self.rekw.sub)

        return data

    def iskwfile(self, cand, ctx):

        '''Returns subset of candidates which are configured for keyword

        expansion but are not symbolic links.'''

        return [f for f in cand if self.match(f) and 'l' not in ctx.flags(f)]

    def overwrite(self, ctx, candidates, lookup, expand, rekw=False):

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

        if self.restrict or lookup or self.postcommit: # exclude kw_copy

            candidates = self.iskwfile(candidates, ctx)

        if not candidates:

            return

        kwcmd = self.restrict and lookup # kwexpand/kwshrink

        if self.restrict or expand and lookup:

            mf = ctx.manifest()

        if self.restrict or rekw:

            re_kw = self.rekw

        else:

            re_kw = self.rekwexp

        if expand:

            msg = _('overwriting %s expanding keywords\n')

        else:

            msg = _('overwriting %s shrinking keywords\n')

        for f in candidates:

            if self.restrict:

                data = self.repo.file(f).read(mf[f])

            else:

                data = self.repo.wread(f)

            if util.binary(data):

                continue

            if expand:

                parents = ctx.parents()

                if lookup:

                    ctx = self.linkctx(f, mf[f])

                elif self.restrict and len(parents) > 1:

                    # merge commit

                    # in case of conflict f is in modified state during

                    # merge, even if f does not differ from f in parent

                    for p in parents:

                        if f in p and not p[f].cmp(ctx[f]):

                            ctx = p[f].changectx()

                            break

                data, found = self.substitute(data, f, ctx, re_kw.subn)

            elif self.restrict:

                found = re_kw.search(data)

            else:

                data, found = _shrinktext(data, re_kw.subn)

            if found:

                self.ui.note(msg % f)

                fp = self.repo.wvfs(f, "wb", atomictemp=True)

                fp.write(data)

                fp.close()

                if kwcmd:

                    self.repo.dirstate.normal(f)

                elif self.postcommit:

                    self.repo.dirstate.normallookup(f)

    def shrink(self, fname, text):

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

        if self.match(fname) and not util.binary(text):

            return _shrinktext(text, self.rekwexp.sub)

        return text

    def shrinklines(self, fname, lines):

        '''Returns lines with keyword substitutions removed.'''

        if self.match(fname):

            text = ''.join(lines)

            if not util.binary(text):

                return _shrinktext(text, self.rekwexp.sub).splitlines(True)

        return lines

    def wread(self, fname, data):

        '''If in restricted mode returns data read from wdir with

        keyword substitutions removed.'''

        if self.restrict:

            return self.shrink(fname, data)

        return data

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, kwt, path):

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

        self.kwt = kwt

        self.path = path

    def read(self, node):

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

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

        if self.renamed(node):

            return data

        return self.kwt.expand(self.path, node, data)

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

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

        text = self.kwt.shrink(self.path, text)

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

    def cmp(self, node, text):

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

        text = self.kwt.shrink(self.path, text)

        return super(kwfilelog, self).cmp(node, text)

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

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

    Returns status of working directory.'''

    if kwt:

        opts = pycompat.byteskwargs(opts)

        return repo.status(match=scmutil.match(wctx, pats, opts), clean=True,