from django.template.loader import render_to_string
+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 Prelude through self.page.prelude
+def to_prelude (method):
+ def actual (self, *args, **kwds):
+ prelude_method=Prelude.__dict__[method.__name__]
+ return prelude_method(self.page.prelude,*args, **kwds)
+ return actual
class Plugin:
##########
# Constructor
#### mandatory
+ # . 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, title, domid=None,
+ def __init__ (self, page, title, domid=None,
visible=True, togglable=True, toggled=True, **settings):
+ 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
print "%s init dbg .... BEG"%self.classname
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.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):
- # initialize prelude placeholder if needed
- self._init_prelude (request)
# call render_content
plugin_content = self.render_content (request)
# shove this into plugin.html
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 )
- self.add_js_chunks (request, js_init)
+ self.add_js_chunks (js_init)
# interpret the result of requirements ()
self.handle_requirements (request)
print "%s.render_content: END --------------------"%self.classname
return result
- #################### requirements/prelude management
- def _init_prelude (self, request):
- if not hasattr (request, 'plugin_prelude'):
- # include css/plugins.css
- request.plugin_prelude=Prelude(css_files='css/plugin.css')
-
- # can be used directly in render_content()
- def add_js_files (self, request, files):
- self._init_prelude (request)
- request.plugin_prelude.add_js_files (files)
- def add_css_files (self, request, files):
- self._init_prelude (request)
- request.plugin_prelude.add_css_files (files)
- def add_js_chunks (self, request, chunks):
- self._init_prelude (request)
- request.plugin_prelude.add_js_chunks (chunks)
- def add_css_chunks (self, request, chunks):
- self._init_prelude (request)
- request.plugin_prelude.add_css_chunks (chunks)
-
# or from the result of self.requirements()
def handle_requirements (self, request):
try:
if self.need_debug():
print "%s: handling requirement %s"%(self.classname,v)
method_name='add_'+k
- method=Plugin.__dict__[method_name]
- method(self,request,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
traceback.print_exc()
pass
+ #################### requirements/prelude management
+ # just forward to our prelude instance - see decorator above
+ @to_prelude
+ def add_js_files (self):pass
+ @to_prelude
+ def add_css_files (self):pass
+ @to_prelude
+ def add_js_chunks (self):pass
+ @to_prelude
+ def add_css_chunks (self):pass
+
######################################## abstract interface
# your plugin is expected to implement either
# (*) def render_content(self, request) -> html fragment
# 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):
git://git.onelab.eu / unfold.git / blobdiff