hooke/plugin/__init__.py

   1 # Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
   2 #
   3 # This file is part of Hooke.
   4 #
   5 # Hooke is free software: you can redistribute it and/or
   6 # modify it under the terms of the GNU Lesser General Public
   7 # License as published by the Free Software Foundation, either
   8 # version 3 of the License, or (at your option) any later version.
   9 #
  10 # Hooke is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU Lesser General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Lesser General Public
  16 # License along with Hooke.  If not, see
  17 # <http://www.gnu.org/licenses/>.
  18
  19 """The `plugin` module provides optional submodules that add new Hooke
  20 commands.
  21
  22 All of the science happens in here.
  23 """
  24
  25 import ConfigParser as configparser
  26
  27 from ..config import Setting
  28 from ..util.pluggable import IsSubclass, construct_graph
  29
  30
  31 PLUGIN_MODULES = [
  32 #    ('autopeak', True),
  33     ('convfilt', True),
  34     ('cut', True),
  35 #    ('fclamp', True),
  36 #    ('fit', True),
  37 #    ('flatfilts-rolf', True),
  38     ('flatfilt', True),
  39 #    ('jumpstat', True),
  40 #    ('macro', True),
  41 #    ('massanalysis', True),
  42 #    ('multidistance', True),
  43 #    ('multifit', True),
  44 #    ('pcluster', True),
  45 #    ('procplots', True),
  46 #    ('review', True),
  47 #    ('showconvoluted', True),
  48 #    ('superimpose', True),
  49 #    ('tccd', True),
  50 #    ('tutorial', True),
  51     ('vclamp', True),
  52     ]
  53 """List of plugin modules and whether they should be included by
  54 default.  TODO: autodiscovery
  55 """
  56
  57 BUILTIN_MODULES = [
  58     'config',
  59     'curve',
  60     'debug',
  61     'license',
  62     'note',
  63     'playlist',
  64     'playlists',
  65     'system',
  66     ]
  67 """List of builtin modules.  TODO: autodiscovery
  68 """
  69
  70 PLUGIN_SETTING_SECTION = 'plugins'
  71 """Name of the config section which controls plugin selection.
  72 """
  73
  74
  75 # Plugins and settings
  76
  77 class Plugin (object):
  78     """A pluggable collection of Hooke commands.
  79
  80     Fulfills the same role for Hooke that a software package does for
  81     an operating system.
  82     """
  83     def __init__(self, name):
  84         self.name = name
  85         self.setting_section = '%s plugin' % self.name
  86         self.config = {}
  87         self._commands = []
  88
  89     def dependencies(self):
  90         """Return a list of names of :class:`Plugin`\s we require."""
  91         return []
  92
  93     def default_settings(self):
  94         """Return a list of :class:`hooke.config.Setting`\s for any
  95         configurable plugin settings.
  96
  97         The suggested section setting is::
  98
  99             Setting(section=self.setting_section, help=self.__doc__)
 100         """
 101         return []
 102
 103     def commands(self):
 104         """Return a list of :class:`hooke.command.Command`\s provided.
 105         """
 106         return list(self._commands)
 107
 108 class Builtin (Plugin):
 109     """A required collection of Hooke commands.
 110
 111     These "core" plugins provide essential administrative commands
 112     (playlist handling, etc.).
 113     """
 114     pass
 115
 116 # Plugin utility functions
 117
 118 def argument_to_setting(section_name, argument):
 119     """Convert an :class:`~hooke.command.Argument` to a
 120     `~hooke.conf.Setting`.
 121
 122     This is a lossy transition, because
 123     :class:`~hooke.command.Argument`\s store more information than
 124     `~hooke.conf.Setting`\s.
 125     """
 126     return Setting(section_name, option=argument.name, value=argument.default,
 127                    help=argument._help)
 128
 129 # Construct plugin dependency graph and load plugin instances.
 130
 131 PLUGIN_GRAPH = construct_graph(
 132     this_modname=__name__,
 133     submodnames=[name for name,include in PLUGIN_MODULES] + BUILTIN_MODULES,
 134     class_selector=IsSubclass(Plugin, blacklist=[Plugin, Builtin]))
 135 """Topologically sorted list of all possible :class:`Plugin`\s and
 136 :class:`Builtin`\s.
 137 """
 138
 139 def default_settings():
 140     settings = [Setting(PLUGIN_SETTING_SECTION,
 141                         help='Enable/disable default plugins.')]
 142     for pnode in PLUGIN_GRAPH:
 143         if pnode.data.name in BUILTIN_MODULES:
 144             continue # builtin inclusion is not optional
 145         plugin = pnode.data
 146         default_include = [di for mod_name,di in PLUGIN_MODULES
 147                            if mod_name == plugin.name][0]
 148         help = 'Commands: ' + ', '.join([c.name for c in plugin.commands()])
 149         settings.append(Setting(
 150                 section=PLUGIN_SETTING_SECTION,
 151                 option=plugin.name,
 152                 value=str(default_include),
 153                 help=help,
 154                 ))
 155     for pnode in PLUGIN_GRAPH:
 156         plugin = pnode.data
 157         settings.extend(plugin.default_settings())
 158     return settings
 159
 160 def load_graph(graph, config, include_section):
 161     items = []
 162     for node in graph:
 163         item = node.data
 164         try:
 165             include = config.getboolean(include_section, item.name)
 166         except configparser.NoOptionError:
 167             include = True # non-optional include (e.g. a Builtin)
 168         if include == True:
 169             try:
 170                 item.config = dict(config.items(item.setting_section))
 171             except configparser.NoSectionError:
 172                 pass
 173             items.append(item)
 174     return items