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
7 from django.template.loader import render_to_string
9 from engine.prelude import Prelude
15 def __init__ (self, visible=True, hidable=True, hidden_by_default=False, **settings):
16 # xxx should generate some random id
21 self.hidden_by_default=hidden_by_default
22 # we store as a dictionary the arguments passed to constructor
23 # e.g. SimpleList (list=[1,2,3]) => _settings = { 'list':[1,2,3] }
24 # our own settings are not made part of _settings but could be..
25 self._settings=settings
26 # print "Created plugin with settings %s"%self._settings.keys()
29 try: return self.__class__.__name__
30 except: return 'Plugin'
32 # shorthands to inspect _settings
33 def get_setting (self, setting, default):
34 if setting not in self._settings: return default
35 else: return self._settings[setting]
37 def is_visible (self): return self.visible
38 def is_hidable (self): return self.hidable
39 def is_hidden_by_default (self): return self.hidden_by_default
41 # returns the html code for that plugin
42 # in essence, wraps the results of self.render_content ()
43 def render (self, request):
45 classname = self.classname()
46 # initialize prelude placeholder
47 self._init_request (request)
50 plugin_content = self.render_content (request)
51 # expose _settings in json format to js
52 settings_json = json.dumps(self._settings, separators=(',',':'))
54 result = render_to_string ('widget-plugin.html',
55 {'uuid':uuid, 'classname':classname,
56 'visible':self.is_visible(),
57 'hidable':self.is_hidable(),
58 'hidden':self.is_hidden_by_default(),
59 'plugin_content' : plugin_content,
60 'settings_json' : settings_json,
63 # handle requirements() if defined on this class
65 self.handle_requirements (request, self.requirements())
73 # you may redefine this completely, but if you don't we'll just use methods
74 # . template() to find out which template to use, and
75 # . render_env() to compute a dictionary to pass along to the templating system
76 def render_content (self, request):
77 """Should return an HTML fragment"""
78 template = self.template()
79 env=self.render_env(request)
80 if not isinstance (env,dict):
81 raise Exception, "%s.render_env returns wrong type"%self.classname()
82 # expose this class's settings to the template
83 # xxx we might need to check that this does not overwrite env..
84 env.update(self._settings)
85 result=render_to_string (template, env)
86 print "%s.render_content: BEG --------------------"%self.classname()
87 print "env=%s"%env.keys()
89 print "%s.render_content: END --------------------"%self.classname()
92 #################### requirements/prelude management
93 def _init_request (self, request):
94 if not hasattr (request, 'plugin_prelude'):
95 request.plugin_prelude=Prelude()
97 def inspect_request (self, request, message):
98 has=hasattr(request,'plugin_prelude')
99 get=getattr(request,'plugin_prelude','none-defined')
100 print "INSPECT (%s), hasattr %s, getattr %s"%(message,has,get)
102 # can be used directly in render_content()
103 def add_js_files (self, request, files):
104 self._init_request (request)
105 request.plugin_prelude.add_js_files (files)
106 def add_css_files (self, request, files):
107 self._init_request (request)
108 request.plugin_prelude.add_css_files (files)
109 def add_js_chunks (self, request, chunks):
110 self._init_request (request)
111 request.plugin_prelude.add_js_chunks (chunks)
112 def add_css_chunks (self, request, chunks):
113 self._init_request (request)
114 request.plugin_prelude.add_css_chunks (chunks)
116 # or from the result of self.requirements()
117 def handle_requirements (self, request, d):
118 for (k,v) in d.iteritems():
119 print "%s: handling requirement %s"%(self.classname(),v)
121 method=Plugin.__dict__[method_name]
122 method(self,request,v)
124 ######################################## abstract interface
125 def title (self): return "you should redefine title()"
127 # your plugin is expected to implement either
128 # (*) def render_content(self, request) -> html fragment
130 # (*) def template(self) -> filename
132 # (*) def render_env (self, request) -> dict
133 # this is the variable->value association used to render the template
134 # in which case the html template will be used
136 # if you see this string somewhere your template() code is not kicking in
137 def template (self): return "undefined_template"
138 def render_env (self, request): return {}
140 # # tell the framework about requirements (for the document <header>)
141 # # the notion of 'Media' in django provides for medium-dependant
142 # # selection of css files
143 # # as a first attempt however we keep a flat model for now
144 # # can use one string instead of a list or tuple if needed,
145 # # see requirements.py for details
146 # def requirements (self):
147 # return { 'js_files' : [], # a list of relative paths for js input files
148 # 'css_files': [], # ditto for css, could have been a dict keyed on
150 # 'js_chunk' : [], # (lines of) verbatim javascript code
151 # 'css_chunk': [], # likewise for css scripts