slice page working. added temporarily core and util classes from manifold core
[unfold.git] / plugins / hazelnut / hazelnut.js
index 861f33c..dbe29b5 100644 (file)
@@ -1,8 +1,5 @@
 /**
- * MySlice Hazelnut plugin
- * URL: http://trac.myslice.info
  * Description: display a query result in a datatables-powered <table>
- * Author: The MySlice Team
  * Copyright (c) 2012 UPMC Sorbonne Universite - INRIA
  * License: GPLv3
  */
             return this.each(function() {
                 var $this = $(this);
                 /* Events */
-                $(this).on('show.Datatables', methods.show);
+                $this.on('show.Datatables', methods.show);
 
                 /* An object that will hold private variables and methods */
                var hazelnut = new Hazelnut (options);
-                $(this).data('Hazelnut', hazelnut);
+                $this.data('Hazelnut', hazelnut);
 
                 var query_channel   = '/query/' + options.query_uuid + '/changed';
                 var update_channel  = '/update-set/' + options.query_uuid;
                 var results_channel = '/results/' + options.query_uuid + '/changed';
 
-                $.subscribe(query_channel,  function(e, query) { hazelnut.set_query(query); });;
+               // xxx not tested yet
+                $.subscribe(query_channel,  function(e, query) { hazelnut.set_query(query); });
+               // xxx not tested yet
                 $.subscribe(update_channel, function(e, resources, instance) { hazelnut.set_resources(resources, instance); });
+               // expected to work
                 $.subscribe(results_channel, $this, function(e, rows) { hazelnut.update_plugin(e,rows); });
+               if (debug) messages.debug("hazelnut '" + this.id + "' subscribed to e.g." + results_channel);
 
             }); // this.each
         }, // init
@@ -77,6 +78,7 @@
         show : function( ) {
            var $this=$(this);
            // xxx wtf. why [1] ? would expect 0...
+           if (debug) messages.debug("Hitting suspicious line in hazelnut.show");
             var oTable = $($('.dataTable', $this)[1]).dataTable();
             oTable.fnAdjustColumnSizing()
     
     function Hazelnut(options) {
         /* member variables */
         this.options = options;
-        /* constructor */
-        this.table = null;
-       // xxx thierry : init this here - it was not, I expect this relied on set_query somehow..
+       // xxx thierry : initialize this here - it was not, I expect this relied on set_query somehow..
         //this.current_query = null;
        this.current_query=manifold.find_query(this.options.query_uuid);
-       if (debug) console.log("Hazelnut constructor: have set current_query -> " + this.current_query);
+//     if (debug) messages.debug("Hazelnut constructor: have set current_query -> " + this.current_query.__repr());
        this.query_update = null;
         this.current_resources = Array();
 
         var object = this;
 
         /* Transforms the table into DataTable, and keep a pointer to it */
-        this.table = $('#hazelnut-' + options.plugin_uuid).dataTable({
+       actual_options = {
             // Customize the position of Datatables elements (length,filter,button,...)
-            // inspired from : 
-            // http://datatables.net/release-datatables/examples/advanced_init/dom_toolbar.html
-            // http://www.datatables.net/forums/discussion/3914/adding-buttons-to-header-or-footer/p1
-            //"sDom": 'lf<"#datatableSelectAll-'+ options.plugin_uuid+'">rtip',
-            sDom: '<"H"Tfr>t<"F"ip>',
-            bJQueryUI: true,
-            sPaginationType: 'full_numbers',
+           // we use a fluid row on top and another on the bottom, making sure we take 12 grid elt's each time
+           sDom: "<'row-fluid'<'span5'l><'span1'r><'span6'f>>t<'row-fluid'<'span5'i><'span7'p>>",
+            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' ]}],
-            bRetrieve: true,
-            sScrollX: '100%',       /* Horizontal scrolling */
+           // 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 */
-            fnRowCallback: function( nRow, aData, iDisplayIndex, iDisplayIndexFull ) {
-                $(nRow).attr('id', get_value(aData[3]));
-                return nRow;
-            },
             fnDrawCallback: function() { hazelnut_draw_callback.call(object, options); }
-        });
+        };
+       // 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     $.extend(actual_options, options.datatables_options );
+        this.table = $('#hazelnut-' + options.plugin_uuid).dataTable(actual_options);
 
         /* Setup the SelectAll button in the dataTable header */
+       /* xxx not sure this is still working */
         var oSelectAll = $('#datatableSelectAll-'+ options.plugin_uuid);
         oSelectAll.html("<span class='ui-icon ui-icon-check' style='float:right;display:inline-block;'></span>Select All");
         oSelectAll.button();
         oSelectAll.unbind('click');
         oSelectAll.click(selectAll);
 
-        /* Spinner (could be done when the query is received = a query is in progress, also for update) */
-//        $('#' + options.plugin_uuid).spin()
-
         /* Add a filtering function to the current table 
          * Note: we use closure to get access to the 'options'
          */
         /* methods */
 
         this.set_query = function(query) {
-           if (debug) console.log("entering set_query");
-            var o = this.options;
+           messages.info('hazelnut.set_query');
+            var options = this.options;
             /* Compare current and advertised query to get added and removed fields */
             previous_query = this.current_query;
             /* Save the query as the current query */
             this.current_query = query;
-           if (debug) console.log("set_query, current_query is now -> " + this.current_query);
+           if (debug) messages.debug("hazelnut.set_query, current_query is now -> " + this.current_query);
             /* We check all necessary fields : in column editor I presume XXX */
             // XXX ID naming has no plugin_uuid
             if (typeof(query.fields) != 'undefined') {        
                 $.each (query.fields, function(index, value) { 
-                    if (!$('#hazelnut-checkbox-' + o.plugin_uuid + "-" + value).attr('checked'))
-                        $('#hazelnut-checkbox-' + o.plugin_uuid + "-" + value).attr('checked', true);
+                    if (!$('#hazelnut-checkbox-' + options.plugin_uuid + "-" + value).attr('checked'))
+                        $('#hazelnut-checkbox-' + options.plugin_uuid + "-" + value).attr('checked', true);
                 });
             }
             /*Process updates in filters / current_query must be updated before this call for filtering ! */
         }
 
         this.set_resources = function(resources, instance) {
-           if (debug) console.log("entering set_resources");
-            var o = this.options;
+           if (debug) messages.debug("entering hazelnut.set_resources");
+            var options = this.options;
             var previous_resources = this.current_resources;
             this.current_resources = resources;
     
             /* We uncheck all checkboxes ... */
-            $('hazelnut-checkbox-' + o.plugin_uuid).attr('checked', false);
+            $('hazelnut-checkbox-' + options.plugin_uuid).attr('checked', false);
             /* ... and check the ones specified in the resource list */
             $.each(this.current_resources, function(index, urn) {
-                $('#hazelnut-checkbox-' + o.plugin_uuid + "-" + urn).attr('checked', true)
+                $('#hazelnut-checkbox-' + options.plugin_uuid + "-" + urn).attr('checked', true)
             });
             
         }
          * XXX will be removed/replaced
          */
         this.selected_changed = function(e, change) {
-           if (debug) console.log("entering selected_changed");
+           if (debug) messages.debug("entering hazelnut.selected_changed");
             var actions = change.split("/");
             if (actions.length > 1) {
                 var oNodes = this.table.fnGetNodes();
         }
     
         this.update_plugin = function(e, rows) {
-           if (debug) console.log("entering update_plugin");
            // e.data is what we passed in second argument to subscribe
            // so here it is the jquery object attached to the plugin <div>
            var $plugindiv=e.data;
+           if (debug) messages.debug("entering hazelnut.update_plugin on id '" + $plugindiv.attr('id') + "'");
            // clear the spinning wheel: look up an ancestor that has the need-spin class
            // do this before we might return
            $plugindiv.closest('.need-spin').spin(false);
             var options = this.options;
             var hazelnut = this;
     
+           /* if we get no result, or an error, try to make that clear, and exit */
             if (rows.length==0) {
-                this.table.html(errorDisplay("No Result"));   
+               if (debug) messages.debug("Empty result on hazelnut " + domid);
+               var placeholder=$(this.table).find("td.dataTables_empty");
+               console.log("placeholder "+placeholder);
+               if (placeholder.length==1) placeholder.html(unfold.warning("Empty result"));
+               else                       this.table.html(unfold.warning("Empty result"));
+                return;
+            } else if (typeof(rows[0].error) != 'undefined') {
+               // we now should have another means to report errors that this inline/embedded hack
+               if (debug) messages.error ("undefined result on " + domid + " - should not happen anymore");
+                this.table.html(unfold.error(rows[0].error));
                 return;
-            } else {
-                if (typeof(rows[0].error) != 'undefined') {
-                    this.table.html(errorDisplay(rows[0].error));
-                    return;
-                }
             }
-            newlines = new Array();
+
+           /* 
+            * fill the dataTables object
+            * we cannot set html content directly here, need to use fnAddData
+            */
+            var lines = new Array();
     
             this.current_resources = Array();
     
-            $.each(rows, function(index, obj) {
-                newline = new Array();
-    
+            $.each(rows, function(index, row) {
+               // this models a line in dataTables, each element in the line describes a cell
+                line = new Array();
+     
                 // go through table headers to get column names we want
                 // in order (we have temporarily hack some adjustments in names)
                 var cols = hazelnut.table.fnSettings().aoColumns;
                 var colnames = cols.map(function(x) {return x.sTitle})
-                var nb_col = colnames.length;
-                if (options.checkboxes)
-                    nb_col -= 1;
+                var nb_col = cols.length;
+               /* if we've requested checkboxes, then forget about the checkbox column for now */
+                if (options.checkboxes) nb_col -= 1;
+
+               /* fill in stuff depending on the column name */
                 for (var j = 0; j < nb_col; j++) {
                     if (typeof colnames[j] == 'undefined') {
-                        newline.push('...');
+                        line.push('...');
                     } else if (colnames[j] == 'hostname') {
-                        if (obj['type'] == 'resource,link')
+                        if (row['type'] == 'resource,link')
                             //TODO: we need to add source/destination for links
-                            newline.push('');
+                            line.push('');
                         else
-                            newline.push(obj['hostname']);
+                            line.push(row['hostname']);
                     } else {
-                        if (obj[colnames[j]])
-                            newline.push(obj[colnames[j]]);
+                        if (row[colnames[j]])
+                            line.push(row[colnames[j]]);
                         else
-                            newline.push('');
+                            line.push('');
                     }
                 }
     
+               /* catch up with the last column if checkboxes were requested */
                 if (options.checkboxes) {
                     var checked = '';
-                    if (typeof(obj['sliver']) != 'undefined') { /* It is equal to null when <sliver/> is present */
+                   // xxx problem is, we don't get this 'sliver' thing set apparently
+                    if (typeof(row['sliver']) != 'undefined') { /* It is equal to null when <sliver/> is present */
                         checked = 'checked ';
-                        hazelnut.current_resources.push(obj['urn']);
+                        hazelnut.current_resources.push(row['urn']);
                     }
                     // Use a key instead of hostname (hard coded...)
-                    newline.push(hazelnut.checkbox(options.plugin_uuid, obj['urn'], obj['type'], checked, false));
+                    line.push(hazelnut.checkbox(options.plugin_uuid, row['urn'], row['type'], checked, false));
                 }
     
-                newlines.push(newline);
-    
+                lines.push(line);
     
             });
     
-//         console.log ("end of each, newlines=" + newlines.length);
-            this.table.fnAddData(newlines);
+           this.table.fnClearTable();
+           if (debug) messages.debug("hazelnut.update_plugin: total of " + lines.length + " rows");
+            this.table.fnAddData(lines);
     
-//         console.log (" exiting update_plugin = ");
         };
 
         this.checkbox = function (plugin_uuid, header, field, selected_str, disabled_str) {
            var result="";
-            /* Prefix id with plugin_uuid */
-           result += "<input class='hazelnut-checkbox-" + plugin_uuid + "' id='hazelnut-checkbox-" + plugin_uuid + "-" + get_value(header) + "'";
-           result += " name='" + get_value(field) + "' type='checkbox' " + selected_str + disabled_str + " autocomplete='off' value='" + get_value(header) + "'";
-           result +="></input>";
+            // Preafix id with plugin_uuid
+           result += "<input";
+           result += " class='hazelnut-checkbox-" + plugin_uuid + "'";
+           result += " id='hazelnut-checkbox-" + plugin_uuid + "-" + unfold.get_value(header) + "'";
+           result += " name='" + unfold.get_value(field) + "'";
+           result += " type='checkbox'";
+           result += selected_str;
+           result += disabled_str;
+           result += " autocomplete='off'";
+           result += " value='" + unfold.get_value(header) + "'";
+           result += "></input>";
            return result;
         };
     } // constructor
 
     /***************************************************************************
      * Private methods
+     * xxx I'm not sure why this should not be methods in the Hazelnut class above
      ***************************************************************************/
 
     /** 
      */
     function hazelnut_filter (oSettings, aData, iDataIndex) {
         var cur_query = this.current_query;
+        if (!cur_query) return true;
         var ret = true;
 
         /* We have an array of filters : a filter is an array (key op val) 
             if (typeof(col) == 'undefined')
                 return;
 
-            col_value=get_value(aData[col]);
+            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")
         if(filterData.length<=100){
             $.each(filterData, function(index, obj) {
                 var last=$(obj).last();
-                var key_value=get_value(last[0]);
+                var key_value=unfold.get_value(last[0]);
                 if(typeof($(last[0]).attr('checked'))=="undefined"){
                     $.publish('selected', 'add/'+key_value);
                 }