moin-2.0 / build / lib / MoinMoin / util /

# Copyright: 2000-2004 Juergen Hermann <>
# Copyright: 2004 by Florian Festi
# Copyright: 2006 by Mikko Virkkil
# Copyright: 2005-2010 MoinMoin:ThomasWaldmann
# Copyright: 2007 MoinMoin:ReimarBauer
# Copyright: 2008 MoinMoin:ChristopherDenter
# License: GNU GPL v2 (or any later version), see LICENSE.txt for details.

    MoinMoin - plugin loader

import os, sys
import imp
import hashlib

from MoinMoin import error
from MoinMoin.util import pysupport
from MoinMoin.util.mimetype import MimeType

class PluginError(Exception):
    """ Base class for plugin errors """

class PluginMissingError(PluginError):
    """ Raised when a plugin is not found """

class PluginAttributeError(PluginError):
    """ Raised when plugin does not contain an attribtue """

def importPlugin(cfg, kind, name, function="execute"):
    """ Import wiki or builtin plugin

    Returns <function> attr from a plugin module <name>.
    If <function> attr is missing, raise PluginAttributeError.
    If <function> is None, return the whole module object.

    If <name> plugin can not be imported, raise PluginMissingError.

    kind may be one of 'action', 'macro' or any other
    directory that exist in MoinMoin or data/plugin.

    Wiki plugins will always override builtin plugins. If you want
    specific plugin, use either importWikiPlugin or importBuiltinPlugin

    :param cfg: wiki config instance
    :param kind: what kind of module we want to import
    :param name: the name of the module
    :param function: the function name
    :rtype: any object
    :returns: "function" of module "name" of kind "kind", or None
        return importWikiPlugin(cfg, kind, name, function)
    except PluginMissingError:
        return importBuiltinPlugin(kind, name, function)

def importWikiPlugin(cfg, kind, name, function="execute"):
    """ Import plugin from the wiki data directory

    See importPlugin docstring.
    plugins = wikiPlugins(kind, cfg)
    modname = plugins.get(name, None)
    if modname is None:
        raise PluginMissingError()
    moduleName = '{0}.{1}'.format(modname, name)
    return importNameFromPlugin(moduleName, function)

def importBuiltinPlugin(kind, name, function="execute"):
    """ Import builtin plugin from MoinMoin package

    See importPlugin docstring.
    if not name in builtinPlugins(kind):
        raise PluginMissingError()
    moduleName = 'MoinMoin.{0}.{1}'.format(kind, name)
    return importNameFromPlugin(moduleName, function)

def importNameFromPlugin(moduleName, name):
    """ Return <name> attr from <moduleName> module,
        raise PluginAttributeError if name does not exist.

        If name is None, return the <moduleName> module object.
    if name is None:
        fromlist = []
        fromlist = [name]
    module = __import__(moduleName, globals(), {}, fromlist)
    if fromlist:
        # module has the obj for module <moduleName>
            return getattr(module, name)
        except AttributeError:
            raise PluginAttributeError
        # module now has the toplevel module of <moduleName> (see __import__ docs!)
        components = moduleName.split('.')
        for comp in components[1:]:
            module = getattr(module, comp)
        return module

def builtinPlugins(kind):
    """ Gets a list of modules in MoinMoin.'kind'

    :param kind: what kind of modules we look for
    :rtype: list
    :returns: module names
    modulename = "MoinMoin." + kind
    return pysupport.importName(modulename, "modules")

def wikiPlugins(kind, cfg):
    Gets a dict containing the names of all plugins of <kind>
    as the key and the containing module name as the value.

    :param kind: what kind of modules we look for
    :rtype: dict
    :returns: plugin name to containing module name mapping
    # short-cut if we've loaded the dict already
    # (or already failed to load it)
    cache = cfg._site_plugin_lists
    if kind in cache:
        result = cache[kind]
        result = {}
        for modname in cfg._plugin_modules:
                module = pysupport.importName(modname, kind)
                packagepath = os.path.dirname(module.__file__)
                plugins = pysupport.getPluginModules(packagepath)
                for p in plugins:
                    if not p in result:
                        result[p] = '{0}.{1}'.format(modname, kind)
            except AttributeError:
        cache[kind] = result
    return result

def getPlugins(kind, cfg):
    """ Gets a list of plugin names of kind

    :param kind: what kind of modules we look for
    :rtype: list
    :returns: module names
    # Copy names from builtin plugins - so we dont destroy the value
    all_plugins = builtinPlugins(kind)[:]

    # Add extension plugins without duplicates
    for plugin in wikiPlugins(kind, cfg):
        if plugin not in all_plugins:

    return all_plugins

def searchAndImportPlugin(cfg, type, name, what=None):
    type2classname = {
    if what is None:
        what = type2classname[type]
    mt = MimeType(name)
    plugin = None
    for module_name in mt.module_name():
            plugin = importPlugin(cfg, type, module_name, what)
        except PluginMissingError:
        raise PluginMissingError("Plugin not found! ({0!r} {1!r} {2!r})".format(type, name, what))
    return plugin

def _loadPluginModule(cfg):
    import all plugin modules

    To be able to import plugin from arbitrary path, we have to load
    the base package once using imp.load_module. Later, we can use
    standard __import__ call to load plugins in this package.

    Since each configured plugin path has unique plugins, we load the
    plugin packages as "moin_plugin_<sha1(path)>.plugin".
    cfg._plugin_modules = []

        # Lock other threads while we check and import
            for pdir in cfg.plugin_dirs:
                csum = 'p_{0}'.format('sha1', pdir).hexdigest())
                modname = '{0}.{1}'.format(cfg.siteid, csum)
                # If the module is not loaded, try to load it
                if not modname in sys.modules:
                    # Find module on disk and try to load - slow!
                    abspath = os.path.abspath(pdir)
                    parent_dir, pname = os.path.split(abspath)
                    fp, path, info = imp.find_module(pname, [parent_dir])
                        # Load the module and set in sys.modules
                        module = imp.load_module(modname, fp, path, info)
                        # XXX for what was this good for?:
                        #setattr(sys.modules[cfg.siteid], 'csum', module)
                        # Make sure fp is closed properly
                        if fp:
                if modname not in cfg._plugin_modules:
    except ImportError as err:
        msg = """
Could not import plugin package "%(path)s" because of ImportError:

Make sure your data directory path is correct, check permissions, and
that the data/plugin directory has an file.
""" % {
    'path': pdir,
    'err': str(err),
        raise error.ConfigurationError(msg)