from types import StringTypes, ListType from django.template.loader import render_to_string debug=False # the need for js_init_chunks is because we need to have the plugins initialized # before the queries fly # and when writing a view it is not very easy to remember in which order # all the js initialization will end up, so we use these 2 categories # as a simple way to enforce this dependency # far from perfect but good enough for now class Prelude: """A class for collecting dependencies on js/css stuff files are expected from your 'static' area, typically 'css/foo.css' or 'js/foo.js' fragments (chunks) is for raw code you can specify a string or a list of strings js_init_chunks get collated with js_chunks but come first """ keys=[ 'js_files', 'css_files', 'js_init_chunks', 'js_chunks', 'css_chunks' ] def __init__ (self, js_files=None, css_files=None, js_init_chunks=None, js_chunks=None, css_chunks=None): # it's tempting to use sets but sets are not ordered.. self.js_files = Prelude._normalize(js_files) self.css_files = Prelude._normalize(css_files) self.js_init_chunks = Prelude._normalize(js_init_chunks) self.js_chunks = Prelude._normalize(js_chunks) self.css_chunks= Prelude._normalize(css_chunks) @staticmethod def _normalize (input): if not input: return [] elif isinstance (input, ListType): return input elif isinstance (input, StringTypes): return [ input ] else: return list (input) def add_js_files (self, x): for i in Prelude._normalize (x): if i not in self.js_files: self.js_files.append(i) def add_css_files (self, x): for i in Prelude._normalize (x): if i not in self.css_files: self.css_files.append(i) def add_js_init_chunks (self, x): self.js_init_chunks += Prelude._normalize (x) def add_js_chunks (self, x): self.js_chunks += Prelude._normalize (x) def add_css_chunks (self, x): self.css_chunks += Prelude._normalize (x) def inspect_string (self,msg): result = 'Prelude.inspect %s (%s) with '%(msg,self) result += ",".join( [ "%s->%s"%(k,len(getattr(self,k))) for k in Prelude.keys ] ) return result def inspect (self,msg): print self.inspect_string(msg) # first attempt was to use a simple dict like this # env={} # env['js_files']= self.js_files # env['css_files']= self.css_files # env['js_chunks']= '\n'.join(self.js_chunks) # env['css_chunks']='\n'.join(self.css_chunks) # return env # together with this in prelude.html # {% for js_file in js_files %} {% insert_str prelude js_file %} {% endfor %} # {% for css_file in css_files %} {% insert_str prelude css_file %} {% endfor %} # somehow however this would not work too well, # probably insert_above is not powerful enough to handle that # # so a much simpler and safer approach is for us to compute the html header directly # this requires to filter on full urls # @staticmethod def full_url (input): if input.startswith("http://") or input.startswith("https://"): return input else: from myslice.settings import STATIC_URL return "%s%s"%(STATIC_URL,input) def prelude_env (self): env={} env['js_urls'] = [ Prelude.full_url (js_file) for js_file in self.js_files ] env['css_urls'] = [ Prelude.full_url (css_file) for css_file in self.css_files ] env['all_js_chunks']= self.js_init_chunks + self.js_chunks env['css_chunks']=self.css_chunks if debug: print "prelude has %d js_files, %d css files, (%d+%d) js chunks and %d css_chunks"%\ (len(self.js_files),len(self.css_files),len(self.js_init_chunks),len(self.js_chunks),len(self.css_chunks),) # render this with prelude.html and put the result in header_prelude header_prelude = render_to_string ('prelude.html',env) return { 'header_prelude' : header_prelude }