# match.py - filename matching

#

#  Copyright 2008, 2009 Matt Mackall <mpm@selenic.com> and others

#

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

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

from __future__ import absolute_import

import copy

import os

import re

from .i18n import _

from . import (

    error,

    pathutil,

    util,

)

propertycache = util.propertycache

def _rematcher(regex):

    '''compile the regexp with the best available regexp engine and return a

    matcher function'''

    m = util.re.compile(regex)

    try:

        # slightly faster, provided by facebook's re2 bindings

        return m.test_match

    except AttributeError:

        return m.match

def _expandsets(kindpats, ctx, listsubrepos):

    '''Returns the kindpats list with the 'set' patterns expanded.'''

    fset = set()

    other = []

    for kind, pat, source in kindpats:

        if kind == 'set':

            if not ctx:

                raise error.Abort(_("fileset expression with no context"))

            s = ctx.getfileset(pat)

            fset.update(s)

            if listsubrepos:

                for subpath in ctx.substate:

                    s = ctx.sub(subpath).getfileset(pat)

                    fset.update(subpath + '/' + f for f in s)

            continue

        other.append((kind, pat, source))

    return fset, other

def _expandsubinclude(kindpats, root):

    '''Returns the list of subinclude matchers and the kindpats without the

    subincludes in it.'''

    relmatchers = []

    other = []

    for kind, pat, source in kindpats:

        if kind == 'subinclude':

            sourceroot = pathutil.dirname(util.normpath(source))

            pat = util.pconvert(pat)

            path = pathutil.join(sourceroot, pat)

            newroot = pathutil.dirname(path)

            relmatcher = match(newroot, '', [], ['include:%s' % path])

            prefix = pathutil.canonpath(root, root, newroot)

            if prefix:

                prefix += '/'

            relmatchers.append((prefix, relmatcher))

        else:

            other.append((kind, pat, source))

    return relmatchers, other

def _kindpatsalwaysmatch(kindpats):

    """"Checks whether the kindspats match everything, as e.g.

    'relpath:.' does.

    """

    for kind, pat, source in kindpats:

        if pat != '' or kind not in ['relpath', 'glob']:

            return False

    return True

class match(object):

    def __init__(self, root, cwd, patterns, include=[], exclude=[],

                 default='glob', exact=False, auditor=None, ctx=None,

                 listsubrepos=False, warn=None, badfn=None):

        """build an object to match a set of file patterns

        arguments:

        root - the canonical root of the tree you're matching against

        cwd - the current working directory, if relevant

        patterns - patterns to find

        include - patterns to include (unless they are excluded)

        exclude - patterns to exclude (even if they are included)

        default - if a pattern in patterns has no explicit type, assume this one

        exact - patterns are actually filenames (include/exclude still apply)

        warn - optional function used for printing warnings

        badfn - optional bad() callback for this matcher instead of the default

        a pattern is one of:

        'glob:<glob>' - a glob relative to cwd

        're:<regexp>' - a regular expression

        'path:<path>' - a path relative to repository root, which is matched

                        recursively

        'rootfilesin:<path>' - a path relative to repository root, which is

                        matched non-recursively (will not match subdirectories)

        'relglob:<glob>' - an unrooted glob (*.c matches C files in all dirs)

        'relpath:<path>' - a path relative to cwd

        'relre:<regexp>' - a regexp that needn't match the start of a name

        'set:<fileset>' - a fileset expression

        'include:<path>' - a file of patterns to read and include

        'subinclude:<path>' - a file of patterns to match against files under

                              the same directory

        '<something>' - a pattern of the specified default type

        """

        self._root = root

        self._cwd = cwd

        self._files = [] # exact files and roots of patterns

        self._anypats = bool(include or exclude)

        self._always = False

        self._pathrestricted = bool(include or exclude or patterns)

        self._warn = warn

        self._includeroots = set()

        self._includedirs = set(['.'])

        if badfn is not None:

            self.bad = badfn

        matchfns = []

        if include:

            kindpats = self._normalize(include, 'glob', root, cwd, auditor)

            self.includepat, im = _buildmatch(ctx, kindpats, '(?:/|$)',

                                              listsubrepos, root)

            matchfns.append(im)

        if exclude:

            kindpats = self._normalize(exclude, 'glob', root, cwd, auditor)

            self.excludepat, em = _buildmatch(ctx, kindpats, '(?:/|$)',

                                              listsubrepos, root)

            if not _anypats(kindpats):

                self._excluderoots.update(_roots(kindpats))

            matchfns.append(lambda f: not em(f))

        if exact:

            if isinstance(patterns, list):

                self._files = patterns

            else:

                self._files = list(patterns)

            matchfns.append(self.exact)

        elif patterns:

            kindpats = self._normalize(patterns, default, root, cwd, auditor)

            if not _kindpatsalwaysmatch(kindpats):

                self._files = _explicitfiles(kindpats)

                self._anypats = self._anypats or _anypats(kindpats)

                self.patternspat, pm = _buildmatch(ctx, kindpats, '$',

                                                   listsubrepos, root)

                matchfns.append(pm)

        if not matchfns:

            m = util.always

            self._always = True

        elif len(matchfns) == 1:

            m = matchfns[0]

        else:

            def m(f):

                for matchfn in matchfns:

                    if not matchfn(f):

                        return False

                return True

        self.matchfn = m

        self._fileroots = set(self._files)

    def __call__(self, fn):

        return self.matchfn(fn)

    def __iter__(self):

        for f in self._files:

            yield f

    # Callbacks related to how the matcher is used by dirstate.walk.

    # Subscribers to these events must monkeypatch the matcher object.

    def bad(self, f, msg):

        '''Callback from dirstate.walk for each explicit file that can't be

        found/accessed, with an error message.'''

        pass

    # If an explicitdir is set, it will be called when an explicitly listed

    # directory is visited.

    explicitdir = None

    # If an traversedir is set, it will be called when a directory discovered

    # by recursive traversal is visited.

    traversedir = None

    def abs(self, f):

        '''Convert a repo path back to path that is relative to the root of the

        matcher.'''

        return f

    def rel(self, f):

        '''Convert repo path back to path that is relative to cwd of matcher.'''

        return util.pathto(self._root, self._cwd, f)

    def uipath(self, f):

        '''Convert repo path to a display path.  If patterns or -I/-X were used

        to create this matcher, the display path will be relative to cwd.

        Otherwise it is relative to the root of the repo.'''

        return (self._pathrestricted and self.rel(f)) or self.abs(f)

    def files(self):

        '''Explicitly listed files or patterns or roots:

        if no patterns or .always(): empty list,

        if exact: list exact files,

        if not .anypats(): list all files and dirs,

        else: optimal roots'''

        return self._files

    @propertycache

    def _dirs(self):

        return set(util.dirs(self._fileroots)) | set(['.'])

    def visitdir(self, dir):

        '''Decides whether a directory should be visited based on whether it

        has potential matches in it or one of its subdirectories. This is

        based on the match's primary, included, and excluded patterns.

        Returns the string 'all' if the given directory and all subdirectories

        should be visited. Otherwise returns True or False indicating whether

        the given directory should be visited.

        This function's behavior is undefined if it has returned False for

        one of the dir's parent directories.

        '''

        if self.prefix() and dir in self._fileroots:

            return 'all'

        if dir in self._excluderoots:

            return False

            '.' not in self._includeroots and

            dir not in self._includeroots and

            dir not in self._includedirs and

            not any(parent in self._includeroots

                    for parent in util.finddirs(dir))):

            return False

        return (not self._fileroots or

                '.' in self._fileroots or

                dir in self._fileroots or

                dir in self._dirs or

                any(parentdir in self._fileroots

                    for parentdir in util.finddirs(dir)))

    def exact(self, f):

        '''Returns True if f is in .files().'''

        return f in self._fileroots

    def anypats(self):

        '''Matcher uses patterns or include/exclude.'''

        return self._anypats

    def always(self):

        '''Matcher will match everything and .files() will be empty

        - optimization might be possible and necessary.'''

        return self._always

    def ispartial(self):

        '''True if the matcher won't always match.

        Although it's just the inverse of _always in this implementation,

        an extension such as narrowhg might make it return something

        slightly different.'''

        return not self._always

    def isexact(self):

        return self.matchfn == self.exact

    def prefix(self):

        return not self.always() and not self.isexact() and not self.anypats()

    def _normalize(self, patterns, default, root, cwd, auditor):

        '''Convert 'kind:pat' from the patterns list to tuples with kind and

        normalized and rooted patterns and with listfiles expanded.'''

        kindpats = []

        for kind, pat in [_patsplit(p, default) for p in patterns]:

            if kind in ('glob', 'relpath'):

                pat = pathutil.canonpath(root, cwd, pat, auditor)

            elif kind in ('relglob', 'path', 'rootfilesin'):

                pat = util.normpath(pat)

            elif kind in ('listfile', 'listfile0'):

                try:

                    files = util.readfile(pat)

                    if kind == 'listfile0':

                        files = files.split('\0')

                    else:

                        files = files.splitlines()

                    files = [f for f in files if f]

                except EnvironmentError:

                    raise error.Abort(_("unable to read file list (%s)") % pat)

                for k, p, source in self._normalize(files, default, root, cwd,

                                                    auditor):

                    kindpats.append((k, p, pat))

                continue

            elif kind == 'include':

                try:

                    fullpath = os.path.join(root, util.localpath(pat))

                    includepats = readpatternfile(fullpath, self._warn)

                    for k, p, source in self._normalize(includepats, default,

                                                        root, cwd, auditor):

                        kindpats.append((k, p, source or pat))

                except error.Abort as inst:

                    raise error.Abort('%s: %s' % (pat, inst[0]))

                except IOError as inst:

                    if self._warn:

                        self._warn(_("skipping unreadable pattern file "

                                     "'%s': %s\n") % (pat, inst.strerror))

                continue

            # else: re or relre - which cannot be normalized

            kindpats.append((kind, pat, ''))

        return kindpats

def exact(root, cwd, files, badfn=None):

    return match(root, cwd, files, exact=True, badfn=badfn)

def always(root, cwd):

    return match(root, cwd, [])

def badmatch(match, badfn):

    """Make a copy of the given matcher, replacing its bad method with the given

    one.

    """

    m = copy.copy(match)

    m.bad = badfn

    return m

class subdirmatcher(match):

    """Adapt a matcher to work on a subdirectory only.

    The paths are remapped to remove/insert the path as needed:

    >>> m1 = match('root', '', ['a.txt', 'sub/b.txt'])

    >>> m2 = subdirmatcher('sub', m1)

    >>> bool(m2('a.txt'))

    False

    >>> bool(m2('b.txt'))

    True

    >>> bool(m2.matchfn('a.txt'))

    False

    >>> bool(m2.matchfn('b.txt'))

    True

    >>> m2.files()

    ['b.txt']

    >>> m2.exact('b.txt')

    True

    >>> util.pconvert(m2.rel('b.txt'))

    'sub/b.txt'

    >>> def bad(f, msg):

    ...     print "%s: %s" % (f, msg)

    >>> m1.bad = bad

    >>> m2.bad('x.txt', 'No such file')

    sub/x.txt: No such file

    >>> m2.abs('c.txt')

    'sub/c.txt'

    """

    def __init__(self, path, matcher):

        self._root = matcher._root

        self._cwd = matcher._cwd

        self._path = path

        self._matcher = matcher