a8bc0f4268bb4f428164f84991a5d49db977fc90
[myslice.git] / 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 unfold.prelude import Prelude
8 from manifold.manifoldapi import ManifoldAPI
9 from myslice.config import Config
10
11 # decorator to deflect calls on this Page to its prelude
12 def to_prelude (method):
13     def actual (self, *args, **kwds):
14         prelude_method=Prelude.__dict__[method.__name__]
15         return prelude_method(self.prelude,*args, **kwds)
16     return actual
17
18 class Page:
19
20     def __init__ (self, request):
21         self.request=request
22         # all plugins mentioned in this page
23         self._plugins = {}
24         # queue of queries
25         self._queue=[]
26         # global prelude object
27         self.prelude=Prelude(css_files='css/plugin.css')
28         # load metadata
29         self._metadata={}
30         # do not call this uncondionnally as we might not even have logged in
31         # self.expose_js_metadata()
32
33     # record known plugins hashed on their domid
34     def record_plugin (self, plugin):
35         self._plugins[plugin.domid]=plugin
36
37     def get_plugin (self, domid):
38         return self._plugins.get(domid,None)
39     
40     def reset_queue (self):
41         self._queue = []
42
43     # the js async methods (see manifold_async_success)
44     # offer the option to deliver the result to a specific DOM elt
45     # otherwise (i.e. if domid not provided) 
46     # it goes through the pubsub using query's uuid
47     def enqueue_query (self, query, domid=None):
48         self._queue.append ( (query,domid,) )
49
50     # return the javascript that triggers all the queries
51     def exec_queue_asynchroneously (self):
52         js = ""
53         js += "var async_queries = new Array();\n"
54         for (query,domid) in self._queue:
55             qjson=query.to_json()
56             id="'%s'"%domid if domid else 'undefined'
57             js += "async_queries.push({'query':%(qjson)s, 'id':%(id)s});\n"%locals()
58         js += "onFunctionAvailable('manifold_async_exec', function() {manifold_async_exec(async_queries);}, this, true);"
59         self.reset_queue()
60         # run only once the document is ready
61         js = "$(document).ready(function(){%(js)s})"%locals()
62         self.add_js_chunks (js)
63
64
65     def expose_js_metadata(self):
66         request=self.request
67         # xxx this code should probably not be called unconditionnally at page creation time
68         # because we're not sure a user is logged in so we might have no session...
69         if 'manifold' not in request.session:
70             print "Page.expose_js_metadata: no 'manifold' in session... - skipping"
71             return
72         # use cached version if present
73         if 'metadata' in request.session.keys(): 
74             self._metadata = request.session['metadata']
75         else:
76             manifold_api_session_auth = request.session['manifold']['auth']
77             manifold_api = ManifoldAPI(auth=manifold_api_session_auth)
78         
79             fields = ['table', 'column.column',
80                   'column.description','column.header', 'column.title',
81                   'column.unit', 'column.info_type',
82                   'column.resource_type', 'column.value_type',
83                   'column.allowed_values', 'column.platforms.platform',
84                   'column.platforms.platform_url']
85
86             results = manifold_api.Get('metadata:table', [], [], fields)
87
88             for res in results:
89                  method = res['table']
90                  self._metadata[method] = res
91
92             request.session['metadata'] = self._metadata
93
94         javascript = "all_headers=" + json.dumps(self._metadata) + ";"
95         self.add_js_chunks(javascript)
96
97     def metadata_get_fields(self, method):
98         return self._metadata[method]['column'].sort()
99         
100     def expose_js_manifold_config (self):
101         self.add_js_chunks(Config.manifold_js_export())
102
103     #################### requirements/prelude management
104     # just forward to self.prelude - see decorator above
105     @to_prelude
106     def add_js_files (self):pass
107     @to_prelude
108     def add_css_files (self):pass
109     @to_prelude
110     def add_js_chunks (self):pass
111     @to_prelude
112     def add_css_chunks (self):pass
113     @to_prelude
114     def prelude_env (self):pass