from engine.prelude import Prelude
-# set to
+####################
+# set DEBUG to
# . False : silent
-# [ 'SliceList', 'TabbedView' ] : to debug these classes
-# True : to debug all slices
+# . [ 'SliceList', 'TabbedView' ] : to debug these classes
+# . True : to debug all plugin
-DEBUG= [ 'SliceList' ]
+DEBUG= [ 'Tabs' ]
class Plugin:
self.name=name
self.add_to_settings ( ['title','name'] )
self.uuid=Plugin.newuuid()
+ self.classname=self._classname()
+ self.add_to_settings ( [ 'uuid', 'classname' ] )
self.visible=visible
self.hidable=hidable
self.hidden_by_default=hidden_by_default
- self.add_to_settings( ['uuid','visible','hidable','hidden_by_default'] )
+ self.add_to_settings( ['visible','hidable','hidden_by_default'] )
# we store as a dictionary the arguments passed to constructor
# e.g. SimpleList (list=[1,2,3]) => _settings = { 'list':[1,2,3] }
# our own settings are not made part of _settings but could be..
for setting_name in setting_name_s:
self._settings[setting_name]=getattr(self,setting_name)
- def classname (self):
+ def _classname (self):
try: return self.__class__.__name__
except: return 'Plugin'
if setting not in self._settings: return default
else: return self._settings[setting]
- def is_visible (self): return self.visible
- def is_hidable (self): return self.hidable
- def is_hidden_by_default (self): return self.hidden_by_default
-
##########
def need_debug (self):
if not DEBUG: return False
if DEBUG is True: return True
- else: return self.classname() in DEBUG
+ else: return self.classname in DEBUG
# returns the html code for that plugin
# in essence, wraps the results of self.render_content ()
def render (self, request):
uuid = self.uuid
- classname = self.classname()
- # initialize prelude placeholder
- self._init_request (request)
-
+ # initialize prelude placeholder if needed
+ self._init_prelude (request)
# call render_content
plugin_content = self.render_content (request)
- # expose _settings in json format to js
- settings_json = json.dumps (self._settings, separators=(',',':'))
-
- result = render_to_string ('plugin.html',
- {'uuid':uuid,
- 'classname':classname,
- 'visible':self.is_visible(),
- 'hidable':self.is_hidable(),
- 'hidden':self.is_hidden_by_default(),
- 'plugin_content' : plugin_content,
- 'settings_json' : settings_json,
- })
-
- # handle requirements() if defined on this class
- try:
- self.handle_requirements (request, self.requirements())
- except AttributeError:
- # most likely the object does not have that method defined, which is fine
- pass
- except:
- import traceback
- traceback.print_exc()
- pass
+ # shove this into plugin.html
+ env = {}
+ env ['plugin_content']= plugin_content
+ env.update(self._settings)
+ result = render_to_string ('plugin.html',env)
+
+ # expose _settings in json format to js, and add plugin_uuid: uuid in the mix
+ js_env = { 'plugin_uuid' : self.uuid }
+ js_env.update (self._settings)
+ settings_json = json.dumps (js_env, separators=(',',':'))
+ env ['settings_json' ] = settings_json
+ # compute plugin-specific initialization
+ js_init = render_to_string ( 'plugin_setenv.js', env )
+ print 'js_init',js_init
+ self.add_js_chunks (request, js_init)
+
+ # interpret the result of requirements ()
+ self.handle_requirements (request)
return result
template = self.template_file()
env=self.template_env(request)
if not isinstance (env,dict):
- raise Exception, "%s.template_env returns wrong type"%self.classname()
+ raise Exception, "%s.template_env returns wrong type"%self.classname
# expose this class's settings to the template
# xxx we might need to check that this does not overwrite env..
env.update(self._settings)
result=render_to_string (template, env)
if self.need_debug():
- print "%s.render_content: BEG --------------------"%self.classname()
+ print "%s.render_content: BEG --------------------"%self.classname
print "template=%s"%template
- print "env=%s"%env.keys()
- # print result
- print "%s.render_content: END --------------------"%self.classname()
+ print "env.keys=%s"%env.keys()
+ #print "env=%s"%env
+ #print result
+ print "%s.render_content: END --------------------"%self.classname
return result
#################### requirements/prelude management
- def _init_request (self, request):
+ 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_request (request)
+ self._init_prelude (request)
request.plugin_prelude.add_js_files (files)
def add_css_files (self, request, files):
- self._init_request (request)
+ self._init_prelude (request)
request.plugin_prelude.add_css_files (files)
def add_js_chunks (self, request, chunks):
- self._init_request (request)
+ self._init_prelude (request)
request.plugin_prelude.add_js_chunks (chunks)
def add_css_chunks (self, request, chunks):
- self._init_request (request)
+ self._init_prelude (request)
request.plugin_prelude.add_css_chunks (chunks)
# or from the result of self.requirements()
- def handle_requirements (self, request, d):
- for (k,v) in d.iteritems():
- 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)
+ def handle_requirements (self, request):
+ try:
+ d=self.requirements()
+ for (k,v) in d.iteritems():
+ 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)
+ except AttributeError:
+ # most likely the object does not have that method defined, which is fine
+ pass
+ except:
+ import traceback
+ traceback.print_exc()
+ pass
######################################## abstract interface
# your plugin is expected to implement either
# (*) def render_content(self, request) -> html fragment
# -- or --
- # (*) def template_file(self) -> filename
+ # (*) def template_file (self) -> filename
# relative to STATIC
# (*) def template_env (self, request) -> dict
# this is the variable->value association used to render the template
# in which case the html template will be used
# if you see this string somewhere your template_file() code is not kicking in
- def template_file (self): return "undefined_template"
- def template_env (self, request): return {}
+ def template_file (self): return "undefined_template"
+ def template_env (self, request): return {}
# # tell the framework about requirements (for the document <header>)
# # the notion of 'Media' in django provides for medium-dependant