Merge branch 'onelab' of ssh://git.onelab.eu/git/myslice into onelab
[myslice.git] / plugins / univbrisfoam / __init__.py
1 from unfold.plugin import Plugin
2
3 class UnivbrisFoam (Plugin):
4
5     """
6
7 ////////////////////////////////////////
8
9 modified querytable for univbris foam
10 ///////////////////////////////////////
11
12 A plugin for displaying a query as a list
13
14 More accurately, we consider a subject entity (say, a slice) 
15 that can be linked to any number of related entities (say, resources, or users)
16 The 'query' argument will correspond to the subject, while
17 'query_all' will fetch the complete list of 
18 possible candidates for the relationship.
19
20 Current implementation makes the following assumptions
21 * query will only retrieve for the related items a list of fields
22   that corresponds to the initial set of fields displayed in the table
23 * query_all on the contrary is expected to return the complete set of 
24   available attributes that may be of interest, so that using a QueryEditor
25   one can easily extend this table without having to query the backend
26 * checkboxes is a boolean flag, set to true if a rightmost column
27   with checkboxes is desired
28 * optionally pass columns as the initial set of columns
29   if None then this is taken from the query's fields
30 * init_key is the name of a column that should appear in both queries
31   and used internally in the plugin for checkboxes initialization. 
32   If not specified, metadata will be used to find out a primary key.
33   However in the case of nodes & slice for example, the default key
34   as returned by the metadata would be 'urn', but 'urn' could only 
35   be used for this purpose if it gets displayed initially, which is
36   not necessarily a good idea.
37   This is why a slice view would use 'hrn' here instead.
38 * datatables_options are passed to dataTables as-is; 
39   however please refrain from passing an 'aoColumns' 
40   as we use 'aoColumnDefs' instead.
41 """
42
43     def __init__ (self, query=None, query_all=None, sync_query=None,
44                   checkboxes=False, columns=None, 
45                   init_key=None,
46                   datatables_options={}, **settings):
47         Plugin.__init__ (self, **settings)
48         self.query          = query
49         # Until we have a proper way to access queries in Python
50         self.query_all      = query_all
51         self.query_all_uuid = query_all.query_uuid if query_all else None
52         self.sync_query_uuid = sync_query.query_uuid if sync_query else None
53         self.checkboxes     = checkboxes
54         # XXX We need to have some hidden columns until we properly handle dynamic queries
55         if columns is not None:
56             self.columns=columns
57             self.hidden_columns = []
58         elif self.query:
59             self.columns = list (['testbed','head node id/port','tail node id/port','link type','selected'])
60             #replace production
61             #self.columns = self.query.fields
62             if query_all:
63                 #replace production
64                 self.hidden_columns = []
65                 # We need a list because sets are not JSON-serializable
66                 #self.hidden_columns = #list(self.query_all.fields - self.query.fields)
67             else:
68                 self.hidden_columns = []
69         else:
70             self.columns = []
71             self.hidden_columns = []
72         self.init_key=init_key
73         self.datatables_options=datatables_options
74         # if checkboxes were required, we tell datatables about this column's type
75         # so that sorting can take place on a selected-first basis (or -last of course)
76         # this relies on the template exposing the checkboxes 'th' with class 'checkbox'
77         if self.checkboxes:
78             # we use aoColumnDefs rather than aoColumns -- ignore user-provided aoColumns
79             if 'aoColumns' in self.datatables_options:
80                 print 'WARNING: querytable uses aoColumnDefs, your aoColumns spec. is discarded'
81                 del self.datatables_options['aoColumns']
82             # set aoColumnDefs in datatables_options - might already have stuff in there
83             aoColumnDefs = self.datatables_options.setdefault ('aoColumnDefs',[])
84             # here 'checkbox' is the class that we give to the <th> dom elem
85             # dom-checkbox is a sorting type that we define in querytable.js
86             aoColumnDefs.append ( {'aTargets': ['checkbox'], 'sSortDataType': 'dom-checkbox' } )
87
88     def template_file (self):
89         return "univbrisfoam.html"
90
91     def template_env (self, request):
92         env={}
93         env.update(self.__dict__)
94         env['columns']=self.columns
95         return env
96
97     def requirements (self):
98         reqs = {
99             'js_files' : [ "js/spin-presets.js", "js/spin.min.js", "js/jquery.spin.js", 
100                            "js/dataTables.js", "js/dataTables.bootstrap.js", "js/with-datatables.js",
101                            "js/manifold.js", "js/manifold-query.js", 
102                            "js/unfold-helper.js",
103                           # querytable.js needs to be loaded after dataTables.js as it extends 
104                           # dataTableExt.afnSortData
105                            "js/univbrisfoam.js",#"js/univbrisfv.js",
106                            ] ,
107             'css_files': [ "css/dataTables.bootstrap.css",
108                            # hopefully temporary, when/if datatables supports sPaginationType=bootstrap3
109                            # for now we use full_numbers, with our own ad hoc css 
110                            "css/dataTables.full_numbers.css",
111                            "css/univbrisfoam.css" , #"css/univbrisfv.css"
112                            ],
113             }
114         return reqs
115
116     # the list of things passed to the js plugin
117     def json_settings_list (self):
118         return ['plugin_uuid', 'domid', 
119                 'query_uuid', 'query_all_uuid', 'sync_query_uuid',
120                 'checkboxes', 'datatables_options', 
121                 'hidden_columns', 'init_key',]