# 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.node import *

from mercurial.i18n import gettext as _

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

# backwards compatibility hacks

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 _link(repo, f):

    try:

        return repo._link(f)

    except AttributeError:

        return os.path.islink(repo.wjoin(f))

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.optionalrepo += ' kwdemo'

def utcdate(date):

    '''Returns hgdate in cvs-like UTC format.'''

    return time.strftime('%Y/%m/%d %H:%M:%S', time.gmtime(date[0]))

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}',

    }

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

        self.ui = ui

        self.repo = repo

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

        self.ctx = None

        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)

        templater.common_filters['utcdate'] = utcdate

        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, path, data, node, subfunc):

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

        and calls given substitution function.'''

        if node is None:

            # kwrepo.wwrite except when overwriting on commit

            if self.ctx is None:

                self.ctx = self.repo.changectx()

            try:

                fnode = self.ctx.filenode(path)

                fl = self.repo.file(path)

                c = context.filectx(self.repo, path, fileid=fnode, filelog=fl)

                node = c.node()

            except revlog.LookupError:

                # eg: convert

                return subfunc == self.re_kw.sub and data or (data, None)

        elif subfunc == self.re_kw.sub:

            # hg kwcat using kwfilelog.read

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

            node = 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=node, root=self.repo.root, file=path)

            return '$%s: %s $' % (kw, templater.firstline(self.ui.popbuffer()))

        return subfunc(kwsub, data)

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

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

        if util.binary(data):

            return data

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

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

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

            self.ctx = ctx

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

        return self.re_kw.subn(r'$\1$', data)

    def shrink(self, data):

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

        if util.binary(data):

            return data

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

class kwfilelog(filelog.filelog):

    '''

    Subclass of filelog to hook into its read method for kwcat.

    '''

    def __init__(self, opener, path, kwt):

        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)

        return self._kwt.expand(self._path, data, node)

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

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

    Returns status of working directory.'''

    if hasattr(repo, '_kwt'):

        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

        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 not mf.linkf(f) and repo._kwt.matcher(f)]

    if candidates:

        overwritten = []

        candidates.sort()

        action = expand and 'expanding' or 'shrinking'

        for f in candidates:

            data, kwfound = repo._wreadkwct(f, expand, ctx, node)

            if kwfound:

                notify(_('overwriting %s %s keywords\n') % (f, action))

                repo.wwrite(f, data, mf.flags(f), overwrite=True)

                overwritten.append(f)

        _normal(repo, overwritten)

def _kwfwrite(ui, repo, expand, *pats, **opts):

    '''Selects files and passes them to _overwrite.'''

    status = _status(ui, repo, *pats, **opts)

    modified, added, removed, deleted, unknown, ignored, clean = status

    if modified or added or removed or deleted:

        raise util.Abort(_('outstanding uncommitted changes in given files'))

    wlock = lock = None

    try:

        wlock = repo.wlock()

        lock = repo.lock()

        _overwrite(ui, repo, expand=expand, files=clean)

    finally:

        del wlock, lock

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

    '''output the current or given revision of files expanding keywords

    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

    '''

    try:

        repo.file = repo._kwfile

    except AttributeError:

        pass

    commands.cat(ui, repo, file1, *pats, **opts)

def demo(ui, repo, *args, **opts):

    '''print [keywordmaps] configuration and an expansion example

    Show current, custom, or default keyword template maps

    and their expansion.

    Extend current configuration by specifying maps as arguments

    and optionally by reading from an additional hgrc file.

    Override current keyword template maps with "default" option.

    '''

    def demostatus(stat):

        ui.status(_('\n\t%s\n') % stat)

    def demoitems(section, items):

        ui.write('[%s]\n' % section)

        for k, v in items:

            ui.write('%s = %s\n' % (k, v))

    msg = 'hg keyword config and expansion example'

    kwstatus = 'current'

    fn = 'demo.txt'

    branchname = 'demobranch'

    tmpdir = tempfile.mkdtemp('', 'kwdemo.')

    ui.note(_('creating temporary repo at %s\n') % tmpdir)

    repo = localrepo.localrepository(ui, path=tmpdir, create=True)

    ui.setconfig('keyword', fn, '')

    if args or opts.get('rcfile'):

        kwstatus = 'custom'

    if opts.get('rcfile'):

        ui.readconfig(opts.get('rcfile'))

    if opts.get('default'):

        kwstatus = 'default'

        kwmaps = kwtemplater.templates

        if ui.configitems('keywordmaps'):

            # override maps from optional rcfile

            for k, v in kwmaps.iteritems():

                ui.setconfig('keywordmaps', k, v)

    elif args:

        # simulate hgrc parsing

        rcmaps = ['[keywordmaps]\n'] + [a + '\n' for a in args]

        fp = repo.opener('hgrc', 'w')

        fp.writelines(rcmaps)

        fp.close()

        ui.readconfig(repo.join('hgrc'))

    if not opts.get('default'):

        kwmaps = dict(ui.configitems('keywordmaps')) or kwtemplater.templates

    reposetup(ui, repo)

    for k, v in ui.configitems('extensions'):

        if k.endswith('keyword'):

            extension = '%s = %s' % (k, v)

            break

    demostatus('config using %s keyword template maps' % kwstatus)

    ui.write('[extensions]\n%s\n' % extension)

    demoitems('keyword', ui.configitems('keyword'))

    demoitems('keywordmaps', kwmaps.iteritems())

    keywords = '$' + '$\n$'.join(kwmaps.keys()) + '$\n'

    repo.wopener(fn, 'w').write(keywords)

    repo.add([fn])

    path = repo.wjoin(fn)

    ui.note(_('\n%s keywords written to %s:\n') % (kwstatus, path))