Plugin VTAM by Frederic Francois (Univ Bristol) integrated into slice view
[unfold.git] / plugins / univbrisvtam / static / js / univbrisvtam.js
diff --git a/plugins/univbrisvtam/static/js/univbrisvtam.js b/plugins/univbrisvtam/static/js/univbrisvtam.js
new file mode 100644 (file)
index 0000000..13bea94
--- /dev/null
@@ -0,0 +1,663 @@
+/**
+ * Description: display a query result in a datatables-powered <table>
+ * Copyright (c) 2012-2013 UPMC Sorbonne Universite - INRIA
+ * License: GPLv3
+ */ 
+
+(function($){
+
+    var debug=false;
+    debug=true
+
+    pk_flowspace_index=0;
+    opt_flowspace_index=0;
+    pk_mode=0;
+    fvf_add=1;
+    fvf_nrow=0;
+    
+
+    var UnivbrisVtam = Plugin.extend({
+
+       
+        init: function(options, element) {
+           this.classname="univbrisvtam";
+            this._super(options, element);
+               
+               this.elmt().on('show', this, this.on_show);
+            this.elmt().on('shown.bs.tab', this, this.on_show);
+            this.elmt().on('resize', this, this.on_resize);
+
+            // We need to remember the active filter for datatables filtering
+            this.filters = Array(); 
+
+            // an internal buffer for records that are 'in' and thus need to be checked 
+            this.buffered_records_to_check = [];
+           // an internal buffer for keeping lines and display them in one call to fnAddData
+           this.buffered_lines = [];
+
+           var keys = manifold.metadata.get_key(this.object);
+           this.canonical_key = (keys && keys.length == 1) ? keys[0] : undefined;
+           this.init_key = this.options.init_key;
+           // have init_key default to canonical_key
+           this.init_key = this.init_key || this.canonical_key;
+           // sanity check
+           if ( ! this.init_key ) messages.warning ("UnivbrisVtam : cannot find init_key");
+           if ( ! this.canonical_key ) messages.warning ("UnivbrisVtam : cannot find canonical_key");
+           if (debug) messages.debug("UnivbrisVtam: canonical_key="+this.canonical_key+" init_key="+this.init_key);
+
+            /* GUI setup and event binding */
+            this.initialize_table();
+           
+        },
+
+        /* PLUGIN EVENTS */
+
+        on_show: function(e) {
+           if (debug) messages.debug("UnivbrisVtam.on_show");
+            var self = e.data;
+            self.table.fnAdjustColumnSizing();
+       },        
+
+        on_resize: function(e) {
+           if (debug) messages.debug("UnivbrisVtam.on_resize");
+            var self = e.data;
+            self.table.fnAdjustColumnSizing();
+       },        
+
+        /* GUI EVENTS */
+
+        /* GUI MANIPULATION */
+
+        initialize_table: function() 
+        {
+
+           
+            /* Transforms the table into DataTable, and keep a pointer to it */
+            var self = this;
+           //alert(self.options);
+            var actual_options = {
+                // Customize the position of Datatables elements (length,filter,button,...)
+                // we use a fluid row on top and another on the bottom, making sure we take 12 grid elt's each time
+                //sDom: "<'row'<'col-xs-5'l><'col-xs-1'r><'col-xs-6'f>>t<'row'<'col-xs-5'i><'col-xs-7'p>>",
+               sDom: "<'row'<'col-xs-5'l><'col-xs-5'r><'col-xs-1'r><'col-xs-6'f>>t<'row'<'col-xs-5'i><'col-xs-7'p>><'buttons'>",
+               //sDom: "<'row'<'col-xs-9'r>t<'buttons'>",
+               // XXX as of sept. 2013, I cannot locate a bootstrap3-friendly mode for now
+               // hopefully this would come with dataTables v1.10 ?
+               // in any case, search for 'sPaginationType' all over the code for more comments
+                sPaginationType: 'bootstrap',
+                // Handle the null values & the error : Datatables warning Requested unknown parameter
+                // http://datatables.net/forums/discussion/5331/datatables-warning-...-requested-unknown-parameter/p2
+                aoColumnDefs: [{sDefaultContent: '',aTargets: [ '_all' ]}],
+                // WARNING: this one causes tables in a 'tabs' that are not exposed at the time this is run to show up empty
+                // sScrollX: '100%',       /* Horizontal scrolling */
+                bProcessing: true,      /* Loading */
+                fnDrawCallback: function() { self._querytable_draw_callback.call(self);}
+               //fnFooterCallback: function() {self._UnivbrisVtam_footer_callback.call(self,nFoot, aData, iStart, iEnd, aiDisplay)};}
+                // XXX use $.proxy here !
+            };
+            // the intention here is that options.datatables_options as coming from the python object take precedence
+           // xxx DISABLED by jordan: was causing errors in datatables.js
+           // xxx turned back on by Thierry - this is the code that takes python-provided options into account
+           // check your datatables_options tag instead 
+           // however, we have to accumulate in aoColumnDefs from here (above) 
+           // and from the python wrapper (checkboxes management, plus any user-provided aoColumnDefs)
+           if ( 'aoColumnDefs' in this.options.datatables_options) {
+               actual_options['aoColumnDefs']=this.options.datatables_options['aoColumnDefs'].concat(actual_options['aoColumnDefs']);
+               delete this.options.datatables_options['aoColumnDefs'];
+           }
+           $.extend(actual_options, this.options.datatables_options );
+
+           
+            this.table = $("#univbris_vtam__table").dataTable(actual_options); 
+           
+           
+           
+           //alert(this.table.$("name"));
+
+            /* Setup the SelectAll button in the dataTable header */
+            /* xxx not sure this is still working */
+            var oSelectAll = $('#datatableSelectAll-'+ this.options.plugin_uuid);
+            oSelectAll.html("<span class='glyphicon glyphicon-ok' style='float:right;display:inline-block;'></span>Select All");
+            oSelectAll.button();
+            oSelectAll.css('font-size','11px');
+            oSelectAll.css('float','right');
+            oSelectAll.css('margin-right','15px');
+            oSelectAll.css('margin-bottom','5px');
+            oSelectAll.unbind('click');
+            oSelectAll.click(this._selectAll);
+
+            /* Add a filtering function to the current table 
+             * Note: we use closure to get access to the 'options'
+             */
+            $.fn.dataTableExt.afnFiltering.push(function( oSettings, aData, iDataIndex ) { 
+                /* No filtering if the table does not match */
+                if (oSettings.nTable.id != self.options.plugin_uuid + '__table')
+                    return true;
+                return self._querytable_filter.call(self, oSettings, aData, iDataIndex);
+            });
+
+            /* Processing hidden_columns */
+            $.each(this.options.hidden_columns, function(i, field) {
+                //manifold.raise_event(self.options.query_all_uuid, FIELD_REMOVED, field);
+               //alert (field);
+                self.hide_column(field);
+               //self.hide_column(field);
+            });
+
+
+           this._querytable_draw_callback();   
+
+        }, // initialize_table
+
+
+       fnCreateVms:function(e){
+               console.log("building json to send to backend");
+
+               var testbeds=[];
+               
+
+               try{
+                        var rows = $("#univbris_vtam__table").dataTable().fnGetNodes();
+                        if (rows.length<=0){
+                               throw("no vm specified");
+                        }
+                        else{
+                               for(var i=0;i<rows.length;i++){
+                                       //console.log(rows[i].cells[2].outerHTML.text());
+                                       var htmlStr=rows[i].cells[2].outerHTML;
+                                       var parser=new DOMParser();
+                                       var htmlDoc=parser.parseFromString(htmlStr, "text/html");
+                                       var para=htmlDoc.getElementsByTagName('p');
+                                       //console.log(para.item(0).id);
+                                       
+                                       //build row json
+                                       var tp_row=para.item(0).id.split(",");
+                                       var d_row={};
+                                       for (var a=0;a<tp_row.length;a++){
+                                               var tp=tp_row[a].split(":");
+                                               d_row[tp[0]]=tp[1];
+                                       }
+
+                                       function findTestbedIndex( _testbeds, _name){
+                                               var index=-1;
+                                               for(var a=0;a<_testbeds.length;a++){
+                                                       if(_testbeds[a].name==_name){
+                                                               index=a;
+                                                       }
+                                               }
+                                               return index;
+                                       }
+
+                                       function findServerIndex( _testbeds, _testbedindex, _name){
+                                               var index=-1;
+                                               for(var a=0;a<_testbeds[_testbedindex].vt_servers.length;a++){
+                                                       if(_testbeds[_testbedindex].vt_servers[a].name==_name){
+                                                               index=a;
+                                                       }
+                                               }
+                                               return index;
+                                       }
+                                       
+                                       var testbedindex=findTestbedIndex(testbeds,d_row['testbed']);
+                                       if (testbedindex!=-1){
+                                               var serverindex=findServerIndex(testbeds,testbedindex,d_row['vt_server']);
+                                               if (serverindex!=-1){
+                                                       //console.log("server:",serverindex);
+                                                       //console.log(testbeds[testbedindex].vt_servers[serverindex].vm_names);
+                                                       testbeds[testbedindex].vt_servers[serverindex].vm_names.push(d_row['vm_name']);
+                                               }
+                                               else{
+                                                       var vt_server={};
+                                                       vt_server['name']=d_row['vt_server'];
+                                                       vt_server['vm_names']=[];
+                                                       vt_server['vm_names'].push(d_row['vm_name']);
+                                                       testbeds[testbedindex].vt_servers.push(vt_server);
+                                               }
+
+                                       }
+                                       else{
+                                               var testbed={};
+                                               testbed['name']=d_row['testbed'];
+                                               testbed['vt_servers']=[];
+                                               var vt_server={};
+                                               vt_server['name']=d_row['vt_server'];
+                                               vt_server['vm_names']=[];
+                                               vt_server['vm_names'].push(d_row['vm_name']);
+                                               testbed['vt_servers'].push(vt_server);
+                                               testbeds.push(testbed);
+                                       }
+
+                               }
+
+                               var rspecs = JSON.stringify(testbeds);
+                               console.log(rspecs);
+                       }
+
+               }
+               catch(err){
+                       alert(err)
+               }               
+       },
+
+
+
+       fnAddVm:function(e){
+               //this.hideFvfError(e);
+               $('#uob_vm_name').removeClass('error');
+               $("#uob_vm_name").val("");
+               jQuery('#uob_vm_name_error').hide();
+               jQuery("#univbris_vtam").hide();
+               jQuery("#univbris_vtam_form").show();
+       },
+
+       
+
+
+
+
+       
+
+       fnDelete:function(e){
+                       e.preventDefault();
+                       var nRow = $(this).parents('tr')[0];
+                       this.table = $("#univbris_vtam__table").dataTable();
+                       this.table.fnDeleteRow( nRow );
+       },
+
+
+
+
+       
+
+        /**
+         * @brief Determine index of key in the table columns 
+         * @param key
+         * @param cols
+         */
+        getColIndex: function(key, cols) {
+            var tabIndex = $.map(cols, function(x, i) { if (x.sTitle == key) return i; });
+            return (tabIndex.length > 0) ? tabIndex[0] : -1;
+        }, // getColIndex
+
+
+       
+
+        new_record: function(record)
+        {
+           
+        },
+
+        clear_table: function()
+        {
+            this.table.fnClearTable();
+        },
+
+        redraw_table: function()
+        {
+            this.table.fnDraw();
+        },
+
+        show_column: function(field)
+        {
+            var oSettings = this.table.fnSettings();
+            var cols = oSettings.aoColumns;
+            var index = this.getColIndex(field,cols);
+            if (index != -1)
+                this.table.fnSetColumnVis(index, true);
+        },
+
+        hide_column: function(field)
+        {
+            var oSettings = this.table.fnSettings();
+            var cols = oSettings.aoColumns;
+            var index = this.getColIndex(field,cols);
+           //index=-1;
+           //alert(field + ": index: " + index );
+            if (index != -1)
+               //alert(field + ": hidden with index: " + index );
+                this.table.fnSetColumnVis(index, false);
+        },
+
+       // this is used at init-time, at which point only init_key can make sense
+       // (because the argument record, if it comes from query, might not have canonical_key set
+       set_checkbox_from_record: function (record, checked) {
+            if (checked === undefined) checked = true;
+           var init_id = record[this.init_key];
+           if (debug) messages.debug("UnivbrisVtam.set_checkbox_from_record, init_id="+init_id);
+           // using table.$ to search inside elements that are not visible
+           var element = this.table.$('[init_id="'+init_id+'"]');
+           element.attr('checked',checked);
+       },
+
+       // id relates to canonical_key
+       set_checkbox_from_data: function (id, checked) {
+            if (checked === undefined) checked = true;
+           if (debug) messages.debug("UnivbrisVtam.set_checkbox_from_data, id="+id);
+           // using table.$ to search inside elements that are not visible
+           var element = this.table.$("[id='"+id+"']");
+           element.attr('checked',checked);
+       },
+
+        /*************************** QUERY HANDLER ****************************/
+
+        on_filter_added: function(filter)
+        {
+            this.filters.push(filter);
+            this.redraw_table();
+        },
+
+        on_filter_removed: function(filter)
+        {
+            // Remove corresponding filters
+            this.filters = $.grep(this.filters, function(x) {
+                return x != filter;
+            });
+            this.redraw_table();
+        },
+        
+        on_filter_clear: function()
+        {
+            // XXX
+            this.redraw_table();
+        },
+
+        on_field_added: function(field)
+        {
+            this.show_column(field);
+        },
+
+        on_field_removed: function(field)
+        {
+            this.hide_column(field);
+        },
+
+        on_field_clear: function()
+        {
+            alert('UnivbrisVtam::clear_fields() not implemented');
+        },
+
+        /* XXX TODO: make this generic a plugin has to subscribe to a set of Queries to avoid duplicated code ! */
+        /*************************** ALL QUERY HANDLER ****************************/
+
+        on_all_filter_added: function(filter)
+        {
+            // XXX
+            this.redraw_table();
+        },
+
+        on_all_filter_removed: function(filter)
+        {
+            // XXX
+            this.redraw_table();
+        },
+        
+        on_all_filter_clear: function()
+        {
+            // XXX
+            this.redraw_table();
+        },
+
+        on_all_field_added: function(field)
+        {
+            this.show_column(field);
+        },
+
+        on_all_field_removed: function(field)
+        {
+            this.hide_column(field);
+        },
+
+        on_all_field_clear: function()
+        {
+            alert('UnivbrisVtam::clear_fields() not implemented');
+        },
+
+
+        /*************************** RECORD HANDLER ***************************/
+
+        on_new_record: function(record)
+        {
+        },
+
+        on_clear_records: function()
+        {
+        },
+
+        // Could be the default in parent
+        on_query_in_progress: function()
+        {
+            this.spin();
+        },
+
+        on_query_done: function()
+        {
+            this.received_query = true;
+           // unspin once we have received both
+            if (this.received_all_query && this.received_query) this.unspin();
+        },
+        
+        on_field_state_changed: function(data)
+        {
+            switch(data.request) {
+                case FIELD_REQUEST_ADD:
+                case FIELD_REQUEST_ADD_RESET:
+                    this.set_checkbox_from_data(data.value, true);
+                    break;
+                case FIELD_REQUEST_REMOVE:
+                case FIELD_REQUEST_REMOVE_RESET:
+                    this.set_checkbox_from_data(data.value, false);
+                    break;
+                default:
+                    break;
+            }
+        },
+
+        /* XXX TODO: make this generic a plugin has to subscribe to a set of Queries to avoid duplicated code ! */
+        // all
+        on_all_field_state_changed: function(data)
+        {
+            switch(data.request) {
+                case FIELD_REQUEST_ADD:
+                case FIELD_REQUEST_ADD_RESET:
+                    this.set_checkboxfrom_data(data.value, true);
+                    break;
+                case FIELD_REQUEST_REMOVE:
+                case FIELD_REQUEST_REMOVE_RESET:
+                    this.set_checkbox_from_data(data.value, false);
+                    break;
+                default:
+                    break;
+            }
+        },
+
+        on_all_new_record: function(record)
+        {
+            this.new_record(record);
+        },
+
+        on_all_clear_records: function()
+        {
+            this.clear_table();
+
+        },
+
+        on_all_query_in_progress: function()
+        {
+            // XXX parent
+            this.spin();
+        }, // on_all_query_in_progress
+
+        on_all_query_done: function()
+        {
+           if (debug) messages.debug("1-shot initializing dataTables content with " + this.buffered_lines.length + " lines");
+
+
+           //this.table.fnAddData (this.buffered_lines);
+           this.buffered_lines=[];
+           
+            var self = this;
+           // if we've already received the slice query, we have not been able to set 
+           // checkboxes on the fly at that time (dom not yet created)
+            $.each(this.buffered_records_to_check, function(i, record) {
+               if (debug) messages.debug ("querytable delayed turning on checkbox " + i + " record= " + record);
+                self.set_checkbox_from_record(record, true);
+            });
+           this.buffered_records_to_check = [];
+
+            this.received_all_query = true;
+           // unspin once we have received both
+            if (this.received_all_query && this.received_query) this.unspin();
+
+        }, // on_all_query_done
+
+        /************************** PRIVATE METHODS ***************************/
+
+        /** 
+         * @brief QueryTable filtering function
+         */
+        _querytable_filter: function(oSettings, aData, iDataIndex)
+        {
+            var ret = true;
+            $.each (this.filters, function(index, filter) { 
+                /* XXX How to manage checkbox ? */
+                var key = filter[0]; 
+                var op = filter[1];
+                var value = filter[2];
+
+                /* Determine index of key in the table columns */
+                var col = $.map(oSettings.aoColumns, function(x, i) {if (x.sTitle == key) return i;})[0];
+
+                /* Unknown key: no filtering */
+                if (typeof(col) == 'undefined')
+                    return;
+
+                col_value=unfold.get_value(aData[col]);
+                /* Test whether current filter is compatible with the column */
+                if (op == '=' || op == '==') {
+                    if ( col_value != value || col_value==null || col_value=="" || col_value=="n/a")
+                        ret = false;
+                }else if (op == '!=') {
+                    if ( col_value == value || col_value==null || col_value=="" || col_value=="n/a")
+                        ret = false;
+                } else if(op=='<') {
+                    if ( parseFloat(col_value) >= value || col_value==null || col_value=="" || col_value=="n/a")
+                        ret = false;
+                } else if(op=='>') {
+                    if ( parseFloat(col_value) <= value || col_value==null || col_value=="" || col_value=="n/a")
+                        ret = false;
+                } else if(op=='<=' || op=='≤') {
+                    if ( parseFloat(col_value) > value || col_value==null || col_value=="" || col_value=="n/a")
+                        ret = false;
+                } else if(op=='>=' || op=='≥') {
+                    if ( parseFloat(col_value) < value || col_value==null || col_value=="" || col_value=="n/a")
+                        ret = false;
+                }else{
+                    // How to break out of a loop ?
+                    alert("filter not supported");
+                    return false;
+                }
+
+            });
+            return ret;
+        },
+
+        _querytable_draw_callback: function()
+        {
+            /* 
+             * Handle clicks on checkboxes: reassociate checkbox click every time
+             * the table is redrawn    
+             */
+            this.elts('querytable-checkbox').unbind('click').click(this, this._check_click);
+           $("#add_vm").unbind('click').click(this, this.fnAddVm);
+           $("#submit_vms").unbind('click').click(this, this.fnCreateVms);
+           $('#univbris_vtam__table .delete').unbind('click').click(this, this.fnDelete);
+           /*var edits=this.elts.all.find('.edit');
+           edits.each(function(){
+               this.unbind('click').click(this,this.fnEdit);
+            }
+           */
+            if (!this.table)
+                return;
+
+            /* Remove pagination if we show only a few results */
+            var wrapper = this.table; //.parent().parent().parent();
+            var rowsPerPage = this.table.fnSettings()._iDisplayLength;
+            var rowsToShow = this.table.fnSettings().fnRecordsDisplay();
+            var minRowsPerPage = this.table.fnSettings().aLengthMenu[0];
+
+            if ( rowsToShow <= rowsPerPage || rowsPerPage == -1 ) {
+                $('.querytable_paginate', wrapper).css('visibility', 'hidden');
+            } else {
+                $('.querytable_paginate', wrapper).css('visibility', 'visible');
+            }
+
+            if ( rowsToShow <= minRowsPerPage ) {
+                $('.querytable_length', wrapper).css('visibility', 'hidden');
+            } else {
+                $('.querytable_length', wrapper).css('visibility', 'visible');
+            }
+
+           
+
+
+        },
+
+
+
+        _check_click: function(e) 
+        {
+            e.stopPropagation();
+
+            var self = e.data;
+           var id=this.id;
+
+            // this.id = key of object to be added... what about multiple keys ?
+           if (debug) messages.debug("querytable._check_click key="+this.canonical_key+"->"+id+" checked="+this.checked);
+            //manifold.raise_event(self.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, id);
+            //return false; // prevent checkbox to be checked, waiting response from manifold plugin api
+            
+        },
+
+        _selectAll: function() 
+        {
+            // requires jQuery id
+            var uuid=this.id.split("-");
+            var oTable=$("#querytable-"+uuid[1]).dataTable();
+            // Function available in QueryTable 1.9.x
+            // Filter : displayed data only
+            var filterData = oTable._('tr', {"filter":"applied"});   
+            /* TODO: WARNING if too many nodes selected, use filters to reduce nuber of nodes */        
+            if(filterData.length<=100){
+                $.each(filterData, function(index, obj) {
+                    var last=$(obj).last();
+                    var key_value=unfold.get_value(last[0]);
+                    if(typeof($(last[0]).attr('checked'))=="undefined"){
+                        $.publish('selected', 'add/'+key_value);
+                    }
+                });
+            }
+        },
+
+    });
+
+   
+
+    $.plugin('UnivbrisVtam', UnivbrisVtam);
+
+  /* define the 'dom-checkbox' type for sorting in datatables 
+     http://datatables.net/examples/plug-ins/dom_sort.html
+     using trial and error I found that the actual column number
+     was in fact given as a third argument, and not second 
+     as the various online resources had it - go figure */
+    $.fn.dataTableExt.afnSortData['dom-checkbox'] = function  ( oSettings, _, iColumn ) {
+       return $.map( oSettings.oApi._fnGetTrNodes(oSettings), function (tr, i) {
+           return result=$('td:eq('+iColumn+') input', tr).prop('checked') ? '1' : '0';
+       } );
+    }
+
+   
+
+})(jQuery);
+
+
+