unfold/page.py

   1 # the supervisor for Plugins
   2 # keeps a handle on all present plugins for managing their queries in a consistent way
   3 # it is expected to exist one such object for a given page
   4
   5 import json
   6
   7 from django.template.loader import render_to_string
   8
   9 from manifold.metadata import MetaData
  10
  11 from unfold.prelude import Prelude
  12
  13 from myslice.config import Config
  14
  15 # decorator to deflect calls on this Page to its prelude
  16 def to_prelude (method):
  17     def actual (self, *args, **kwds):
  18         prelude_method=Prelude.__dict__[method.__name__]
  19         return prelude_method(self.prelude,*args, **kwds)
  20     return actual
  21
  22 debug=False
  23 debug=True
  24
  25 class Page:
  26
  27     def __init__ (self, request):
  28         self.request=request
  29         # all plugins mentioned in this page
  30         self._plugins = {}
  31         # the set of all queries
  32         self._queries=set()
  33         # queue of queries with maybe a domid, see enqueue_query
  34         self._queue=[]
  35         # global prelude object
  36         self.prelude=Prelude(css_files=['css/plugin.css','css/onelab_marko.css',])
  37
  38     # record known plugins hashed on their domid
  39     def record_plugin (self, plugin):
  40         self._plugins[plugin.domid]=plugin
  41
  42     def get_plugin (self, domid):
  43         return self._plugins.get(domid,None)
  44
  45     # not sure this is useful at all
  46 #    def reset_queue (self):
  47 #        self._queries = set()
  48 #        self._queue = []
  49
  50     # this method adds a query to the page
  51     # the query will be exposed to js when calling expose_queries
  52     # additionally if run_it is set to True, this query will be asynchroneously triggered on page load
  53     # in this case (exec=True) the js async callback (see manifold.asynchroneous_success)
  54     # offers the option to deliver the result to a specific DOM elt (in this case, set domid)
  55     # otherwise (i.e. if domid not provided), it goes through the pubsub system (so all plugins can receive it)
  56     #
  57     # NOTE:
  58     # analyzed_query is required because it contains query_uuid that the
  59     # plugins initialized in the python part will listen to. When a result is
  60     # received in javascript, subresults should be publish to the appropriate
  61     # query_uuid.
  62     #
  63     def enqueue_query (self, query, run_it=True, domid=None, analyzed_query=None):
  64         # _queries is the set of all known queries
  65         # XXX complex XXX self._queries = self._queries.union(set( [ query, ] ))
  66         self._queries.add((query, analyzed_query))
  67         # _queue is the list of queries that need to be triggered, with an optional domid
  68         # we only do this if run_it is set
  69         if run_it: self._queue.append ( (query.query_uuid,domid) )
  70
  71     # return the javascript code for exposing queries
  72     # all queries are inserted in the global manifold object
  73     # in addition, the ones enqueued with 'run_it=True' are triggered
  74     def expose_queries (self):
  75         # compute variables to expose to the template
  76         env = {}
  77         # expose the json definition of all queries
  78         env['queries_json'] = [ query.to_json(analyzed_query=aq) for (query, aq) in self._queries ]
  79         def query_publish_dom_tuple (a,b):
  80             result={'query_uuid':a}
  81             if b: result['domid']=b
  82             return result
  83         env['query_exec_tuples'] = [ query_publish_dom_tuple (a,b) for (a,b) in self._queue ]
  84         javascript = render_to_string ("page-queries.js",env)
  85         self.add_js_chunks (javascript)
  86 #        self.reset_queue()
  87         # unconditionnally expose MANIFOLD_URL, this is small and manifold.js uses that for various messages
  88         self.expose_js_manifold_config()
  89
  90
  91     # needs to be called explicitly and only when metadata is actually required
  92     # in particular user needs to be logged
  93     def get_metadata (self):
  94         # look in session's cache - we don't want to retrieve this for every request
  95         session=self.request.session
  96
  97         if 'manifold' not in session:
  98             session['manifold'] = {}
  99         manifold = session['manifold']
 100
 101         # if cached, use it
 102         if 'metadata' in manifold and isinstance(manifold['metadata'],MetaData):
 103             if debug: print "Page.get_metadata: return cached value"
 104             return manifold['metadata']
 105
 106         metadata_auth = {'AuthMethod':'anonymous'}
 107
 108         metadata=MetaData (metadata_auth)
 109         metadata.fetch(self.request)
 110         # store it for next time
 111         manifold['metadata']=metadata
 112         if debug: print "Page.get_metadata: return new value"
 113         return metadata
 114
 115     def expose_js_metadata (self):
 116         # expose global MANIFOLD_METADATA as a js variable
 117         # xxx this is fetched synchroneously..
 118         self.add_js_init_chunks("var MANIFOLD_METADATA =" + self.get_metadata().to_json() + ";")
 119
 120     def expose_js_manifold_config (self):
 121         config=Config()
 122         self.add_js_init_chunks(config.manifold_js_export())
 123
 124     #################### requirements/prelude management
 125     # just forward to self.prelude - see decorator above
 126     @to_prelude
 127     def add_js_files (self):pass
 128     @to_prelude
 129     def add_css_files (self):pass
 130     @to_prelude
 131     def add_js_init_chunks (self):pass
 132     @to_prelude
 133     def add_js_chunks (self):pass
 134     @to_prelude
 135     def add_css_chunks (self):pass
 136     @to_prelude
 137     def prelude_env (self):pass