from django.template.loader import render_to_string
-from engine.pluginset import PluginSet
+from engine.page import Page
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:
##########
# 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)
# 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
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
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):
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 )
if self.need_debug():
print "%s: handling requirement %s"%(self.classname,v)
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
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
# 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):