unfold/plugin.py

   1 # this is the abstract interface for Plugin instances
   2 # so it should be specialized in real plugin classes
   3 # like e.g. plugins.simplelist.SimpleList
   4
   5 import json
   6
   7 from django.template.loader import render_to_string
   8
   9 from unfold.page import Page
  10 from unfold.prelude import Prelude
  11
  12 ####################
  13 # set DEBUG to
  14 # . False : silent
  15 # . [ 'SliceList', 'TabbedView' ] : to debug these classes
  16 # . True : to debug all plugin
  17
  18 DEBUG= False
  19 #DEBUG= [ 'SimpleList' ]
  20 #DEBUG=True
  21
  22 # decorator to deflect calls on Plugin to its Prelude through self.page.prelude
  23 def to_prelude (method):
  24     def actual (self, *args, **kwds):
  25         prelude_method=Prelude.__dict__[method.__name__]
  26         return prelude_method(self.page.prelude,*args, **kwds)
  27     return actual
  28
  29 class Plugin:
  30
  31     # using a simple incremental scheme to generate domids for now
  32     # we just need this to be unique in a page
  33     domid=0
  34
  35     # when a domid is not set by the caller, we name plugins after their respective class as well,
  36     # so as to limit name clashes between different views
  37     # this has to see with the UI storing the last-seen status of plugins based on their id
  38     # put it more bluntly it is recommended that a domid should be set
  39     # and maybe xxx we should just enforce that...
  40     def newdomid(self):
  41         Plugin.domid += 1
  42         return "plugin-%s-%d"%(self.__class__.__name__.lower(),Plugin.domid)
  43
  44     ##########
  45     # Constructor
  46     #### mandatory
  47     # . page: the context of the request being served
  48     # . title: is used visually for displaying the widget
  49     #### optional
  50     # . visible: if not set the plugin does not show up at all
  51     #            (not quite sure what this was for)
  52     # . togglable: whether it can be turned on and off by clicking on the title (like PleKitToggle)
  53     # . toggled:   whether the plugin should startup open/shown or closed/hidden
  54     #              possible values are
  55     #   .. True         : start up open/hidden
  56     #   .. False        : start up closed/shown
  57     #   .. 'persistent' : start up as it was the last time that browser showed it (based on 'domid')
  58     #                NOTE that it is required for you to set a domid if you want to use persistent mode
  59     #                     since domid is the key for storing that data in the browser storage space
  60     #   .. None         : if not passed to __init__ at all, then the default_toggled() method is called
  61     #   ..              : anything else, defaults to True
  62     #
  63     #### internal data
  64     # . domid: created internally, but can be set at creation time if needed
  65     #          useful for hand-made css, or for selecting an active plugin in a composite
  66     # . rank: this is for plugins sons of a composite plugin
  67     #### custom
  68     # any other setting can also be set when creating the object, like
  69     # p=Plugin(foo='bar')
  70     # which will result in 'foo' being accessible to the template engine
  71     #
  72     def __init__ (self, page, title=None, domid=None,
  73                   visible=True, togglable=None, toggled=None, **settings):
  74         self.page = page
  75         # callers can provide their domid for css'ing
  76         if not domid: domid=self.newdomid()
  77         self.domid=domid
  78         # title is shown when togglable
  79         if not title: title="Plugin title for %s"%domid
  80         self.title=title
  81         self.classname=self._py_classname()
  82         self.plugin_classname=self._js_classname()
  83         self.visible=visible
  84         if togglable is None:   self.togglable=self.default_togglable()
  85         else:                   self.togglable=togglable
  86         if toggled is None:     self.toggled=self.default_toggled()
  87         else:                   self.toggled=toggled
  88         # what comes from subclasses
  89         for (k,v) in settings.iteritems():
  90             setattr(self,k,v)
  91             if self.need_debug(): print "%s init - subclass setting %s"%(self.classname,k)
  92         # minimal debugging
  93         if self.need_debug():
  94             print "%s init dbg .... BEG"%self.classname
  95             for (k,v) in self.__dict__.items(): print "dbg %s:%s"%(k,v)
  96             print "%s init dbg .... END"%self.classname
  97         # do this only once the structure is fine
  98         self.page.record_plugin(self)
  99
 100     def __repr__ (self):
 101         return "[%s]:%s"%(self.classname,self.domid)
 102
 103     def _py_classname (self):
 104         try:    return self.__class__.__name__
 105         except: return 'Plugin'
 106
 107     def _js_classname (self):
 108         try:    return self.plugin_classname ()
 109         except: return self._py_classname()
 110
 111     ##########
 112     def need_debug (self):
 113         if not DEBUG:           return False
 114         if DEBUG is True:       return True
 115         else:                   return self.classname in DEBUG
 116
 117     def setting_json (self, setting):
 118         # TMP: js world expects plugin_uuid
 119         if setting=='plugin_uuid':
 120             value=self.domid
 121         elif setting=='query_uuid':
 122             try: value=self.query.query_uuid
 123             except: return '%s:"undefined"'%setting
 124         else:
 125             value=getattr(self,setting,None)
 126             if value is None: value = "unknown-setting-%s"%setting
 127         # first try to use to_json method (json.dumps not working on class instances)
 128         try:    value_json=value.to_json()
 129         except: value_json=json.dumps(value,separators=(',',':'))
 130         return "%s:%s"%(setting,value_json)
 131
 132     # expose in json format to js the list of fields as described in json_settings_list()
 133     # and add plugin_uuid: domid in the mix
 134     # NOTE this plugin_uuid thing might occur in js files from joomla/js, ** do not rename **
 135     def settings_json (self):
 136         exposed_settings=self.json_settings_list()
 137         if 'query' in exposed_settings:
 138             print "WARNING, cannot expose 'query' directly in json_settings_list, query_uuid is enough"
 139         result = "{"
 140         result += ",".join([ self.setting_json(setting) for setting in self.json_settings_list() ])
 141         result += "}"
 142         return result
 143
 144     # as a first approximation, only plugins that are associated with a query
 145     # need to be prepared for js - meaning their json settings get exposed to js
 146     # others just get displayed and that's it
 147     def export_json_settings (self):
 148         return 'query_uuid' in self.json_settings_list()
 149
 150     # by default we create a timer if there's a query attached, redefine to change this behaviour
 151     def start_with_spin (self):
 152         return self.export_json_settings()
 153
 154     # returns the html code for that plugin
 155     # in essence, wraps the results of self.render_content ()
 156     def render (self, request):
 157         # call render_content
 158         plugin_content = self.render_content (request)
 159         # shove this into plugin.html
 160         env = {}
 161         env ['plugin_content']= plugin_content
 162         # need_spin is used in plugin.html
 163         self.need_spin=self.start_with_spin()
 164         env.update(self.__dict__)
 165         # translate high-level 'toggled' into 4 different booleans
 166         if self.toggled=='persistent':
 167             # start with everything turned off and let the js callback do its job
 168             env.update({'persistent_toggle':True,'display_hide_button':False,'display_show_button':False,'display_body':False})
 169         elif self.toggled==False:
 170             env.update({'persistent_toggle':False,'display_hide_button':False,'display_show_button':True,'display_body':False})
 171         else:
 172             env.update({'persistent_toggle':False,'display_hide_button':True,'display_show_button':False,'display_body':True})
 173         if self.need_debug():
 174             print "rendering plugin.html with env keys %s"%env.keys()
 175             print "rendering plugin.html with env"
 176             for (k,v) in env.items():
 177                 if "display" in k or "persistent" in k: print k,'->',v
 178         result = render_to_string ('plugin.html',env)
 179
 180         # export this only for relevant plugins
 181         if self.export_json_settings():
 182             env ['settings_json' ] = self.settings_json()
 183             # compute plugin-specific initialization
 184             js_init = render_to_string ( 'plugin-init.js', env )
 185             self.add_js_chunks (js_init)
 186
 187         # interpret the result of requirements ()
 188         self.handle_requirements (request)
 189
 190         return result
 191
 192     # you may redefine this completely, but if you don't we'll just use methods
 193     # . template_file() to find out which template to use, and
 194     # . template_env() to compute a dictionary to pass along to the templating system
 195     def render_content (self, request):
 196         """Should return an HTML fragment"""
 197         template = self.template_file()
 198         # start with a fresh one
 199         env={}
 200         # add our own settings as defaults
 201         env.update(self.__dict__)
 202         # then the things explicitly defined in template_env()
 203         env.update(self.template_env(request))
 204         if not isinstance (env,dict):
 205             raise Exception, "%s.template_env returns wrong type"%self.classname
 206         result=render_to_string (template, env)
 207         if self.need_debug():
 208             print "%s.render_content: BEG --------------------"%self.classname
 209             print "template=%s"%template
 210             print "env.keys=%s"%env.keys()
 211             #print "env=%s"%env
 212             #print result
 213             print "%s.render_content: END --------------------"%self.classname
 214         return result
 215
 216     # or from the result of self.requirements()
 217     def handle_requirements (self, request):
 218         try:
 219             d=self.requirements()
 220             for (k,v) in d.iteritems():
 221                 if self.need_debug():
 222                     print "%s: handling requirement %s"%(self.classname,v)
 223                 # e.g. js_files -> add_js_files
 224                 method_name='add_'+k
 225                 method=Page.__dict__[method_name]
 226                 method(self.page,v)
 227         except AttributeError:
 228             # most likely the object does not have that method defined, which is fine
 229             pass
 230         except:
 231             import traceback
 232             traceback.print_exc()
 233             pass
 234
 235     #################### requirements/prelude management
 236     # just forward to our prelude instance - see decorator above
 237     @to_prelude
 238     def add_js_files (self):pass
 239     @to_prelude
 240     def add_css_files (self):pass
 241     @to_prelude
 242     def add_js_chunks (self):pass
 243     @to_prelude
 244     def add_css_chunks (self):pass
 245
 246     ######################################## abstract interface
 247     # your plugin is expected to implement either
 248     # (*) def render_content(self, request) -> html fragment
 249     # -- or --
 250     # (*) def template_file (self) -> filename
 251     #   relative to STATIC
 252     # (*) def template_env (self, request) -> dict
 253     #   this is the variable->value association used to render the template
 254     # in which case the html template will be used
 255
 256     # if you see this string somewhere your template_file() code is not kicking in
 257     def template_file (self):           return "undefined_template"
 258     def template_env (self, request):   return {}
 259
 260     def default_togglable (self):       return True
 261     def default_toggled (self):         return 'persistent'
 262
 263 #    # tell the framework about requirements (for the document <header>)
 264 #    # the notion of 'Media' in django provides for medium-dependant
 265 #    # selection of css files
 266 #    # as a first attempt however we keep a flat model for now
 267 #    # can use one string instead of a list or tuple if needed,
 268 #    # see requirements.py for details
 269 #    def requirements (self):
 270 #        return { 'js_files' : [],       # a list of relative paths for js input files
 271 #                 'css_files': [],       # ditto for css, could have been a dict keyed on
 272 #                                        # media instead
 273 #                 'js_chunk' : [],       # (lines of) verbatim javascript code
 274 #                 'css_chunk': [],       # likewise for css scripts
 275 #                 }
 276
 277 #    # for better performance
 278 #    # you can specify a list of keys that won't be exposed as json attributes
 279 #    def exclude_from_json (self): return []
 280
 281     # mandatory : define the fields that need to be exposed to json as part of
 282     # plugin initialization
 283     # mention 'domid' if you need plugin_uuid
 284     # also 'query_uuid' gets replaced with query.query_uuid
 285     def json_settings_list (self): return ['json_settings_list-must-be-redefined']
 286
 287     # might also define these ones:
 288     #
 289     # see e.g. slicelist.py that piggybacks simplelist js code
 290     # def plugin_classname (self)
 291     #
 292     # whether we export the json settings to js
 293     # def export_json_settings (self)
 294     #
 295     # whether we show an initial spinner
 296     # def start_with_spin (self)