# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.

# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr

#

# This file is part of CubicWeb.

#

# CubicWeb is free software: you can redistribute it and/or modify it under the

# terms of the GNU Lesser General Public License as published by the Free

# Software Foundation, either version 2.1 of the License, or (at your option)

# any later version.

#

# CubicWeb is distributed in the hope that it will be useful, but WITHOUT

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more

# details.

#

# You should have received a copy of the GNU Lesser General Public License along

# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.

"""

* the vregistry handles various types of objects interacting

  together. The vregistry handles registration of dynamically loaded

  objects and provides a convenient api to access those objects

  according to a context

* to interact with the vregistry, objects should inherit from the

  AppObject abstract class

* the selection procedure has been generalized by delegating to a

  selector, which is responsible to score the appobject according to the

  current state (req, rset, row, col). At the end of the selection, if

  a appobject class has been found, an instance of this class is

  returned. The selector is instantiated at appobject registration

__docformat__ = "restructuredtext en"

import sys

from os import listdir, stat

from os.path import dirname, join, realpath, isdir, exists

from logging import getLogger

from warnings import warn

from logilab.common.deprecation import deprecated, class_moved

from logilab.common.logging_ext import set_log_methods

from cubicweb import CW_SOFTWARE_ROOT

from cubicweb import RegistryNotFound, ObjectNotFound, NoSelectableObject

from cubicweb.appobject import AppObject

def _toload_info(path, extrapath, _toload=None):

    """return a dictionary of <modname>: <modpath> and an ordered list of

    (file, module name) to load

    """

    from logilab.common.modutils import modpath_from_file

    if _toload is None:

        assert isinstance(path, list)

        _toload = {}, []

    for fileordir in path:

        if isdir(fileordir) and exists(join(fileordir, '__init__.py')):

            subfiles = [join(fileordir, fname) for fname in listdir(fileordir)]

            _toload_info(subfiles, extrapath, _toload)

        elif fileordir[-3:] == '.py':

            modpath = modpath_from_file(fileordir, extrapath)

            # omit '__init__' from package's name to avoid loading that module

            # once for each name when it is imported by some other appobject

            # module. This supposes import in modules are done as::

            #

            #   from package import something

            #

            # not::

            #

            #  from package.__init__ import something

            #

            # which seems quite correct.

            if modpath[-1] == '__init__':

                modpath.pop()

            modname = '.'.join(modpath)

            _toload[0][modname] = fileordir

            _toload[1].append((fileordir, modname))

    return _toload

def classid(cls):

    """returns a unique identifier for an appobject class"""

    return '%s.%s' % (cls.__module__, cls.__name__)

def class_regid(cls):

    """returns a unique identifier for an appobject class"""

    if 'id' in cls.__dict__:

        warn('[3.6] %s.%s: id is deprecated, use __regid__'

             % (cls.__module__, cls.__name__), DeprecationWarning)

        cls.__regid__ = cls.id

    if hasattr(cls, 'id') and not isinstance(cls.id, property):

        return cls.id

    return cls.__regid__

def class_registries(cls, registryname):

    if registryname:

        return (registryname,)

    return cls.__registries__

class Registry(dict):

    def __init__(self, config):

        super(Registry, self).__init__()

        self.config = config

    def __getitem__(self, name):

        """return the registry (dictionary of class objects) associated to

        this name

        """

        try:

            return super(Registry, self).__getitem__(name)

        except KeyError:

            raise ObjectNotFound(name), None, sys.exc_info()[-1]

    def initialization_completed(self):

        for appobjects in self.itervalues():

            for appobjectcls in appobjects:

                appobjectcls.__registered__(self)

    def register(self, obj, oid=None, clear=False):

        """base method to add an object in the registry"""

        assert not '__abstract__' in obj.__dict__

        oid = oid or class_regid(obj)

        assert oid

        if clear:

            appobjects = self[oid] =  []

        else:

            appobjects = self.setdefault(oid, [])

        assert not obj in appobjects, \

               'object %s is already registered' % obj

        appobjects.append(obj)

    def register_and_replace(self, obj, replaced):

        # XXXFIXME this is a duplication of unregister()

        # remove register_and_replace in favor of unregister + register

        # or simplify by calling unregister then register here

        if not isinstance(replaced, basestring):

            replaced = classid(replaced)

        registered_objs = self.get(class_regid(obj), ())

        for index, registered in enumerate(registered_objs):

            if classid(registered) == replaced:

                del registered_objs[index]

                break

        else:

            self.warning('trying to replace an unregistered view %s by %s',

                         replaced, obj)

        self.register(obj)

    def unregister(self, obj):

        clsid = classid(obj)

        oid = class_regid(obj)

        for registered in self.get(oid, ()):

            # use classid() to compare classes because vreg will probably

            # have its own version of the class, loaded through execfile

            if classid(registered) == clsid:

                self[oid].remove(registered)

                break

        else:

            self.warning('can\'t remove %s, no id %s in the registry',

                         clsid, oid)

    def all_objects(self):

        """return a list containing all objects in this registry.

        """

        result = []

        for objs in self.values():

            result += objs

        return result

    # dynamic selection methods ################################################

    def object_by_id(self, oid, *args, **kwargs):

        """return object with the `oid` identifier. Only one object is expected

        to be found.

        raise :exc:`ObjectNotFound` if not object with id <oid> in <registry>

        raise :exc:`AssertionError` if there is more than one object there

        """

        objects = self[oid]

        assert len(objects) == 1, objects

        return objects[0](*args, **kwargs)

    def select(self, oid, *args, **kwargs):

        """return the most specific object among those with the given oid

        according to the given context.

        raise :exc:`ObjectNotFound` if not object with id <oid> in <registry>

        raise :exc:`NoSelectableObject` if not object apply

        """

        return self._select_best(self[oid], *args, **kwargs)

    def select_or_none(self, oid, *args, **kwargs):

        """return the most specific object among those with the given oid

        according to the given context, or None if no object applies.

        """

        try:

            return self.select(oid, *args, **kwargs)

        except (NoSelectableObject, ObjectNotFound):

            return None

    select_object = deprecated('[3.6] use select_or_none instead of select_object'

                               )(select_or_none)

    def possible_objects(self, *args, **kwargs):

        """return an iterator on possible objects in this registry for the given

        context

        """

        for appobjects in self.itervalues():

            try:

                yield self._select_best(appobjects, *args, **kwargs)

            except NoSelectableObject:

                continue

    def _select_best(self, appobjects, *args, **kwargs):

        """return an instance of the most specific object according

        to parameters

        raise `NoSelectableObject` if not object apply

        """

        if len(args) > 1:

            warn('[3.5] only the request param can not be named when calling select*',

                 DeprecationWarning, stacklevel=3)

        score, winners = 0, None

        for appobject in appobjects:

            appobjectscore = appobject.__select__(appobject, *args, **kwargs)

            if appobjectscore > score:

                score, winners = appobjectscore, [appobject]

            elif appobjectscore > 0 and appobjectscore == score:

                winners.append(appobject)

        if winners is None:

            raise NoSelectableObject('args: %s\nkwargs: %s %s'

                                     % (args, kwargs.keys(),

                                        [repr(v) for v in appobjects]))

        if len(winners) > 1:

            # log in production environement, error while debugging

            if self.config.debugmode:

                raise Exception('select ambiguity, args: %s\nkwargs: %s %s'

                                % (args, kwargs.keys(),

                                   [repr(v) for v in winners]))

            self.error('select ambiguity, args: %s\nkwargs: %s %s',

                       args, kwargs.keys(), [repr(v) for v in winners])

        # return the result of calling the appobject

        return winners[0](*args, **kwargs)

    select_best = deprecated('[3.6] select_best is now private')(_select_best)

class VRegistry(dict):

    """class responsible to register, propose and select the various

    elements used to build the web interface. Currently, we have templates,

    views, actions and components.

    """

    def __init__(self, config):

        super(VRegistry, self).__init__()

        self.config = config

        # need to clean sys.path this to avoid import confusion pb (i.e.  having

        # the same module loaded as 'cubicweb.web.views' subpackage and as

        # views' or 'web.views' subpackage. This is mainly for testing purpose,

        # we should'nt need this in production environment

        for webdir in (join(dirname(realpath(__file__)), 'web'),

                       join(dirname(__file__), 'web')):

            if webdir in sys.path:

                sys.path.remove(webdir)

        if CW_SOFTWARE_ROOT in sys.path:

            sys.path.remove(CW_SOFTWARE_ROOT)

    def reset(self):

        # don't use self.clear, we want to keep existing subdictionaries

        for subdict in self.itervalues():

            subdict.clear()

        self._lastmodifs = {}

    def __getitem__(self, name):

        """return the registry (dictionary of class objects) associated to

        this name

        """

        try:

            return super(VRegistry, self).__getitem__(name)

        except KeyError:

            raise RegistryNotFound(name), None, sys.exc_info()[-1]

    # dynamic selection methods ################################################

    @deprecated('[3.4] use vreg[registry].object_by_id(oid, *args, **kwargs)')

    def object_by_id(self, registry, oid, *args, **kwargs):

        """return object in <registry>.<oid>

        raise `ObjectNotFound` if not object with id <oid> in <registry>

        raise `AssertionError` if there is more than one object there

        """

        return self[registry].object_by_id(oid)

    @deprecated('[3.4] use vreg[registry].select(oid, *args, **kwargs)')

    def select(self, registry, oid, *args, **kwargs):

        """return the most specific object in <registry>.<oid> according to

        the given context

        raise `ObjectNotFound` if not object with id <oid> in <registry>

        raise `NoSelectableObject` if not object apply

        """

        return self[registry].select(oid, *args, **kwargs)

    @deprecated('[3.4] use vreg[registry].select_or_none(oid, *args, **kwargs)')

    def select_object(self, registry, oid, *args, **kwargs):

        """return the most specific object in <registry>.<oid> according to

        the given context, or None if no object apply

        """

        return self[registry].select_or_none(oid, *args, **kwargs)

    @deprecated('[3.4] use vreg[registry].possible_objects(*args, **kwargs)')

    def possible_objects(self, registry, *args, **kwargs):

        """return an iterator on possible objects in <registry> for the given

        context

        """

        return self[registry].possible_objects(*args, **kwargs)

    # methods for explicit (un)registration ###################################

    # default class, when no specific class set

    REGISTRY_FACTORY = {None: Registry}

    def registry_class(self, regid):

        try:

            return self.REGISTRY_FACTORY[regid]

        except KeyError:

            return self.REGISTRY_FACTORY[None]

    def setdefault(self, regid):

        try:

            return self[regid]

        except KeyError:

            self[regid] = self.registry_class(regid)(self.config)

            return self[regid]

#     def clear(self, key):

#         regname, oid = key.split('.')

#         self[regname].pop(oid, None)

    def register_all(self, objects, modname, butclasses=()):

        """register all `objects` given. Objects which are not from the module

        `modname` or which are in `butclasses` won't be registered.

        Typical usage is:

        .. sourcecode:: python

            vreg.register_all(globals().values(), __name__, (ClassIWantToRegisterExplicitly,))

        So you get partially automatic registration, keeping manual registration

        for some object (to use

        :meth:`~cubicweb.cwvreg.CubicWebRegistry.register_and_replace` for

        instance)

        """

        for obj in objects:

            try:

                if obj.__module__ != modname or obj in butclasses:

                    continue

                oid = class_regid(obj)

            except AttributeError:

                continue

            if oid and not '__abstract__' in obj.__dict__:

                self.register(obj, oid=oid)

    def register(self, obj, registryname=None, oid=None, clear=False):

        """register `obj` application object into `registryname` or

        `obj.__registry__` if not specified, with identifier `oid` or

        `obj.__regid__` if not specified.

        If `clear` is true, all objects with the same identifier will be

        previously unregistered.

        """

        assert not '__abstract__' in obj.__dict__

        try:

            vname = obj.__name__

        except AttributeError:

            # XXX may occurs?

            vname = obj.__class__.__name__

        for registryname in class_registries(obj, registryname):

            registry = self.setdefault(registryname)

            registry.register(obj, oid=oid, clear=clear)

            self.debug('registered appobject %s in registry %s with id %s',