updater now has the logic to turn itself off and back on (although for now only in...
[myslice.git] / plugins / hazelnut / hazelnut.js
index 596062c..4bf182e 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
  */
@@ -15,7 +12,7 @@
 (function($){
 
     var debug=false;
-    debug=true
+//    debug=true
 
     // routing calls
     $.fn.Hazelnut = function( method ) {
             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';
 
+               // 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) console.log("hazelnut '" + this.id + "' subscribed to e.g." + results_channel);
+               if (debug) messages.debug("hazelnut '" + this.id + "' subscribed to e.g." + results_channel);
 
             }); // this.each
         }, // init
@@ -78,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);
        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
+       $.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();
             previous_query = this.current_query;
             /* Save the query as the current query */
             this.current_query = query;
-           if (debug) console.log("hazelnut.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') {        
         }
 
         this.set_resources = function(resources, instance) {
-           if (debug) console.log("entering hazelnut.set_resources");
+           if (debug) messages.debug("entering hazelnut.set_resources");
             var options = this.options;
             var previous_resources = this.current_resources;
             this.current_resources = resources;
          * XXX will be removed/replaced
          */
         this.selected_changed = function(e, change) {
-           if (debug) console.log("entering hazelnut.selected_changed");
+           if (debug) messages.debug("entering hazelnut.selected_changed");
             var actions = change.split("/");
             if (actions.length > 1) {
                 var oNodes = this.table.fnGetNodes();
            // 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) console.log("entering hazelnut.update_plugin on id '" + $plugindiv.attr('id') + "'");
+           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);
     
             if (rows.length==0) {
                if (debug) console.l ("empty result");
-                this.table.html(errorDisplay("No Result"));   
+                this.table.html(unfold.errorDisplay("No Result"));   
                 return;
             } else if (typeof(rows[0].error) != 'undefined') {
-               if (debug) console.log ("undefined result");
-                this.table.html(errorDisplay(rows[0].error));
+               if (debug) messages.debug ("undefined result");
+                this.table.html(unfold.errorDisplay(rows[0].error));
                 return;
             }
             newlines = new Array();
     
             });
     
-           if (debug) console.log("hazelnut.update_plugin: total of " + newlines.length + " rows");
+           this.table.fnClearTable();
+           if (debug) messages.debug("hazelnut.update_plugin: total of " + newlines.length + " rows");
             this.table.fnAddData(newlines);
     
         };
         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 class='hazelnut-checkbox-" + plugin_uuid + "' id='hazelnut-checkbox-" + plugin_uuid + "-" + unfold.get_value(header) + "'";
+           result += " name='" + unfold.get_value(field) + "' type='checkbox' " + selected_str + disabled_str + " autocomplete='off' value='" + unfold.get_value(header) + "'";
            result +="></input>";
            return result;
         };
 
     /***************************************************************************
      * Private methods
+     * xxx I'm not sure why this should not be methods in the Hazelnut class above
      ***************************************************************************/
 
     /** 
             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);
                 }