engine/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 engine.prelude import Prelude
  10
  11 ####################
  12 # set DEBUG to
  13 # . False : silent
  14 # . [ 'SliceList', 'TabbedView' ] : to debug these classes
  15 # . True : to debug all plugin
  16
  17 DEBUG= False
  18 DEBUG= [ 'SimpleList' ]
  19
  20 class Plugin:
  21
  22     # using a simple incremental scheme to generate domids for now
  23     # we just need this to be unique in a page
  24     domid=0
  25
  26     @staticmethod
  27     def newdomid():
  28         Plugin.domid += 1
  29         return "plugin-%d"%Plugin.domid
  30
  31     ##########
  32     # Constructor
  33     #### mandatory
  34     # . title: is used visually for displaying the widget
  35     #### optional
  36     # . togglable: whether it can be turned on and off (like PleKitToggle)
  37     # . toggled: if togglable, what's the initial status
  38     # . visible: if not set the plugin does not show up at all
  39     #            (not quite sure what this was for)
  40     #### internal data
  41     # . domid: created internally, but can be set at creation time if needed
  42     #          useful for hand-made css, or for selecting an active plugin in a composite
  43     # . rank: this is for plugins sons of a composite plugin
  44     #### custom
  45     # any other setting can also be set when creating the object, like
  46     # p=Plugin(foo='bar')
  47     # which will result in 'foo' being accessible to the template engine
  48     #
  49     def __init__ (self, title, domid=None,
  50                   visible=True, togglable=True, toggled=True, **settings):
  51         self.title=title
  52         if not domid: domid=Plugin.newdomid()
  53         self.domid=domid
  54         self.classname=self._classname()
  55         self.visible=visible
  56         self.togglable=togglable
  57         self.toggled=toggled
  58         # what comes from subclasses
  59         for (k,v) in settings.iteritems():
  60             setattr(self,k,v)
  61             if self.need_debug(): print "%s init - subclass setting %s"%(self.classname,k)
  62         # minimal debugging
  63         if self.need_debug():
  64             print "%s init dbg .... BEG"%self.classname
  65             for (k,v) in self.__dict__.items(): print "dbg %s:%s"%(k,v)
  66             print "%s init dbg .... END"%self.classname
  67
  68     def _classname (self):
  69         try:    return self.__class__.__name__
  70         except: return 'Plugin'
  71
  72     ##########
  73     def need_debug (self):
  74         if not DEBUG:           return False
  75         if DEBUG is True:       return True
  76         else:                   return self.classname in DEBUG
  77
  78     def setting_json (self, setting):
  79         # TMP: js world expects plugin_uuid
  80         if setting=='plugin_uuid':
  81             value=self.domid
  82         elif setting=='query_uuid':
  83             try: value=self.query.uuid
  84             except: return '%s:"undefined"'%setting
  85         else:
  86             value=getattr(self,setting,None)
  87             if not value: value = "unknown-setting-%s"%setting
  88         # first try to use to_json method (json.dumps not working on class instances)
  89         try:    value_json=value.to_json()
  90         except: value_json=json.dumps(value,separators=(',',':'))
  91         return "%s:%s"%(setting,value_json)
  92
  93     # expose in json format to js the list of fields as described in json_settings_list()
  94     # and add plugin_uuid: domid in the mix
  95     # NOTE this plugin_uuid thing might occur in js files from joomla/js, ** do not rename **
  96     def settings_json (self):
  97         result = "{"
  98         result += ",".join([ self.setting_json(setting) for setting in self.json_settings_list() ])
  99         result += "}"
 100         return result
 101
 102     # returns the html code for that plugin
 103     # in essence, wraps the results of self.render_content ()
 104     def render (self, request):
 105         # initialize prelude placeholder if needed
 106         self._init_prelude (request)
 107         # call render_content
 108         plugin_content = self.render_content (request)
 109         # shove this into plugin.html
 110         env = {}
 111         env ['plugin_content']= plugin_content
 112         env.update(self.__dict__)
 113         result = render_to_string ('plugin.html',env)
 114
 115         # as a first approximation we're only concerned with plugins that are associated with a query
 116         # other simpler plugins that only deal with layout do not need this
 117         if 'query' in self.__dict__:
 118             env ['settings_json' ] = self.settings_json()
 119             # compute plugin-specific initialization
 120             js_init = render_to_string ( 'plugin-setenv.js', env )
 121             self.add_js_chunks (request, js_init)
 122
 123         # interpret the result of requirements ()
 124         self.handle_requirements (request)
 125
 126         return result
 127
 128     # you may redefine this completely, but if you don't we'll just use methods
 129     # . template_file() to find out which template to use, and
 130     # . template_env() to compute a dictionary to pass along to the templating system
 131     def render_content (self, request):
 132         """Should return an HTML fragment"""
 133         template = self.template_file()
 134         env=self.template_env(request)
 135         if not isinstance (env,dict):
 136             raise Exception, "%s.template_env returns wrong type"%self.classname
 137         result=render_to_string (template, env)
 138         if self.need_debug():
 139             print "%s.render_content: BEG --------------------"%self.classname
 140             print "template=%s"%template
 141             print "env.keys=%s"%env.keys()
 142             #print "env=%s"%env
 143             #print result
 144             print "%s.render_content: END --------------------"%self.classname
 145         return result
 146
 147     #################### requirements/prelude management
 148     def _init_prelude (self, request):
 149         if not hasattr (request, 'plugin_prelude'):
 150             # include css/plugins.css
 151             request.plugin_prelude=Prelude(css_files='css/plugin.css')
 152
 153     # can be used directly in render_content()
 154     def add_js_files (self, request, files):
 155         self._init_prelude (request)
 156         request.plugin_prelude.add_js_files (files)
 157     def add_css_files (self, request, files):
 158         self._init_prelude (request)
 159         request.plugin_prelude.add_css_files (files)
 160     def add_js_chunks (self, request, chunks):
 161         self._init_prelude (request)
 162         request.plugin_prelude.add_js_chunks (chunks)
 163     def add_css_chunks (self, request, chunks):
 164         self._init_prelude (request)
 165         request.plugin_prelude.add_css_chunks (chunks)
 166
 167     # or from the result of self.requirements()
 168     def handle_requirements (self, request):
 169         try:
 170             d=self.requirements()
 171             for (k,v) in d.iteritems():
 172                 if self.need_debug():
 173                     print "%s: handling requirement %s"%(self.classname,v)
 174                 method_name='add_'+k
 175                 method=Plugin.__dict__[method_name]
 176                 method(self,request,v)
 177         except AttributeError:
 178             # most likely the object does not have that method defined, which is fine
 179             pass
 180         except:
 181             import traceback
 182             traceback.print_exc()
 183             pass
 184
 185     ######################################## abstract interface
 186     # your plugin is expected to implement either
 187     # (*) def render_content(self, request) -> html fragment
 188     # -- or --
 189     # (*) def template_file (self) -> filename
 190     #   relative to STATIC
 191     # (*) def template_env (self, request) -> dict
 192     #   this is the variable->value association used to render the template
 193     # in which case the html template will be used
 194
 195     # if you see this string somewhere your template_file() code is not kicking in
 196     def template_file (self):           return "undefined_template"
 197     def template_env (self, request):   return {}
 198
 199 #    # tell the framework about requirements (for the document <header>)
 200 #    # the notion of 'Media' in django provides for medium-dependant
 201 #    # selection of css files
 202 #    # as a first attempt however we keep a flat model for now
 203 #    # can use one string instead of a list or tuple if needed,
 204 #    # see requirements.py for details
 205 #    def requirements (self):
 206 #        return { 'js_files' : [],       # a list of relative paths for js input files
 207 #                 'css_files': [],       # ditto for css, could have been a dict keyed on
 208 #                                        # media instead
 209 #                 'js_chunk' : [],       # (lines of) verbatim javascript code
 210 #                 'css_chunk': [],       # likewise for css scripts
 211 #                 }
 212
 213 #    # for better performance
 214 #    # you can specify a list of keys that won't be exposed as json attributes
 215 #    def exclude_from_json (self): return []
 216
 217     # mandatory : define the fields that need to be exposed to json as part of
 218     # plugin initialization
 219     # mention 'domid' if you need plugin_uuid
 220     # also 'query_uuid' gets replaced with query.uuid
 221     def json_settings_list (self): return ['json_settings_list-must-be-redefined']
 222