X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=engine%2Fplugin.py;h=fc68c48a7ea656e0471f31e8b5987bb42f7dc1e6;hb=a222cef0a10a5517349f05cea0e382b35e3a14a6;hp=5de2d768c9f72bf97d23ab26b7d80623f8465c76;hpb=74c248dcb1d88c9ce7994d4eb02dc5539e77dd62;p=myslice.git diff --git a/engine/plugin.py b/engine/plugin.py index 5de2d768..fc68c48a 100644 --- a/engine/plugin.py +++ b/engine/plugin.py @@ -8,91 +8,145 @@ from django.template.loader import render_to_string from engine.prelude import Prelude -class Plugin: +#################### +# set DEBUG to +# . False : silent +# . [ 'SliceList', 'TabbedView' ] : to debug these classes +# . True : to debug all plugin + +#DEBUG= [ 'Tabs' ] +DEBUG= False - uid=0 +class Plugin: - 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 + # 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 + # . 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, title, domid=None, + visible=True, togglable=True, toggled=True, **settings): + # what is in this dictionary will get exposed to template and to javascript + self._settings=settings + self.title=title + if not domid: domid=Plugin.newdomid() + self.domid=domid + self.classname=self._classname() + self.add_to_settings ( ['title', 'domid', 'classname'] ) self.visible=visible - self.hidable=hidable - self.hidden_by_default=hidden_by_default + self.togglable=togglable + self.toggled=toggled + self.add_to_settings( ['visible','togglable','toggled'] ) # 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): + 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) + + def _classname (self): try: return self.__class__.__name__ except: return 'Plugin' # shorthands to inspect _settings - def get_setting (self, setting, default): + 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 # 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 ('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 + env.update(self._settings) + result = render_to_string ('plugin.html',env) + + # expose _settings in json format to js, and add plugin_uuid: domid in the mix + # NOTE this plugin_uuid thing might occur in js files, ** do not rename ** + js_env = { 'plugin_uuid' : self.domid } + js_env.update (self._settings) + for k in self.exclude_from_json(): + if k in js_env: del js_env[k] + 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 ) + self.add_js_chunks (request, 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() + 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) - 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): + def _init_prelude (self, request): if not hasattr (request, 'plugin_prelude'): - request.plugin_prelude=Prelude() + # include css/plugins.css + request.plugin_prelude=Prelude(css_files='css/plugin.css') def inspect_request (self, request, message): has=hasattr(request,'plugin_prelude') @@ -101,41 +155,49 @@ class Plugin: # 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(): - 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 - def title (self): return "you should redefine title()" - # 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
) # # the notion of 'Media' in django provides for medium-dependant @@ -151,3 +213,6 @@ class Plugin: # '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 []