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 unfold.page import Page
10 from unfold.prelude import Prelude
15 # . [ 'SliceList', 'TabbedView' ] : to debug these classes
16 # . True : to debug all plugin
19 #DEBUG= [ 'SimpleList' ]
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)
31 # using a simple incremental scheme to generate domids for now
32 # we just need this to be unique in a page
38 return "plugin-%d"%Plugin.domid
43 # . page: the context of the request being served
44 # . title: is used visually for displaying the widget
46 # . visible: if not set the plugin does not show up at all
47 # (not quite sure what this was for)
48 # . togglable: whether it can be turned on and off by clicking on the title (like PleKitToggle)
49 # . toggled: whether the plugin should startup open/shown or closed/hidden
51 # .. True : start up open/hidden
52 # .. False : start up closed/shown
53 # .. 'persistent' : start up as it was the last time that browser showed it (based on 'domid')
54 # NOTE that it is required for you to set a domid if you want to use persistent mode
55 # since domid is the key for storing that data in the browser storage space
56 # .. None : if not passed to __init__ at all, then the default_toggled() method is called
57 # .. : anything else, defaults to True
60 # . domid: created internally, but can be set at creation time if needed
61 # useful for hand-made css, or for selecting an active plugin in a composite
62 # . rank: this is for plugins sons of a composite plugin
64 # any other setting can also be set when creating the object, like
66 # which will result in 'foo' being accessible to the template engine
68 def __init__ (self, page, title, domid=None,
69 visible=True, togglable=None, toggled=None, **settings):
72 # callers can provide their domid for css'ing
73 if not domid: domid=Plugin.newdomid()
75 self.classname=self._py_classname()
76 self.plugin_classname=self._js_classname()
78 if togglable is None: self.togglable=self.default_togglable()
79 else: self.togglable=togglable
80 if toggled is None: self.toggled=self.default_toggled()
81 else: self.toggled=toggled
82 # what comes from subclasses
83 for (k,v) in settings.iteritems():
85 if self.need_debug(): print "%s init - subclass setting %s"%(self.classname,k)
88 print "%s init dbg .... BEG"%self.classname
89 for (k,v) in self.__dict__.items(): print "dbg %s:%s"%(k,v)
90 print "%s init dbg .... END"%self.classname
91 # do this only once the structure is fine
92 self.page.record_plugin(self)
95 return "[%s]:%s"%(self.classname,self.domid)
97 def _py_classname (self):
98 try: return self.__class__.__name__
99 except: return 'Plugin'
101 def _js_classname (self):
102 try: return self.plugin_classname ()
103 except: return self._py_classname()
106 def need_debug (self):
107 if not DEBUG: return False
108 if DEBUG is True: return True
109 else: return self.classname in DEBUG
111 def setting_json (self, setting):
112 # TMP: js world expects plugin_uuid
113 if setting=='plugin_uuid':
115 elif setting=='query_uuid':
116 try: value=self.query.query_uuid
117 except: return '%s:"undefined"'%setting
119 value=getattr(self,setting,None)
120 if value is None: value = "unknown-setting-%s"%setting
121 # first try to use to_json method (json.dumps not working on class instances)
122 try: value_json=value.to_json()
123 except: value_json=json.dumps(value,separators=(',',':'))
124 return "%s:%s"%(setting,value_json)
126 # expose in json format to js the list of fields as described in json_settings_list()
127 # and add plugin_uuid: domid in the mix
128 # NOTE this plugin_uuid thing might occur in js files from joomla/js, ** do not rename **
129 def settings_json (self):
130 exposed_settings=self.json_settings_list()
131 if 'query' in exposed_settings:
132 print "WARNING, cannot expose 'query' directly in json_settings_list, query_uuid is enough"
134 result += ",".join([ self.setting_json(setting) for setting in self.json_settings_list() ])
138 # as a first approximation, only plugins that are associated with a query
139 # need to be prepared for js - meaning their json settings get exposed to js
140 # others just get displayed and that's it
141 def export_json_settings (self):
142 return 'query_uuid' in self.json_settings_list()
144 # by default we create a timer if there's a query attached, redefine to change this behaviour
145 def start_with_spin (self):
146 return self.export_json_settings()
148 # returns the html code for that plugin
149 # in essence, wraps the results of self.render_content ()
150 def render (self, request):
151 # call render_content
152 plugin_content = self.render_content (request)
153 # shove this into plugin.html
155 env ['plugin_content']= plugin_content
156 # need_spin is used in plugin.html
157 self.need_spin=self.start_with_spin()
158 env.update(self.__dict__)
159 # translate high-level 'toggled' into 4 different booleans
160 if self.toggled=='persistent':
161 # start with everything turned off and let the js callback do its job
162 env.update({'persistent_toggle':True,'display_hide_button':False,'display_show_button':False,'display_body':False})
163 elif self.toggled==False:
164 env.update({'persistent_toggle':False,'display_hide_button':False,'display_show_button':True,'display_body':False})
166 env.update({'persistent_toggle':False,'display_hide_button':True,'display_show_button':False,'display_body':True})
167 if self.need_debug():
168 print "rendering plugin.html with env keys %s"%env.keys()
169 print "rendering plugin.html with env"
170 for (k,v) in env.items():
171 if "display" in k or "persistent" in k: print k,'->',v
172 result = render_to_string ('plugin.html',env)
174 # export this only for relevant plugins
175 if self.export_json_settings():
176 env ['settings_json' ] = self.settings_json()
177 # compute plugin-specific initialization
178 js_init = render_to_string ( 'plugin-init.js', env )
179 self.add_js_chunks (js_init)
181 # interpret the result of requirements ()
182 self.handle_requirements (request)
186 # you may redefine this completely, but if you don't we'll just use methods
187 # . template_file() to find out which template to use, and
188 # . template_env() to compute a dictionary to pass along to the templating system
189 def render_content (self, request):
190 """Should return an HTML fragment"""
191 template = self.template_file()
192 # start with a fresh one
194 # add our own settings as defaults
195 env.update(self.__dict__)
196 # then the things explicitly defined in template_env()
197 env.update(self.template_env(request))
198 if not isinstance (env,dict):
199 raise Exception, "%s.template_env returns wrong type"%self.classname
200 result=render_to_string (template, env)
201 if self.need_debug():
202 print "%s.render_content: BEG --------------------"%self.classname
203 print "template=%s"%template
204 print "env.keys=%s"%env.keys()
207 print "%s.render_content: END --------------------"%self.classname
210 # or from the result of self.requirements()
211 def handle_requirements (self, request):
213 d=self.requirements()
214 for (k,v) in d.iteritems():
215 if self.need_debug():
216 print "%s: handling requirement %s"%(self.classname,v)
217 # e.g. js_files -> add_js_files
219 method=Page.__dict__[method_name]
221 except AttributeError:
222 # most likely the object does not have that method defined, which is fine
226 traceback.print_exc()
229 #################### requirements/prelude management
230 # just forward to our prelude instance - see decorator above
232 def add_js_files (self):pass
234 def add_css_files (self):pass
236 def add_js_chunks (self):pass
238 def add_css_chunks (self):pass
240 ######################################## abstract interface
241 # your plugin is expected to implement either
242 # (*) def render_content(self, request) -> html fragment
244 # (*) def template_file (self) -> filename
246 # (*) def template_env (self, request) -> dict
247 # this is the variable->value association used to render the template
248 # in which case the html template will be used
250 # if you see this string somewhere your template_file() code is not kicking in
251 def template_file (self): return "undefined_template"
252 def template_env (self, request): return {}
254 def default_togglable (self): return True
255 def default_toggled (self): return 'persistent'
257 # # tell the framework about requirements (for the document <header>)
258 # # the notion of 'Media' in django provides for medium-dependant
259 # # selection of css files
260 # # as a first attempt however we keep a flat model for now
261 # # can use one string instead of a list or tuple if needed,
262 # # see requirements.py for details
263 # def requirements (self):
264 # return { 'js_files' : [], # a list of relative paths for js input files
265 # 'css_files': [], # ditto for css, could have been a dict keyed on
267 # 'js_chunk' : [], # (lines of) verbatim javascript code
268 # 'css_chunk': [], # likewise for css scripts
271 # # for better performance
272 # # you can specify a list of keys that won't be exposed as json attributes
273 # def exclude_from_json (self): return []
275 # mandatory : define the fields that need to be exposed to json as part of
276 # plugin initialization
277 # mention 'domid' if you need plugin_uuid
278 # also 'query_uuid' gets replaced with query.query_uuid
279 def json_settings_list (self): return ['json_settings_list-must-be-redefined']
281 # might also define these ones:
283 # see e.g. slicelist.py that piggybacks simplelist js code
284 # def plugin_classname (self)
286 # whether we export the json settings to js
287 # def export_json_settings (self)
289 # whether we show an initial spinner
290 # def start_with_spin (self)