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 # set to
  12 # . False : silent
  13 # [ 'SliceList', 'TabbedView' ] : to debug these classes
  14 # True : to debug all slices
  15
  16 DEBUG= [ 'SliceList' ]
  17
  18 class Plugin:
  19
  20     uid=0
  21
  22     def __init__ (self, visible=True, hidable=True, hidden_by_default=False, **settings):
  23         # xxx should generate some random id
  24         self.uuid=Plugin.uid
  25         Plugin.uid += 1
  26         self.visible=visible
  27         self.hidable=hidable
  28         self.hidden_by_default=hidden_by_default
  29         # we store as a dictionary the arguments passed to constructor
  30         # e.g. SimpleList (list=[1,2,3]) => _settings = { 'list':[1,2,3] }
  31         # our own settings are not made part of _settings but could be..
  32         self._settings=settings
  33         if self.need_debug():
  34             print "Plugin.__init__ Created plugin with settings %s"%self._settings.keys()
  35
  36     # subclasses might handle some fields in their own way,
  37     # in which case this call is needed to capture that setting
  38     # see e.g. SimpleList or SliceList for an example of that
  39     def add_to_settings (self, setting_name):
  40         self._settings[setting_name]=getattr(self,setting_name)
  41
  42     def classname (self):
  43         try:    return self.__class__.__name__
  44         except: return 'Plugin'
  45
  46     # shorthands to inspect _settings
  47     def get_setting (self, setting, default=None):
  48         if setting not in self._settings: return default
  49         else:                             return self._settings[setting]
  50
  51     def is_visible (self): return self.visible
  52     def is_hidable (self): return self.hidable
  53     def is_hidden_by_default (self): return self.hidden_by_default
  54
  55     ##########
  56     def need_debug (self):
  57         if not DEBUG:           return False
  58         if DEBUG is True:       return True
  59         else:                   return self.classname() in DEBUG
  60
  61     # returns the html code for that plugin
  62     # in essence, wraps the results of self.render_content ()
  63     def render (self, request):
  64         uuid = self.uuid
  65         classname = self.classname()
  66         # initialize prelude placeholder
  67         self._init_request (request)
  68
  69         # call render_content
  70         plugin_content = self.render_content (request)
  71         # expose _settings in json format to js
  72         settings_json = json.dumps (self._settings, separators=(',',':'))
  73
  74         result = render_to_string ('plugin.html',
  75                                    {'uuid':uuid,
  76                                     'classname':classname,
  77                                     'visible':self.is_visible(),
  78                                     'hidable':self.is_hidable(),
  79                                     'hidden':self.is_hidden_by_default(),
  80                                     'plugin_content' : plugin_content,
  81                                     'settings_json' : settings_json,
  82                                     })
  83
  84         # handle requirements() if defined on this class
  85         try:
  86             self.handle_requirements (request, self.requirements())
  87         except AttributeError:
  88             # most likely the object does not have that method defined, which is fine
  89             pass
  90         except:
  91             import traceback
  92             traceback.print_exc()
  93             pass
  94
  95         return result
  96
  97     # you may redefine this completely, but if you don't we'll just use methods
  98     # . template() to find out which template to use, and
  99     # . template_env() to compute a dictionary to pass along to the templating system
 100     def render_content (self, request):
 101         """Should return an HTML fragment"""
 102         template = self.template()
 103         env=self.template_env(request)
 104         if not isinstance (env,dict):
 105             raise Exception, "%s.template_env returns wrong type"%self.classname()
 106         # expose this class's settings to the template
 107         # xxx we might need to check that this does not overwrite env..
 108         env.update(self._settings)
 109         result=render_to_string (template, env)
 110         if self.need_debug():
 111             print "%s.render_content: BEG --------------------"%self.classname()
 112             print "template=%s"%template
 113             print "env=%s"%env.keys()
 114             # print result
 115             print "%s.render_content: END --------------------"%self.classname()
 116         return result
 117
 118     #################### requirements/prelude management
 119     def _init_request (self, request):
 120         if not hasattr (request, 'plugin_prelude'):
 121             # include css/plugins.css
 122             request.plugin_prelude=Prelude(css_files='css/plugin.css')
 123
 124     def inspect_request (self, request, message):
 125         has=hasattr(request,'plugin_prelude')
 126         get=getattr(request,'plugin_prelude','none-defined')
 127         print "INSPECT (%s), hasattr %s, getattr %s"%(message,has,get)
 128
 129     # can be used directly in render_content()
 130     def add_js_files (self, request, files):
 131         self._init_request (request)
 132         request.plugin_prelude.add_js_files (files)
 133     def add_css_files (self, request, files):
 134         self._init_request (request)
 135         request.plugin_prelude.add_css_files (files)
 136     def add_js_chunks (self, request, chunks):
 137         self._init_request (request)
 138         request.plugin_prelude.add_js_chunks (chunks)
 139     def add_css_chunks (self, request, chunks):
 140         self._init_request (request)
 141         request.plugin_prelude.add_css_chunks (chunks)
 142
 143     # or from the result of self.requirements()
 144     def handle_requirements (self, request, d):
 145         for (k,v) in d.iteritems():
 146             if self.need_debug():
 147                 print "%s: handling requirement %s"%(self.classname(),v)
 148             method_name='add_'+k
 149             method=Plugin.__dict__[method_name]
 150             method(self,request,v)
 151
 152     ######################################## abstract interface
 153     def title (self): return "you should redefine title()"
 154
 155     # your plugin is expected to implement either
 156     # (*) def render_content(self, request) -> html fragment
 157     # -- or --
 158     # (*) def template(self) -> filename
 159     #   relative to STATIC
 160     # (*) def template_env (self, request) -> dict
 161     #   this is the variable->value association used to render the template
 162     # in which case the html template will be used
 163
 164     # if you see this string somewhere your template() code is not kicking in
 165     def template (self):                return "undefined_template"
 166     def template_env (self, request):     return {}
 167
 168 #    # tell the framework about requirements (for the document <header>)
 169 #    # the notion of 'Media' in django provides for medium-dependant
 170 #    # selection of css files
 171 #    # as a first attempt however we keep a flat model for now
 172 #    # can use one string instead of a list or tuple if needed,
 173 #    # see requirements.py for details
 174 #    def requirements (self):
 175 #        return { 'js_files' : [],       # a list of relative paths for js input files
 176 #                 'css_files': [],       # ditto for css, could have been a dict keyed on
 177 #                                        # media instead
 178 #                 'js_chunk' : [],       # (lines of) verbatim javascript code
 179 #                 'css_chunk': [],       # likewise for css scripts
 180 #                 }
 181