"""automatically manage newlines in repository files

This extension allows you to manage the type of line endings (CRLF or

LF) that are used in the repository and in the local working

directory. That way you can get CRLF line endings on Windows and LF on

Unix/Mac, thereby letting everybody use their OS native line endings.

The extension reads its configuration from a versioned ``.hgeol``

configuration file found in the root of the working directory. The

``.hgeol`` file use the same syntax as all other Mercurial

configuration files. It uses two sections, ``[patterns]`` and

``[repository]``.

The ``[patterns]`` section specifies how line endings should be

converted between the working directory and the repository. The format is

specified by a file pattern. The first match is used, so put more

specific patterns first. The available line endings are ``LF``,

``CRLF``, and ``BIN``.

Files with the declared format of ``CRLF`` or ``LF`` are always

checked out and stored in the repository in that format and files

declared to be binary (``BIN``) are left unchanged. Additionally,

``native`` is an alias for checking out in the platform's default line

ending: ``LF`` on Unix (including Mac OS X) and ``CRLF`` on

Windows. Note that ``BIN`` (do nothing to line endings) is Mercurial's

default behavior; it is only needed if you need to override a later,

more general pattern.

The optional ``[repository]`` section specifies the line endings to

use for files stored in the repository. It has a single setting,

``native``, which determines the storage line endings for files

declared as ``native`` in the ``[patterns]`` section. It can be set to

``LF`` or ``CRLF``. The default is ``LF``. For example, this means

that on Windows, files configured as ``native`` (``CRLF`` by default)

will be converted to ``LF`` when stored in the repository. Files

declared as ``LF``, ``CRLF``, or ``BIN`` in the ``[patterns]`` section

are always stored as-is in the repository.

Example versioned ``.hgeol`` file::

  [patterns]

  **.py = native

  **.vcproj = CRLF

  **.txt = native

  Makefile = LF

  **.jpg = BIN

  [repository]

  native = LF

.. note::

   The rules will first apply when files are touched in the working

   directory, e.g. by updating to null and back to tip to touch all files.

The extension uses an optional ``[eol]`` section read from both the

normal Mercurial configuration files and the ``.hgeol`` file, with the

latter overriding the former. You can use that section to control the

overall behavior. There are three settings:

- ``eol.native`` (default ``os.linesep``) can be set to ``LF`` or

  ``CRLF`` to override the default interpretation of ``native`` for

  checkout. This can be used with :hg:`archive` on Unix, say, to

  generate an archive where files have line endings for Windows.

- ``eol.only-consistent`` (default True) can be set to False to make

  the extension convert files with inconsistent EOLs. Inconsistent

  means that there is both ``CRLF`` and ``LF`` present in the file.

  Such files are normally not touched under the assumption that they

  have mixed EOLs on purpose.

- ``eol.fix-trailing-newline`` (default False) can be set to True to

  ensure that converted files end with a EOL character (either ``\\n``

  or ``\\r\\n`` as per the configured patterns).

The extension provides ``cleverencode:`` and ``cleverdecode:`` filters

like the deprecated win32text extension does. This means that you can

disable win32text and enable eol and your filters will still work. You

only need to these filters until you have prepared a ``.hgeol`` file.

The ``win32text.forbid*`` hooks provided by the win32text extension

have been unified into a single hook named ``eol.checkheadshook``. The

hook will lookup the expected line endings from the ``.hgeol`` file,

which means you must migrate to a ``.hgeol`` file first before using

the hook. ``eol.checkheadshook`` only checks heads, intermediate

invalid revisions will be pushed. To forbid them completely, use the

``eol.checkallhook`` hook. These hooks are best used as

``pretxnchangegroup`` hooks.

See :hg:`help patterns` for more information about the glob patterns

used.

"""

from __future__ import absolute_import

import os

import re

from mercurial.i18n import _

from mercurial import (

    config,

    error as errormod,

    extensions,

    match,

    pycompat,

    registrar,

    scmutil,

    util,

)

from mercurial.utils import stringutil

# 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 = b'ships-with-hg-core'

configtable = {}

configitem = registrar.configitem(configtable)

configitem(

    b'eol', b'fix-trailing-newline', default=False,

)

configitem(

    b'eol', b'native', default=pycompat.oslinesep,

)

configitem(

    b'eol', b'only-consistent', default=True,

)

# Matches a lone LF, i.e., one that is not part of CRLF.

singlelf = re.compile(b'(^|[^\r])\n')

def inconsistenteol(data):

    return b'\r\n' in data and singlelf.search(data)

def tolf(s, params, ui, **kwargs):

    """Filter to convert to LF EOLs."""

    if stringutil.binary(s):

        return s

    if ui.configbool(b'eol', b'only-consistent') and inconsistenteol(s):

        return s

    if (

        ui.configbool(b'eol', b'fix-trailing-newline')

        and s

        and not s.endswith(b'\n')

    ):

        s = s + b'\n'

    return util.tolf(s)

def tocrlf(s, params, ui, **kwargs):

    """Filter to convert to CRLF EOLs."""

    if stringutil.binary(s):

        return s

    if ui.configbool(b'eol', b'only-consistent') and inconsistenteol(s):

        return s

    if (

        ui.configbool(b'eol', b'fix-trailing-newline')

        and s

        and not s.endswith(b'\n')

    ):

        s = s + b'\n'

    return util.tocrlf(s)

def isbinary(s, params, ui, **kwargs):

    """Filter to do nothing with the file."""

    return s

filters = {

    b'to-lf': tolf,

    b'to-crlf': tocrlf,

    b'is-binary': isbinary,

    # The following provide backwards compatibility with win32text

    b'cleverencode:': tolf,

    b'cleverdecode:': tocrlf,

}

class eolfile(object):

    def __init__(self, ui, root, data):

        self._decode = {

            b'LF': b'to-lf',

            b'CRLF': b'to-crlf',

            b'BIN': b'is-binary',

        }

        self._encode = {

            b'LF': b'to-lf',

            b'CRLF': b'to-crlf',

            b'BIN': b'is-binary',

        }

        self.cfg = config.config()

        # Our files should not be touched. The pattern must be

        # inserted first override a '** = native' pattern.

        self.cfg.set(b'patterns', b'.hg*', b'BIN', b'eol')

        # We can then parse the user's patterns.

        self.cfg.parse(b'.hgeol', data)

        isrepolf = self.cfg.get(b'repository', b'native') != b'CRLF'

        self._encode[b'NATIVE'] = isrepolf and b'to-lf' or b'to-crlf'

        iswdlf = ui.config(b'eol', b'native') in (b'LF', b'\n')

        self._decode[b'NATIVE'] = iswdlf and b'to-lf' or b'to-crlf'

        include = []

        exclude = []

        self.patterns = []

        for pattern, style in self.cfg.items(b'patterns'):

            key = style.upper()

            if key == b'BIN':

                exclude.append(pattern)

            else:

                include.append(pattern)

            m = match.match(root, b'', [pattern])

            self.patterns.append((pattern, key, m))

        # This will match the files for which we need to care

        # about inconsistent newlines.

        self.match = match.match(root, b'', [], include, exclude)

    def copytoui(self, ui):

        newpatterns = {pattern for pattern, key, m in self.patterns}

        for section in (b'decode', b'encode'):

            for oldpattern, _filter in ui.configitems(section):

                if oldpattern not in newpatterns:

                    if ui.configsource(section, oldpattern) == b'eol':

                        ui.setconfig(section, oldpattern, b'!', b'eol')

        for pattern, key, m in self.patterns:

            try:

                ui.setconfig(b'decode', pattern, self._decode[key], b'eol')

                ui.setconfig(b'encode', pattern, self._encode[key], b'eol')

            except KeyError:

                ui.warn(

                    _(b"ignoring unknown EOL style '%s' from %s\n")

                    % (key, self.cfg.source(b'patterns', pattern))

                )

        # eol.only-consistent can be specified in ~/.hgrc or .hgeol

        for k, v in self.cfg.items(b'eol'):

            ui.setconfig(b'eol', k, v, b'eol')

    def checkrev(self, repo, ctx, files):

        failed = []

        for f in files or ctx.files():

            if f not in ctx:

                continue

            for pattern, key, m in self.patterns:

                if not m(f):

                    continue

                target = self._encode[key]

                data = ctx[f].data()

                if (

                    target == b"to-lf"

                    and b"\r\n" in data

                    or target == b"to-crlf"

                    and singlelf.search(data)

                ):

                    failed.append((f, target, bytes(ctx)))

                break

        return failed

def parseeol(ui, repo, nodes):

    try:

        for node in nodes:

            try:

                if node is None:

                    # Cannot use workingctx.data() since it would load

                    # and cache the filters before we configure them.

                    data = repo.wvfs(b'.hgeol').read()

                else:

                    data = repo[node][b'.hgeol'].data()

                return eolfile(ui, repo.root, data)

            except (IOError, LookupError):

                pass

        ui.warn(

            _(

                b"warning: ignoring .hgeol file due to parse error "

                b"at %s: %s\n"

            )

            % (inst.location, inst.message)

        )

    return None

def ensureenabled(ui):

    """make sure the extension is enabled when used as hook

    When eol is used through hooks, the extension is never formally loaded and

    enabled. This has some side effect, for example the config declaration is

    never loaded. This function ensure the extension is enabled when running

    hooks.

    """

    if b'eol' in ui._knownconfig:

        return

    ui.setconfig(b'extensions', b'eol', b'', source=b'internal')

    extensions.loadall(ui, [b'eol'])

def _checkhook(ui, repo, node, headsonly):

    # Get revisions to check and touched files at the same time

    ensureenabled(ui)

    files = set()

    revs = set()

    for rev in pycompat.xrange(repo[node].rev(), len(repo)):

        revs.add(rev)

        if headsonly:

            ctx = repo[rev]

            files.update(ctx.files())

            for pctx in ctx.parents():

                revs.discard(pctx.rev())

    failed = []

    for rev in revs:

        ctx = repo[rev]

        eol = parseeol(ui, repo, [ctx.node()])

        if eol:

            failed.extend(eol.checkrev(repo, ctx, files))

    if failed:

        eols = {b'to-lf': b'CRLF', b'to-crlf': b'LF'}

        msgs = []

        for f, target, node in sorted(failed):

            msgs.append(

                _(b"  %s in %s should not have %s line endings")

                % (f, node, eols[target])

            )

        raise errormod.Abort(

            _(b"end-of-line check failed:\n") + b"\n".join(msgs)

        )

def checkallhook(ui, repo, node, hooktype, **kwargs):

    """verify that files have expected EOLs"""

    _checkhook(ui, repo, node, False)

def checkheadshook(ui, repo, node, hooktype, **kwargs):

    """verify that files have expected EOLs"""

    _checkhook(ui, repo, node, True)

# "checkheadshook" used to be called "hook"

hook = checkheadshook

def preupdate(ui, repo, hooktype, parent1, parent2):

    p1node = scmutil.resolvehexnodeidprefix(repo, parent1)

    repo.loadeol([p1node])

    return False

def uisetup(ui):

    ui.setconfig(b'hooks', b'preupdate.eol', preupdate, b'eol')

def extsetup(ui):

    try:

        extensions.find(b'win32text')

        ui.warn(

            _(

                b"the eol extension is incompatible with the "

                b"win32text extension\n"

            )

        )

    except KeyError:

        pass

def reposetup(ui, repo):

    uisetup(repo.ui)

    if not repo.local():

        return

    for name, fn in pycompat.iteritems(filters):

        repo.adddatafilter(name, fn)

    ui.setconfig(b'patch', b'eol', b'auto', b'eol')

    class eolrepo(repo.__class__):

        def loadeol(self, nodes):

            eol = parseeol(self.ui, self, nodes)

            if eol is None:

                return None

            eol.copytoui(self.ui)

            return eol.match

        def _hgcleardirstate(self):