X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=unfold%2Fplugin.py;h=9a65f59ec14eec425774287a36146bfe4e45bc04;hb=refs%2Fheads%2Fonelab;hp=c5ce3a0acb56b1b9509459a5c9aa930e5bd1d9a2;hpb=0426cdd4479234df3498deb8675511cd26e866c2;p=myslice.git diff --git a/unfold/plugin.py b/unfold/plugin.py index c5ce3a0a..9a65f59e 100644 --- a/unfold/plugin.py +++ b/unfold/plugin.py @@ -9,33 +9,41 @@ from django.template.loader import render_to_string from unfold.page import Page from unfold.prelude import Prelude +from myslice.settings import logger + #################### # set DEBUG to # . False : silent # . [ 'SliceList', 'TabbedView' ] : to debug these classes # . True : to debug all plugin -DEBUG= False -#DEBUG= [ 'SliceList' ] -DEBUG=True +DEBUG = False +#DEBUG = [ 'SimpleList' ] +#DEBUG = True # 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) + if not self.page: # jordan + return None + prelude_method = Prelude.__dict__[method.__name__] + return prelude_method(self.page.prelude, *args, **kwds) return actual class Plugin: # using a simple incremental scheme to generate domids for now # we just need this to be unique in a page - domid=0 + domid = 0 - @staticmethod - def newdomid(): + # when a domid is not set by the caller, we name plugins after their respective class as well, + # so as to limit name clashes between different views + # this has to see with the UI storing the last-seen status of plugins based on their id + # put it more bluntly it is recommended that a domid should be set + # and maybe xxx we should just enforce that... + def newdomid(self): Plugin.domid += 1 - return "plugin-%d"%Plugin.domid + return "plugin-{}-{}".format(self.__class__.__name__.lower(), Plugin.domid) ########## # Constructor @@ -43,10 +51,26 @@ class Plugin: # . 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) + # . togglable: whether it can be turned on and off by clicking on the title (like PleKitToggle) + # . toggled: whether the plugin should startup open/shown or closed/hidden + # possible values are + # .. True : start up open/hidden + # .. False : start up closed/shown + # .. 'persistent' : start up as it was the last time that browser showed it (based on 'domid') + # NOTE that it is required for you to set a domid if you want to use persistent mode + # since domid is the key for storing that data in the browser storage space + # .. None : if not passed to __init__ at all, then the default_toggled() method is called + # .. : anything else, defaults to True + # . outline_complete: whether the overall plugin (body + toggle buttons/title) needs to receive + # a border and extra space + # . outline_body : same but for the plugin body only + # for these 2 outline_ flags, possible values mimick the above behaviour, i.e.: + # .. True: : outline is on + # .. False: : outline is off + # .. None: : calls default_outline_complete() on the plugin object + # #### 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 @@ -56,29 +80,46 @@ class Plugin: # 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): + def __init__ (self, page, title=None, domid=None, + visible=True, togglable=None, toggled=None, + outline_complete=None, outline_body=None, + **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.togglable=togglable - self.toggled=toggled + if not domid: + domid=self.newdomid() + self.domid = domid + # title is shown when togglable + #if not title: title="Plugin title for %s"%domid + self.title = title + self.classname = self._py_classname() + self.plugin_classname = self._js_classname() + self.visible = visible + if togglable is None: self.togglable = self.default_togglable() + else: self.togglable = togglable + if toggled is None: self.toggled = self.default_toggled() + else: self.toggled = toggled + if outline_complete is None: self.outline_complete = self.default_outline_complete() + else: self.outline_complete = outline_complete + if outline_body is None: self.outline_body = self.default_outline_body() + else: self.outline_body = outline_body # 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) + setattr(self, k, v) + if self.need_debug(): + logger.debug("{} init - subclass setting {}".format(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 + logger.debug("{} init dbg .... BEG".format(self.classname)) + for (k, v) in self.__dict__.items(): + logger.debug("dbg {}:{}".format(k, v)) + logger.debug("{} init dbg .... END".format(self.classname)) # do this only once the structure is fine - self.page.record_plugin(self) + if self.page: # I assume we can have a None page (Jordan) + self.page.record_plugin(self) + + def __repr__ (self): + return "[%s]:%s"%(self.classname,self.domid) def _py_classname (self): try: return self.__class__.__name__ @@ -96,18 +137,19 @@ class Plugin: 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.query_uuid - except: return '%s:"undefined"'%setting + if setting == 'plugin_uuid': + value = self.domid + elif setting == 'query_uuid': + try: value = self.query.query_uuid + except: return '{}:"undefined"'.format(setting) else: - value=getattr(self,setting,None) - if not value: value = "unknown-setting-%s"%setting + value = getattr(self,setting,None) + if value is None: + 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) + try: value_json = value.to_json() + except: value_json = json.dumps(value,separators=(',',':')) + return "{}:{}".format(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 @@ -115,7 +157,7 @@ class Plugin: def settings_json (self): exposed_settings=self.json_settings_list() if 'query' in exposed_settings: - print "WARNING, cannot expose 'query' directly in json_settings_list, query_uuid is enough" + logger.debug("WARNING, cannot expose 'query' directly in json_settings_list, query_uuid is enough") result = "{" result += ",".join([ self.setting_json(setting) for setting in self.json_settings_list() ]) result += "}" @@ -127,10 +169,6 @@ class Plugin: def export_json_settings (self): return 'query_uuid' in self.json_settings_list() - # by default we create a timer if there's a query attached, redefine to change this behaviour - 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): @@ -138,12 +176,25 @@ class Plugin: plugin_content = self.render_content (request) # 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['plugin_content'] = plugin_content env.update(self.__dict__) + # translate high-level 'toggled' into 4 different booleans + self.need_toggle = False + if self.toggled == 'persistent': + # start with everything turned off and let the js callback do its job + env.update({'persistent_toggle' : True, 'display_hide_button' : False, + 'display_show_button' : False, 'display_body' : False}) + elif self.toggled == False: + env.update({'persistent_toggle' : False, 'display_hide_button' : False, + 'display_show_button' : True, 'display_body' : False}) + else: + env.update({'persistent_toggle' : False, 'display_hide_button' : True, + 'display_show_button' : False, 'display_body' : True}) if self.need_debug(): - print "rendering plugin.html with env keys %s"%env.keys() + logger.debug("rendering plugin.html with env keys {}".format(env.keys())) + for (k,v) in env.items(): + if "display" in k or "persistent" in k: + logger.debug("{} -> {}".format(k, v)) result = render_to_string ('plugin.html',env) # export this only for relevant plugins @@ -151,7 +202,8 @@ class Plugin: env ['settings_json' ] = self.settings_json() # compute plugin-specific initialization js_init = render_to_string ( 'plugin-init.js', env ) - self.add_js_chunks (js_init) + # make sure this happens first in js + self.add_js_init_chunks (js_init) # interpret the result of requirements () self.handle_requirements (request) @@ -164,36 +216,39 @@ class Plugin: def render_content (self, request): """Should return an HTML fragment""" template = self.template_file() - env=self.template_env(request) + # start with a fresh one + env = {} + # add our own settings as defaults + env.update(self.__dict__) + # then the things explicitly defined in template_env() + env.update(self.template_env(request)) if not isinstance (env,dict): raise Exception, "%s.template_env returns wrong type"%self.classname - result=render_to_string (template, env) + result = render_to_string (template, env) 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 + logger.debug("{}.render_content: BEG --------------------".format(self.classname)) + logger.debug("template={}".format(template)) + logger.debug("env.keys={}".format(env.keys())) + logger.debug("{}.render_content: END --------------------".format(self.classname)) return result # or from the result of self.requirements() def handle_requirements (self, request): try: - d=self.requirements() + d = self.requirements() for (k,v) in d.iteritems(): if self.need_debug(): - print "%s: handling requirement %s"%(self.classname,v) + logger.debug("{}: handling requirement {}".format(self.classname, v)) # e.g. js_files -> add_js_files - method_name='add_'+k - method=Page.__dict__[method_name] - method(self.page,v) + 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() + logger.log(traceback.format_exc()) pass #################### requirements/prelude management @@ -203,6 +258,8 @@ class Plugin: @to_prelude def add_css_files (self):pass @to_prelude + def add_js_init_chunks (self):pass + @to_prelude def add_js_chunks (self):pass @to_prelude def add_css_chunks (self):pass @@ -221,6 +278,11 @@ class Plugin: def template_file (self): return "undefined_template" def template_env (self, request): return {} + def default_togglable (self): return False + def default_toggled (self): return 'persistent' + def default_outline_complete (self):return False + def default_outline_body(self): return False + # # tell the framework about requirements (for the document
) # # the notion of 'Media' in django provides for medium-dependant # # selection of css files @@ -252,6 +314,3 @@ class Plugin: # # whether we export the json settings to js # def export_json_settings (self) - # - # whether we show an initial spinner - # def start_with_spin (self)