Back to index

plone3  3.1.7
plugin.py
Go to the documentation of this file.
00001 # Copyright (c) 2005-2007
00002 # Authors: KSS Project Contributors (see docs/CREDITS.txt)
00003 #
00004 # This program is free software; you can redistribute it and/or modify
00005 # it under the terms of the GNU General Public License version 2 as published
00006 # by the Free Software Foundation.
00007 #
00008 # This program is distributed in the hope that it will be useful,
00009 # but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00011 # GNU General Public License for more details.
00012 #
00013 # You should have received a copy of the GNU General Public License
00014 # along with this program; if not, write to the Free Software
00015 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
00016 # 02111-1307, USA.
00017 
00018 from interfaces import IKSSPlugin
00019 import zope.component as capi
00020 from zope.interface import implements
00021 
00022 class KSSPluginError(Exception):
00023     pass
00024  
00025 def registerPlugin(cls, interface, name, *arg, **kw):
00026     'Convenience method to help registration'
00027     plugin = cls(name, *arg, **kw)
00028     # check if it's registered: do not allow registration for the second name
00029     try:
00030         capi.getUtility(interface, name=name)
00031     except capi.ComponentLookupError:
00032         pass
00033     else:
00034         raise KSSPluginError, 'Duplicate registration attempt for plugin "%s" of type %s' % (plugin.name, interface)
00035     # provide the utility.
00036     capi.provideUtility(plugin, interface, name=name)
00037 
00038 class KSSPlugin(object):
00039     'The base plugin class'
00040 
00041     implements(IKSSPlugin)
00042 
00043     def __init__(self, name, jsfile):
00044         self.name = name
00045         self.jsfile = jsfile