##############################################################################
#
# Copyright (c) 2001, 2002, 2003 Zope Corporation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Support for the XML configuration file format

Note, for a detailed description of the way that conflicting
configuration actions are resolved, see the detailed example in
test_includeOverrides in tests/test_xmlconfig.py

$Id: xmlconfig.py 97385 2009-02-28 17:09:17Z nadako $
"""
__docformat__ = 'restructuredtext'

import errno
import os
import sys
import logging
import zope.configuration.config as config

from glob import glob
from xml.sax import make_parser
from xml.sax.xmlreader import InputSource
from xml.sax.handler import ContentHandler, feature_namespaces
from xml.sax import SAXParseException
from zope import schema
from zope.configuration.exceptions import ConfigurationError
from zope.configuration.zopeconfigure import IZopeConfigure, ZopeConfigure
from zope.interface import Interface

logger = logging.getLogger("config")

ZCML_NAMESPACE = "http://namespaces.zope.org/zcml"
ZCML_CONDITION = (ZCML_NAMESPACE, u"condition")


class ZopeXMLConfigurationError(ConfigurationError):
    """Zope XML Configuration error

    These errors are wrappers for other errors. The include configuration
    info and the wrapped error type and value:

    >>> v = ZopeXMLConfigurationError("blah", AttributeError, "xxx")
    >>> print v
    'blah'
        AttributeError: xxx

    """

    def __init__(self, info, etype, evalue):
        self.info, self.etype, self.evalue = info, etype, evalue

    def __str__(self):
        # Only use the repr of the info. This is because we expect to
        # get a parse info and we only want the location information.
        return "%s\n    %s: %s" % (
            `self.info`, self.etype.__name__, self.evalue)

class ZopeSAXParseException(ConfigurationError):
    """Sax Parser errors, reformatted in an emacs friendly way

    >>> v = ZopeSAXParseException("foo.xml:12:3:Not well formed")
    >>> print v
    File "foo.xml", line 12.3, Not well formed

    """

    def __init__(self, v):
        self._v = v

    def __str__(self):
        v = self._v
        s = tuple(str(v).split(':'))
        if len(s) == 4:
            return 'File "%s", line %s.%s, %s' % s
        else:
            return str(v)

class ParserInfo(object):
    """Information about a directive based on parser data

    This includes the directive location, as well as text data
    contained in the directive.

    >>> info = ParserInfo('tests//sample.zcml', 1, 0)
    >>> info
    File "tests//sample.zcml", line 1.0

    >>> print info
    File "tests//sample.zcml", line 1.0

    >>> info.characters("blah\\n")
    >>> info.characters("blah")
    >>> info.text
    u'blah\\nblah'

    >>> info.end(7, 0)
    >>> info
    File "tests//sample.zcml", line 1.0-7.0

    >>> print info
    File "tests//sample.zcml", line 1.0-7.0
      <configure xmlns='http://namespaces.zope.org/zope'>
        <!-- zope.configure -->
        <directives namespace="http://namespaces.zope.org/zope">
          <directive name="hook" attributes="name implementation module"
             handler="zope.configuration.metaconfigure.hook" />
        </directives>
      </configure>


    """

    text = u''

    def __init__(self, file, line, column):
        self.file, self.line, self.column = file, line, column
        self.eline, self.ecolumn = line, column

    def end(self, line, column):
        self.eline, self.ecolumn = line, column

    def __repr__(self):
        if (self.line, self.column) == (self.eline, self.ecolumn):
            return 'File "%s", line %s.%s' % (
                self.file, self.line, self.column)

        return 'File "%s", line %s.%s-%s.%s' % (
            self.file, self.line, self.column, self.eline, self.ecolumn)

    def __str__(self):
        if (self.line, self.column) == (self.eline, self.ecolumn):
            return 'File "%s", line %s.%s' % (
                self.file, self.line, self.column)

        file = self.file
        if file == 'tests//sample.zcml':
            # special case for testing
            file = os.path.join(os.path.dirname(__file__),
                                'tests', 'sample.zcml')

        try:
            f = open(file)
        except IOError:
            src = "  Could not read source."
        else:
            lines = f.readlines()[self.line-1:self.eline]
            ecolumn = self.ecolumn
            if lines[-1][ecolumn:ecolumn+2] == '</':
                # We're pointing to the start of an end tag. Try to find
                # the end
                l = lines[-1].find('>', ecolumn)
                if l >= 0:
                    lines[-1] = lines[-1][:l+1]
            else:
                lines[-1] = lines[-1][:ecolumn+1]

            column = self.column
            if lines[0][:column].strip():
                # Remove text before start if it's noy whitespace
                lines[0] = lines[0][self.column:]

            try:
                src = u''.join([u"  "+l for l in lines])
            except UnicodeDecodeError:
                # XXX:
                # I hope so most internation zcml will use UTF-8 as encoding
                # otherwise this code must be made more clever
                src = u''.join([u"  "+l.decode('utf-8') for l in lines])
                # unicode won't be printable, at least on my console
                src = src.encode('ascii','replace')

        return "%s\n%s" % (`self`, src)

    def characters(self, characters):
        self.text += characters


class ConfigurationHandler(ContentHandler):
    """Interface to the xml parser

    Translate parser events into calls into the configuration system.
    """

    def __init__(self, context, testing=0):
        self.context = context
        self.testing = testing
        self.ignore_depth = 0

    def setDocumentLocator(self, locator):
        self.locator = locator

    def characters(self, text):
        self.context.getInfo().characters(text)

    def startElementNS(self, name, qname, attrs):
        if self.ignore_depth:
            self.ignore_depth += 1
            return

        data = {}
        for (ns, aname), value in attrs.items():
            if ns is None:
                aname = str(aname)
                data[aname] = value
            if (ns, aname) == ZCML_CONDITION:
                # need to process the expression to determine if we
                # use this element and it's descendents
                use = self.evaluateCondition(value)
                if not use:
                    self.ignore_depth = 1
                    return

        info = ParserInfo(
            self.locator.getSystemId(),
            self.locator.getLineNumber(),
            self.locator.getColumnNumber(),
            )

        try:
            self.context.begin(name, data, info)
        except (KeyboardInterrupt, SystemExit):
            raise
        except:
            if self.testing:
                raise
            raise ZopeXMLConfigurationError(info, sys.exc_info()[0],
                sys.exc_info()[1]), None, sys.exc_info()[2]

        self.context.setInfo(info)

    def evaluateCondition(self, expression):
        """Evaluate a ZCML condition.

        `expression` is a string of the form "verb arguments".

        Currently the supported verbs are 'have', 'not-have',
        'installed' and 'not-installed'.

        The 'have' verb takes one argument: the name of a feature.

        >>> from zope.configuration.config import ConfigurationContext
        >>> context = ConfigurationContext()
        >>> context.provideFeature('apidoc')
        >>> c = ConfigurationHandler(context, testing=True)
        >>> c.evaluateCondition("have apidoc")
        True
        >>> c.evaluateCondition("not-have apidoc")
        False
        >>> c.evaluateCondition("have onlinehelp")
        False
        >>> c.evaluateCondition("not-have onlinehelp")
        True

        Ill-formed expressions raise an error

        >>> c.evaluateCondition("want apidoc")
        Traceback (most recent call last):
          ...
        ValueError: Invalid ZCML condition: 'want apidoc'

        >>> c.evaluateCondition("have x y")
        Traceback (most recent call last):
          ...
        ValueError: Only one feature allowed: 'have x y'

        >>> c.evaluateCondition("have")
        Traceback (most recent call last):
          ...
        ValueError: Feature name missing: 'have'


        The 'installed' verb takes one argument: the dotted name of a
        pacakge. If the pacakge is found, in other words, can be imported,
        then the condition will return true.

        >>> from zope.configuration.config import ConfigurationContext
        >>> context = ConfigurationContext()
        >>> c = ConfigurationHandler(context, testing=True)
        >>> c.evaluateCondition('installed zope.interface')
        True
        >>> c.evaluateCondition('not-installed zope.interface')
        False
        >>> c.evaluateCondition('installed zope.foo')
        False
        >>> c.evaluateCondition('not-installed zope.foo')
        True

        Ill-formed expressions raise an error

        >>> c.evaluateCondition("installed foo bar")
        Traceback (most recent call last):
          ...
        ValueError: Only one package allowed: 'installed foo bar'

        >>> c.evaluateCondition("installed")
        Traceback (most recent call last):
          ...
        ValueError: Package name missing: 'installed'
        """
        arguments = expression.split(None)
        verb = arguments.pop(0)

        if verb in ('have', 'not-have'):
            if not arguments:
                raise ValueError("Feature name missing: %r" % expression)
            if len(arguments) > 1:
                raise ValueError("Only one feature allowed: %r" % expression)

            if verb == 'have':
                return self.context.hasFeature(arguments[0])
            elif verb == 'not-have':
                return not self.context.hasFeature(arguments[0])

        elif verb in ('installed', 'not-installed'):
            if not arguments:
                raise ValueError("Package name missing: %r" % expression)
            if len(arguments) > 1:
                raise ValueError("Only one package allowed: %r" % expression)

            try:
                __import__(arguments[0])
                installed = True
            except ImportError:
                installed = False

            if verb == 'installed':
                return installed
            elif verb == 'not-installed':
                return not installed
        else:
            raise ValueError("Invalid ZCML condition: %r" % expression)

    def endElementNS(self, name, qname):
        # If ignore_depth is set, this element will be ignored, even
        # if this this decrements ignore_depth to 0.
        if self.ignore_depth:
            self.ignore_depth -= 1
            return

        info = self.context.getInfo()
        info.end(
            self.locator.getLineNumber(),
            self.locator.getColumnNumber(),
            )

        try:
            self.context.end()
        except (KeyboardInterrupt, SystemExit):
            raise
        except:
            if self.testing:
                raise
            raise ZopeXMLConfigurationError(info, sys.exc_info()[0],
                sys.exc_info()[1]), None, sys.exc_info()[2]


def processxmlfile(file, context, testing=False):
    """Process a configuration file

    See examples in tests/text_xmlconfig.py
    """
    src = InputSource(getattr(file, 'name', '<string>'))
    src.setByteStream(file)
    parser = make_parser()
    parser.setContentHandler(ConfigurationHandler(context, testing=testing))
    parser.setFeature(feature_namespaces, True)
    try:
        parser.parse(src)
    except SAXParseException:
        raise ZopeSAXParseException(sys.exc_info()[1]), None, sys.exc_info()[2]


def openInOrPlain(filename):
    """Open a file, falling back to filename.in.

    If the requested file does not exist and filename.in does, fall
    back to filename.in.  If opening the original filename fails for
    any other reason, allow the failure to propogate.

    For example, the tests/samplepackage dirextory has files:

       configure.zcml
       configure.zcml.in
       foo.zcml.in

    If we open configure.zcml, we'll get that file:

    >>> here = os.path.dirname(__file__)
    >>> path = os.path.join(here, 'tests', 'samplepackage', 'configure.zcml')
    >>> f = openInOrPlain(path)
    >>> f.name[-14:]
    'configure.zcml'

    But if we open foo.zcml, we'll get foo.zcml.in, since there isn't a
    foo.zcml:

    >>> path = os.path.join(here, 'tests', 'samplepackage', 'foo.zcml')
    >>> f = openInOrPlain(path)
    >>> f.name[-11:]
    'foo.zcml.in'

    Make sure other IOErrors are re-raised.  We need to do this in a
    try-except block because different errors are raised on Windows and
    on Linux.

    >>> try:
    ...     f = openInOrPlain('.')
    ... except IOError:
    ...     print "passed"
    ... else:
    ...     print "failed"
    ...
    passed

    """
    try:
        fp = open(filename)
    except IOError, (code, msg):
        if code == errno.ENOENT:
            fn = filename + ".in"
            if os.path.exists(fn):
                fp = open(fn)
            else:
                raise
        else:
            raise
    return fp

class IInclude(Interface):
    """The ``include``, ``includeOverrides`` and ``exclude`` directives

    These directives allows you to include or preserve including of another
    ZCML file in the configuration. This enables you to write configuration
    files in each package and then link them together.
    """

    file = schema.BytesLine(
        title=u"Configuration file name",
        description=u"The name of a configuration file to be included/excluded, "
                    u"relative to the directive containing the "
                    u"including configuration file.",
        required=False,
        )

    files = schema.BytesLine(
        title=u"Configuration file name pattern",
        description=u"""
        The names of multiple configuration files to be included/excluded,
        expressed as a file-name pattern, relative to the directive
        containing the including or excluding configuration file.  The pattern
        can include:

        - ``*`` matches 0 or more characters

        - ``?`` matches a single character

        - ``[<seq>]`` matches any character in seq

        - ``[!<seq>]`` matches any character not in seq

        The file names are included in sorted order, where sorting is
        without regard to case.
        """,
        required=False,
        )

    package = config.fields.GlobalObject(
        title=u"Include or exclude package",
        description=u"""
        Include or exclude the named file (or configure.zcml) from the directory
        of this package.
        """,
        required=False,
        )


def include(_context, file=None, package=None, files=None):
    """Include a zcml file

    See examples in tests/text_xmlconfig.py
    """

    if files:
        if file:
            raise ValueError("Must specify only one of file or files")
    elif not file:
        file = 'configure.zcml'

    # BBB 2006/12/19 -- to be removed after 12 months
    # This is a backward-compatibility support for old site.conf

    if package and (package.__name__ == 'zope.app'):
        try:
            import zope.app.zcmlfiles
        except ImportError:
            pass # maybe this is an old zope without zope.app.zcmlfiles
        else:
            dirpath, filename = os.path.split(file)
            # be careful, because zope.app is a namespace package
            # we can't assume that zcmlfiles is a subdirectory of the 
            # zope.app package
            dirpath = os.path.dirname(zope.app.zcmlfiles.__file__)
            file = os.path.join(dirpath, filename)
            import warnings
            warnings.warn('In configuration file: %s '
                          'replace: <include package="zope.app" /> '
                          'with: <include package="zope.app.zcmlfiles" /> '
                          'This will go away in Zope 3.6.' % os.path.abspath(file),
                          DeprecationWarning,
                          2)

    # This is a tad tricky. We want to behave as a grouping directive.

    context = config.GroupingContextDecorator(_context)
    if package is not None:
        context.package = package
        context.basepath = None

    if files:
        paths = glob(context.path(files))
        paths = zip([path.lower() for path in paths], paths)
        paths.sort()
        paths = [path for (l, path) in paths]
    else:
        paths = [context.path(file)]

    for path in paths:
        if context.processFile(path):
            f = openInOrPlain(path)
            logger.debug("include %s" % f.name)

            context.basepath = os.path.dirname(path)
            context.includepath = _context.includepath + (f.name, )
            _context.stack.append(config.GroupingStackItem(context))

            processxmlfile(f, context)
            f.close()
            assert _context.stack[-1].context is context
            _context.stack.pop()

def exclude(_context, file=None, package=None, files=None):
    """Exclude a zcml file
    
    This directive should be used before any ZML that includes
    configuration you want to exclude.
    """

    if files:
        if file:
            raise ValueError("Must specify only one of file or files")
    elif not file:
        file = 'configure.zcml'


    context = config.GroupingContextDecorator(_context)
    if package is not None:
        context.package = package
        context.basepath = None

    if files:
        paths = glob(context.path(files))
        paths = zip([path.lower() for path in paths], paths)
        paths.sort()
        paths = [path for (l, path) in paths]
    else:
        paths = [context.path(file)]

    for path in paths:
        # processFile returns a boolean indicating if the file has been
        # processed or not, it *also* marks the file as having been processed,
        # here the side effect is used to keep the given file from being
        # processed in the future
        context.processFile(path)

def includeOverrides(_context, file=None, package=None, files=None):
    """Include zcml file containing overrides

    The actions in the included file are added to the context as if they
    were in the including file directly.

    See the detailed example in test_includeOverrides in
    tests/text_xmlconfig.py
    """

    # We need to remember how many actions we had before
    nactions = len(_context.actions)

    # We'll give the new actions this include path
    includepath = _context.includepath

    # Now we'll include the file. We'll munge the actions after
    include(_context, file, package, files)

    # Now we'll grab the new actions, resolve conflicts,
    # and munge the includepath:
    newactions = []
    for action in config.resolveConflicts(_context.actions[nactions:]):
        (discriminator, callable, args, kw, oldincludepath, info, order
         ) = config.expand_action(*action)
        newactions.append(
            (discriminator, callable, args, kw, includepath, info, order)
            )

    # and replace the new actions with the munched new actions:
    _context.actions[nactions:] = newactions

def registerCommonDirectives(context):
    # We have to use the direct definition functions to define
    # a directive for all namespaces.

    config.defineSimpleDirective(
        context, "include", IInclude, include, namespace="*")

    config.defineSimpleDirective(
        context, "exclude", IInclude, exclude, namespace="*")

    config.defineSimpleDirective(
        context, "includeOverrides", IInclude, includeOverrides, namespace="*")

    config.defineGroupingDirective(
        context,
        name="configure",
        namespace="*",
        schema=IZopeConfigure,
        handler=ZopeConfigure,
        )

def file(name, package=None, context=None, execute=True):
    """Execute a zcml file
    """

    if context is None:
        context = config.ConfigurationMachine()
        registerCommonDirectives(context)
        context.package = package

    include(context, name, package)
    if execute:
        context.execute_actions()

    return context

def string(s, context=None, name="<string>", execute=True):
    """Execute a zcml string
    """
    from StringIO import StringIO

    if context is None:
        context = config.ConfigurationMachine()
        registerCommonDirectives(context)

    f = StringIO(s)
    f.name = name
    processxmlfile(f, context)

    if execute:
        context.execute_actions()

    return context


##############################################################################
# Backward compatability, mainly for tests


_context = None
def _clearContext():
    global _context
    _context = config.ConfigurationMachine()
    registerCommonDirectives(_context)

def _getContext():
    global _context
    if _context is None:
        _clearContext()
        try:
            from zope.testing.cleanup import addCleanUp
        except ImportError:
            pass
        else:
            addCleanUp(_clearContext)
            del addCleanUp
    return _context

class XMLConfig(object):
    """Provide high-level handling of configuration files.

    See examples in tests/text_xmlconfig.py
    """

    def __init__(self, file_name, module=None):
        context = _getContext()
        include(context, file_name, module)
        self.context = context

    def __call__(self):
        self.context.execute_actions()

def xmlconfig(file, testing=False):
    context = _getContext()
    processxmlfile(file, context, testing=testing)
    context.execute_actions(testing=testing)


def testxmlconfig(file, context=None):
    """xmlconfig that doesn't raise configuration errors

    This is useful for testing, as it doesn't mask exception types.
    """
    context = _getContext()
    processxmlfile(file, context, testing=True)
    context.execute_actions(testing=True)

