from django.template.loader import render_to_string
+from engine.page import Page
from engine.prelude import Prelude
-class Plugin:
+####################
+# set DEBUG to
+# . False : silent
+# . [ 'SliceList', 'TabbedView' ] : to debug these classes
+# . True : to debug all plugin
+
+DEBUG= False
+DEBUG= [ 'QuickFilter' ]
- uid=0
+# 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
- def __init__ (self, visible=True, hidable=True, hidden_by_default=False, **settings):
- # xxx should generate some random id
- self.uuid=Plugin.uid
- Plugin.uid += 1
+class Plugin:
+
+ # using a simple incremental scheme to generate domids for now
+ # we just need this to be unique in a page
+ domid=0
+
+ @staticmethod
+ def newdomid():
+ Plugin.domid += 1
+ return "plugin-%d"%Plugin.domid
+
+ ##########
+ # 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)
+ # . 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
+ # . 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, 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._py_classname()
+ self.plugin_classname=self._js_classname()
self.visible=visible
- self.hidable=hidable
- self.hidden_by_default=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._settings=settings
-# print "Created plugin with settings %s"%self._settings.keys()
-
- def classname (self):
+ 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 "%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 _py_classname (self):
try: return self.__class__.__name__
except: return 'Plugin'
- # shorthands to inspect _settings
- def get_setting (self, setting, default):
- if setting not in self._settings: return default
- else: return self._settings[setting]
+ def _js_classname (self):
+ try: return self.plugin_classname ()
+ except: return self._py_classname()
+
+ ##########
+ def need_debug (self):
+ if not DEBUG: return False
+ if DEBUG is True: return True
+ 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
- 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
+ # as a first approximation, only plugins that are associated with a query
+ # need to be prepared for js - meaning their json settings get exposed to js
+ # others just get displayed and that's it
+ def export_json_settings (self):
+ return 'query' in self.__dict__
+
+ def start_with_spin (self):
+ return self.export_json_settings()
# 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)
-
# 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 ('widget-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:
- import traceback
- traceback.print_exc()
- pass
+ # shove this into plugin.html
+ env = {}
+ env ['plugin_content']= plugin_content
+ # need_spin is used in plugin.html
+ self.need_spin=self.start_with_spin()
+ env.update(self.__dict__)
+ result = render_to_string ('plugin.html',env)
+
+ # export this only for relevant plugins
+ if self.export_json_settings():
+ env ['settings_json' ] = self.settings_json()
+ # compute plugin-specific initialization
+ js_init = render_to_string ( 'plugin-setenv.js', env )
+ self.add_js_chunks (js_init)
+
+ # interpret the result of requirements ()
+ self.handle_requirements (request)
return result
# you may redefine this completely, but if you don't we'll just use methods
- # . template() to find out which template to use, and
- # . render_env() to compute a dictionary to pass along to the templating system
+ # . template_file() to find out which template to use, and
+ # . template_env() to compute a dictionary to pass along to the templating system
def render_content (self, request):
"""Should return an HTML fragment"""
- template = self.template()
- env=self.render_env(request)
+ template = self.template_file()
+ env=self.template_env(request)
if not isinstance (env,dict):
- raise Exception, "%s.render_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)
- print "%s.render_content: BEG --------------------"%self.classname()
- print "env=%s"%env.keys()
- print result
- print "%s.render_content: END --------------------"%self.classname()
+ if self.need_debug():
+ print "%s.render_content: BEG --------------------"%self.classname
+ print "template=%s"%template
+ 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):
- if not hasattr (request, 'plugin_prelude'):
- request.plugin_prelude=Prelude()
-
- def inspect_request (self, request, message):
- has=hasattr(request,'plugin_prelude')
- get=getattr(request,'plugin_prelude','none-defined')
- print "INSPECT (%s), hasattr %s, getattr %s"%(message,has,get)
-
- # can be used directly in render_content()
- def add_js_files (self, request, files):
- self._init_request (request)
- request.plugin_prelude.add_js_files (files)
- def add_css_files (self, request, files):
- self._init_request (request)
- request.plugin_prelude.add_css_files (files)
- def add_js_chunks (self, request, chunks):
- self._init_request (request)
- request.plugin_prelude.add_js_chunks (chunks)
- def add_css_chunks (self, request, chunks):
- self._init_request (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():
- 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)
+ # e.g. js_files -> add_js_files
+ method_name='add_'+k
+ 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
+ except:
+ import traceback
+ traceback.print_exc()
+ pass
- ######################################## abstract interface
- def title (self): return "you should redefine title()"
+ #################### 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
# -- or --
- # (*) def template(self) -> filename
+ # (*) def template_file (self) -> filename
# relative to STATIC
- # (*) def render_env (self, request) -> dict
+ # (*) 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() code is not kicking in
- def template (self): return "undefined_template"
- def render_env (self, request): return {}
+ # 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 {}
# # 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']
+
+ # might also define these ones:
+ #
+ # see e.g. slicelist.py that piggybacks simplelist js code
+ # def plugin_classname (self)
+ #
+ # whether we export the json settings to js
+ # def export_json_settings (self)
+ #
+ # whether we show an initial spinner
+ # def start_with_spin (self)
git://git.onelab.eu / unfold.git / blobdiff