X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=engine%2Fplugin.py;h=2088c2702254086043f239543c281e7450268edd;hb=6c8063e1fcffee77e26340ec6c5143d434c2306a;hp=00b37b7cab33256e2ec18780b07d6675265abe40;hpb=fcebef2a30c4061ef8b7e302ad9e88554ed6803a;p=unfold.git diff --git a/engine/plugin.py b/engine/plugin.py index 00b37b7c..2088c270 100644 --- a/engine/plugin.py +++ b/engine/plugin.py @@ -6,7 +6,7 @@ import json from django.template.loader import render_to_string -from engine.pluginset import PluginSet +from engine.page import Page from engine.prelude import Prelude #################### @@ -16,13 +16,13 @@ from engine.prelude import Prelude # . True : to debug all plugin DEBUG= False -#DEBUG= [ 'SimpleList' ] +#DEBUG= [ 'SliceList' ] -# decorator to deflect calls on Plugin to its PluginSet +# decorator to deflect calls on Plugin to its Prelude through self.page.prelude def to_prelude (method): def actual (self, *args, **kwds): prelude_method=Prelude.__dict__[method.__name__] - return prelude_method(self.pluginset.prelude,*args, **kwds) + return prelude_method(self.page.prelude,*args, **kwds) return actual class Plugin: @@ -39,7 +39,7 @@ class Plugin: ########## # Constructor #### mandatory - # . pluginset: the context of the request being served + # . page: the context of the request being served # . title: is used visually for displaying the widget #### optional # . togglable: whether it can be turned on and off (like PleKitToggle) @@ -55,13 +55,15 @@ class Plugin: # p=Plugin(foo='bar') # which will result in 'foo' being accessible to the template engine # - def __init__ (self, pluginset, title, domid=None, + def __init__ (self, page, title, domid=None, visible=True, togglable=True, toggled=True, **settings): - self.pluginset = pluginset + self.page = page self.title=title + # callers can provide their domid for css'ing if not domid: domid=Plugin.newdomid() self.domid=domid - self.classname=self._classname() + self.classname=self._py_classname() + self.plugin_classname=self._js_classname() self.visible=visible self.togglable=togglable self.toggled=toggled @@ -75,12 +77,16 @@ class Plugin: for (k,v) in self.__dict__.items(): print "dbg %s:%s"%(k,v) print "%s init dbg .... END"%self.classname # do this only once the structure is fine - self.pluginset.record_plugin(self) + self.page.record_plugin(self) - def _classname (self): + def _py_classname (self): try: return self.__class__.__name__ except: return 'Plugin' + def _js_classname (self): + try: return self.plugin_classname () + except: return self._py_classname() + ########## def need_debug (self): if not DEBUG: return False @@ -111,6 +117,11 @@ class Plugin: result += "}" return result + # as a first approximation, only plugins that are associated with a query + # need to be prepared for js - others just get displayed and that's it + def is_asynchroneous (self): + return 'query' in self.__dict__ + # returns the html code for that plugin # in essence, wraps the results of self.render_content () def render (self, request): @@ -122,9 +133,8 @@ class Plugin: env.update(self.__dict__) result = render_to_string ('plugin.html',env) - # as a first approximation we're only concerned with plugins that are associated with a query - # other simpler plugins that only deal with layout do not need this - if 'query' in self.__dict__: + # export this only for relevant plugins + if self.is_asynchroneous(): env ['settings_json' ] = self.settings_json() # compute plugin-specific initialization js_init = render_to_string ( 'plugin-setenv.js', env ) @@ -161,9 +171,10 @@ class Plugin: for (k,v) in d.iteritems(): if self.need_debug(): print "%s: handling requirement %s"%(self.classname,v) + # e.g. js_files -> add_js_files method_name='add_'+k - method=PluginSet.__dict__[method_name] - method(self.pluginset,v) + method=Page.__dict__[method_name] + method(self.page,v) except AttributeError: # most likely the object does not have that method defined, which is fine pass @@ -173,7 +184,7 @@ class Plugin: pass #################### requirements/prelude management - # just forward to self.pluginset - see decorator above + # just forward to our prelude instance - see decorator above @to_prelude def add_js_files (self):pass @to_prelude @@ -221,3 +232,5 @@ class Plugin: # also 'query_uuid' gets replaced with query.uuid def json_settings_list (self): return ['json_settings_list-must-be-redefined'] + # might also define this one; see e.g. slicelist.py that piggybacks simplelist js code + # def plugin_classname (self):