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