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= False
+DEBUG= [ 'SimpleList' ]
class Plugin:
- # using a simple incremental scheme to generate uuids for now
- uuid=0
+ # using a simple incremental scheme to generate domids for now
+ # we just need this to be unique in a page
+ domid=0
- # xxx should generate some random id
@staticmethod
- def newuuid():
- Plugin.uuid += 1
- return Plugin.uuid
+ def newdomid():
+ Plugin.domid += 1
+ return "plugin-%d"%Plugin.domid
##########
# Constructor
#### mandatory
# . title: is used visually for displaying the widget
- # . name: a simple id suitable for forging css names
#### optional
- # . hidable: whether it can be turned on and off from the UI
- # like e.g. PleKitToggle
- # . hidden_by_default: if hidable, what's the initial status
- # . visible: if not set the plugin does not show up at all,
- # not quite sure what this was for
+ # . togglable: whether it can be turned on and off (like PleKitToggle)
+ # . toggled: if togglable, what's the initial status
+ # . visible: if not set the plugin does not show up at all
+ # (not quite sure what this was for)
#### internal data
- # . uuid: created internally
+ # . domid: created internally, but can be set at creation time if needed
+ # useful for hand-made css, or for selecting an active plugin in a composite
# . rank: this is for plugins sons of a composite plugin
#### custom
# any other setting can also be set when creating the object, like
# p=Plugin(foo='bar')
# which will result in 'foo' being accessible to the template engine
#
- def __init__ (self, title, name,
- visible=True, hidable=True, hidden_by_default=False, **settings):
- # what is in this dictionary will get exposed to template and to javascript
- self._settings=settings
+ def __init__ (self, title, domid=None,
+ visible=True, togglable=True, toggled=True, **settings):
self.title=title
- self.name=name
- self.add_to_settings ( ['title','name'] )
- self.uuid=Plugin.newuuid()
+ if not domid: domid=Plugin.newdomid()
+ self.domid=domid
+ self.classname=self._classname()
self.visible=visible
- self.hidable=hidable
- self.hidden_by_default=hidden_by_default
- self.add_to_settings( ['uuid','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..
+ self.togglable=togglable
+ self.toggled=toggled
+ # what comes from subclasses
+ for (k,v) in settings.iteritems():
+ setattr(self,k,v)
+ if self.need_debug(): print "%s init - subclass setting %s"%(self.classname,k)
+ # minimal debugging
if self.need_debug():
- print "Plugin.__init__ Created plugin with settings %s"%self._settings.keys()
-
- # subclasses might handle some fields in their own way,
- # in which case this call is needed to capture that setting
- # see e.g. SimpleList or SliceList for an example of that
- def add_to_settings (self, setting_name_s):
- if not isinstance (setting_name_s, list):
- self._settings[setting_name_s]=getattr(self,setting_name_s)
- else:
- for setting_name in setting_name_s:
- self._settings[setting_name]=getattr(self,setting_name)
+ 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
- def classname (self):
+ def _classname (self):
try: return self.__class__.__name__
except: return 'Plugin'
- # shorthands to inspect _settings
- def get_setting (self, setting, default=None):
- 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
+
+ def setting_json (self, setting):
+ # TMP: js world expects plugin_uuid
+ if setting=='plugin_uuid':
+ value=self.domid
+ elif setting=='query_uuid':
+ try: value=self.query.uuid
+ except: return '%s:"undefined"'%setting
+ else:
+ value=getattr(self,setting,None)
+ if not value: value = "unknown-setting-%s"%setting
+ # first try to use to_json method (json.dumps not working on class instances)
+ try: value_json=value.to_json()
+ except: value_json=json.dumps(value,separators=(',',':'))
+ return "%s:%s"%(setting,value_json)
+
+ # expose in json format to js the list of fields as described in json_settings_list()
+ # and add plugin_uuid: domid in the mix
+ # NOTE this plugin_uuid thing might occur in js files from joomla/js, ** do not rename **
+ def settings_json (self):
+ result = "{"
+ result += ",".join([ self.setting_json(setting) for setting in self.json_settings_list() ])
+ result += "}"
+ return result
# 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.__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__:
+ 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)
+
+ # 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()
- # expose this class's settings to the template
- # xxx we might need to check that this does not overwrite env..
- env.update(self._settings)
+ raise Exception, "%s.template_env returns wrong type"%self.classname
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
# 'css_chunk': [], # likewise for css scripts
# }
+# # for better performance
+# # you can specify a list of keys that won't be exposed as json attributes
+# def exclude_from_json (self): return []
+
+ # mandatory : define the fields that need to be exposed to json as part of
+ # plugin initialization
+ # mention 'domid' if you need plugin_uuid
+ # also 'query_uuid' gets replaced with query.uuid
+ def json_settings_list (self): return ['json_settings_list-must-be-redefined']
+
git://git.onelab.eu / unfold.git / blobdiff