plugins/querytable/static/js/querytable.js

   1 /**
   2  * Description: display a query result in a datatables-powered <table>
   3  * Copyright (c) 2012-2013 UPMC Sorbonne Universite - INRIA
   4  * License: GPLv3
   5  */
   6
   7 (function($){
   8
   9     var debug=false;
  10 //    debug=true
  11
  12     var QueryTable = Plugin.extend({
  13
  14         init: function(options, element) {
  15             this.classname="querytable";
  16             this._super(options, element);
  17
  18             /* Member variables */
  19             // in general we expect 2 queries here
  20             // query_uuid refers to a single object (typically a slice)
  21             // query_all_uuid refers to a list (typically resources or users)
  22             // these can return in any order so we keep track of which has been received yet
  23             this.received_all_query = false;
  24             this.received_query = false;
  25
  26             // We need to remember the active filter for datatables filtering
  27             this.filters = Array();
  28
  29             // an internal buffer for records that are 'in' and thus need to be checked
  30             this.buffered_records_to_check = [];
  31             // an internal buffer for keeping lines and display them in one call to fnAddData
  32             this.buffered_lines = [];
  33
  34             /* Events */
  35             // xx somehow non of these triggers at all for now
  36             this.elmt().on('show', this, this.on_show);
  37             this.elmt().on('shown.bs.tab', this, this.on_show);
  38             this.elmt().on('resize', this, this.on_resize);
  39
  40             var query = manifold.query_store.find_analyzed_query(this.options.query_uuid);
  41             this.object = query.object;
  42
  43             //// we need 2 different keys
  44             // * canonical_key is the primary key as derived from metadata (typically: urn)
  45             //   and is used to communicate about a given record with the other plugins
  46             // * init_key is a key that both kinds of records
  47             //   (i.e. records returned by both queries) must have (typically: hrn or hostname)
  48             //   in general query_all will return well populated records, but query
  49             //   returns records with only the fields displayed on startup
  50             var keys = manifold.metadata.get_key(this.object);
  51             this.canonical_key = (keys && keys.length == 1) ? keys[0] : undefined;
  52             //
  53             this.init_key = this.options.init_key;
  54             // have init_key default to canonical_key
  55             this.init_key = this.init_key || this.canonical_key;
  56             // sanity check
  57             if ( ! this.init_key ) messages.warning ("QueryTable : cannot find init_key");
  58             if ( ! this.canonical_key ) messages.warning ("QueryTable : cannot find canonical_key");
  59             if (debug) messages.debug("querytable: canonical_key="+this.canonical_key+" init_key="+this.init_key);
  60
  61             /* Setup query and record handlers */
  62             this.listen_query(options.query_uuid);
  63             this.listen_query(options.query_all_uuid, 'all');
  64
  65             /* GUI setup and event binding */
  66             this.initialize_table();
  67         },
  68
  69         /* PLUGIN EVENTS */
  70
  71         on_show: function(e) {
  72             if (debug) messages.debug("querytable.on_show");
  73             var self = e.data;
  74             self.table.fnAdjustColumnSizing();
  75         },
  76
  77         on_resize: function(e) {
  78             if (debug) messages.debug("querytable.on_resize");
  79             var self = e.data;
  80             self.table.fnAdjustColumnSizing();
  81         },
  82
  83         /* GUI EVENTS */
  84
  85         /* GUI MANIPULATION */
  86
  87         initialize_table: function()
  88         {
  89             /* Transforms the table into DataTable, and keep a pointer to it */
  90             var self = this;
  91             var actual_options = {
  92                 // Customize the position of Datatables elements (length,filter,button,...)
  93                 // we use a fluid row on top and another on the bottom, making sure we take 12 grid elt's each time
  94                 //sDom: "<'row'<'col-xs-5'l><'col-xs-1'r><'col-xs-6'f>>t<'row'<'col-xs-5'i><'col-xs-7'p>>",
  95                 sDom: "<'row'<'col-xs-5'f><'col-xs-1'r><'col-xs-6 columns_selector'>>t<'row'<'col-xs-5'l><'col-xs-7'p>>",
  96                 // XXX as of sept. 2013, I cannot locate a bootstrap3-friendly mode for now
  97                 // hopefully this would come with dataTables v1.10 ?
  98                 // in any case, search for 'sPaginationType' all over the code for more comments
  99                 sPaginationType: 'bootstrap',
 100                 // Handle the null values & the error : Datatables warning Requested unknown parameter
 101                 // http://datatables.net/forums/discussion/5331/datatables-warning-...-requested-unknown-parameter/p2
 102                 aoColumnDefs: [{sDefaultContent: '',aTargets: [ '_all' ]}],
 103                 // WARNING: this one causes tables in a 'tabs' that are not exposed at the time this is run to show up empty
 104                 // sScrollX: '100%',       /* Horizontal scrolling */
 105                 bProcessing: true,      /* Loading */
 106                 fnDrawCallback: function() { self._querytable_draw_callback.call(self); }
 107                 // XXX use $.proxy here !
 108             };
 109             // the intention here is that options.datatables_options as coming from the python object take precedence
 110             // xxx DISABLED by jordan: was causing errors in datatables.js
 111             // xxx turned back on by Thierry - this is the code that takes python-provided options into account
 112             // check your datatables_options tag instead
 113             // however, we have to accumulate in aoColumnDefs from here (above)
 114             // and from the python wrapper (checkboxes management, plus any user-provided aoColumnDefs)
 115             if ( 'aoColumnDefs' in this.options.datatables_options) {
 116                 actual_options['aoColumnDefs']=this.options.datatables_options['aoColumnDefs'].concat(actual_options['aoColumnDefs']);
 117                 delete this.options.datatables_options['aoColumnDefs'];
 118             }
 119             $.extend(actual_options, this.options.datatables_options );
 120             this.table = this.elmt('table').dataTable(actual_options);
 121
 122             /* Setup the SelectAll button in the dataTable header */
 123             /* xxx not sure this is still working */
 124             var oSelectAll = $('#datatableSelectAll-'+ this.options.plugin_uuid);
 125             oSelectAll.html("<span class='glyphicon glyphicon-ok' style='float:right;display:inline-block;'></span>Select All");
 126             oSelectAll.button();
 127             oSelectAll.css('font-size','11px');
 128             oSelectAll.css('float','right');
 129             oSelectAll.css('margin-right','15px');
 130             oSelectAll.css('margin-bottom','5px');
 131             oSelectAll.unbind('click');
 132             oSelectAll.click(this._selectAll);
 133
 134             /* Add a filtering function to the current table
 135              * Note: we use closure to get access to the 'options'
 136              */
 137             $.fn.dataTableExt.afnFiltering.push(function( oSettings, aData, iDataIndex ) {
 138                 /* No filtering if the table does not match */
 139                 if (oSettings.nTable.id != self.options.plugin_uuid + '__table')
 140                     return true;
 141                 return self._querytable_filter.call(self, oSettings, aData, iDataIndex);
 142             });
 143
 144             /* Processing hidden_columns */
 145             $.each(this.options.hidden_columns, function(i, field) {
 146                 //manifold.raise_event(self.options.query_all_uuid, FIELD_REMOVED, field);
 147                 self.hide_column(field);
 148             });
 149             $(".dataTables_filter").append("<div style='display:inline-block;height:27px;width:27px;padding-left:6px;padding-top:4px;'><span class='glyphicon glyphicon-search'></span></div>");
 150             $(".dataTables_filter input").css("width","100%");
 151             $(".columns_selector").append("columns");
 152             $(".columns_selector").css("float","right");
 153             $(".columns_selector").css("width","inherit");
 154         }, // initialize_table
 155
 156         /**
 157          * @brief Determine index of key in the table columns
 158          * @param key
 159          * @param cols
 160          */
 161         getColIndex: function(key, cols) {
 162             var tabIndex = $.map(cols, function(x, i) { if (x.sTitle == key) return i; });
 163             return (tabIndex.length > 0) ? tabIndex[0] : -1;
 164         }, // getColIndex
 165
 166         // create a checkbox <input> tag
 167         // computes 'id' attribute from canonical_key
 168         // computes 'init_id' from init_key for initialization phase
 169         // no need to used convoluted ids with plugin-uuid or others, since
 170         // we search using table.$ which looks only in this table
 171         checkbox_html : function (record) {
 172             var result="";
 173             // Prefix id with plugin_uuid
 174             result += "<input";
 175             result += " class='querytable-checkbox'";
 176          // compute id from canonical_key
 177             var id = record[this.canonical_key]
 178          // compute init_id form init_key
 179             var init_id=record[this.init_key];
 180          // set id - for retrieving from an id, or for posting events upon user's clicks
 181             result += " id='"+record[this.canonical_key]+"'";
 182          // set init_id
 183             result += "init_id='" + init_id + "'";
 184          // wrap up
 185             result += " type='checkbox'";
 186             result += " autocomplete='off'";
 187             result += "></input>";
 188             return result;
 189         },
 190
 191
 192         new_record: function(record)
 193         {
 194             // this models a line in dataTables, each element in the line describes a cell
 195             line = new Array();
 196
 197             // go through table headers to get column names we want
 198             // in order (we have temporarily hack some adjustments in names)
 199             var cols = this.table.fnSettings().aoColumns;
 200             var colnames = cols.map(function(x) {return x.sTitle})
 201             var nb_col = cols.length;
 202             /* if we've requested checkboxes, then forget about the checkbox column for now */
 203             //if (this.options.checkboxes) nb_col -= 1;
 204                         // catch up with the last column if checkboxes were requested
 205             if (this.options.checkboxes) {
 206                 // Use a key instead of hostname (hard coded...)
 207                 line.push(this.checkbox_html(record));
 208                 }
 209
 210             /* fill in stuff depending on the column name */
 211             for (var j = 1; j < nb_col; j++) {
 212                 if (typeof colnames[j] == 'undefined') {
 213                     line.push('...');
 214                 } else if (colnames[j] == 'hostname') {
 215                     if (record['type'] == 'resource,link')
 216                         //TODO: we need to add source/destination for links
 217                         line.push('');
 218                     else
 219                         line.push(record['hostname']);
 220
 221                 } else if (colnames[j] == this.init_key && typeof(record) != 'undefined') {
 222                     obj = this.object
 223                     o = obj.split(':');
 224                     if(o.length>1){
 225                         obj = o[1];
 226                     }else{
 227                         obj = o[0];
 228                     }
 229                     /* XXX TODO: Remove this and have something consistant */
 230                     if(obj=='resource'){
 231                         //line.push('<a href="../'+obj+'/'+record['urn']+'"><span class="glyphicon glyphicon-search"></span></a> '+record[this.init_key]);
 232                     }else{
 233                         //line.push('<a href="../'+obj+'/'+record[this.init_key]+'"><span class="glyphicon glyphicon-search"></span></a> '+record[this.init_key]);
 234                     }
 235                     line.push(record[this.init_key]);
 236                 } else {
 237                     if (record[colnames[j]])
 238                         line.push(record[colnames[j]]);
 239                     else
 240                         line.push('');
 241                 }
 242             }
 243
 244
 245
 246             // adding an array in one call is *much* more efficient
 247                 // this.table.fnAddData(line);
 248                 this.buffered_lines.push(line);
 249         },
 250
 251         clear_table: function()
 252         {
 253             this.table.fnClearTable();
 254         },
 255
 256         redraw_table: function()
 257         {
 258             this.table.fnDraw();
 259         },
 260
 261         show_column: function(field)
 262         {
 263             var oSettings = this.table.fnSettings();
 264             var cols = oSettings.aoColumns;
 265             var index = this.getColIndex(field,cols);
 266             if (index != -1)
 267                 this.table.fnSetColumnVis(index, true);
 268         },
 269
 270         hide_column: function(field)
 271         {
 272             var oSettings = this.table.fnSettings();
 273             var cols = oSettings.aoColumns;
 274             var index = this.getColIndex(field,cols);
 275             if (index != -1)
 276                 this.table.fnSetColumnVis(index, false);
 277         },
 278
 279         // this is used at init-time, at which point only init_key can make sense
 280         // (because the argument record, if it comes from query, might not have canonical_key set
 281         set_checkbox_from_record: function (record, checked) {
 282             if (checked === undefined) checked = true;
 283             var init_id = record[this.init_key];
 284             if (debug) messages.debug("querytable.set_checkbox_from_record, init_id="+init_id);
 285             // using table.$ to search inside elements that are not visible
 286             var element = this.table.$('[init_id="'+init_id+'"]');
 287             element.attr('checked',checked);
 288         },
 289
 290         // id relates to canonical_key
 291         set_checkbox_from_data: function (id, checked) {
 292             if (checked === undefined) checked = true;
 293             if (debug) messages.debug("querytable.set_checkbox_from_data, id="+id);
 294             // using table.$ to search inside elements that are not visible
 295             var element = this.table.$("[id='"+id+"']");
 296             element.attr('checked',checked);
 297         },
 298
 299         /*************************** QUERY HANDLER ****************************/
 300
 301         on_filter_added: function(filter)
 302         {
 303             this.filters.push(filter);
 304             this.redraw_table();
 305         },
 306
 307         on_filter_removed: function(filter)
 308         {
 309             // Remove corresponding filters
 310             this.filters = $.grep(this.filters, function(x) {
 311                 return x == filter;
 312             });
 313             this.redraw_table();
 314         },
 315
 316         on_filter_clear: function()
 317         {
 318             // XXX
 319             this.redraw_table();
 320         },
 321
 322         on_field_added: function(field)
 323         {
 324             this.show_column(field);
 325         },
 326
 327         on_field_removed: function(field)
 328         {
 329             this.hide_column(field);
 330         },
 331
 332         on_field_clear: function()
 333         {
 334             alert('QueryTable::clear_fields() not implemented');
 335         },
 336
 337         /* XXX TODO: make this generic a plugin has to subscribe to a set of Queries to avoid duplicated code ! */
 338         /*************************** ALL QUERY HANDLER ****************************/
 339
 340         on_all_filter_added: function(filter)
 341         {
 342             // XXX
 343             this.redraw_table();
 344         },
 345
 346         on_all_filter_removed: function(filter)
 347         {
 348             // XXX
 349             this.redraw_table();
 350         },
 351
 352         on_all_filter_clear: function()
 353         {
 354             // XXX
 355             this.redraw_table();
 356         },
 357
 358         on_all_field_added: function(field)
 359         {
 360             this.show_column(field);
 361         },
 362
 363         on_all_field_removed: function(field)
 364         {
 365             this.hide_column(field);
 366         },
 367
 368         on_all_field_clear: function()
 369         {
 370             alert('QueryTable::clear_fields() not implemented');
 371         },
 372
 373
 374         /*************************** RECORD HANDLER ***************************/
 375
 376         on_new_record: function(record)
 377         {
 378             if (this.received_all_query) {
 379                 // if the 'all' query has been dealt with already we may turn on the checkbox
 380                 this.set_checkbox_from_record(record, true);
 381             } else {
 382                 this.buffered_records_to_check.push(record);
 383             }
 384         },
 385
 386         on_clear_records: function()
 387         {
 388         },
 389
 390         // Could be the default in parent
 391         on_query_in_progress: function()
 392         {
 393             this.spin();
 394         },
 395
 396         on_query_done: function()
 397         {
 398             this.received_query = true;
 399             // unspin once we have received both
 400             if (this.received_all_query && this.received_query) this.unspin();
 401         },
 402
 403         on_field_state_changed: function(data)
 404         {
 405             switch(data.request) {
 406                 case FIELD_REQUEST_ADD:
 407                 case FIELD_REQUEST_ADD_RESET:
 408                         // update pending number
 409                         $("#badge-pending").data('number', $("#badge-pending").data('number') + 1 );
 410                         $("#badge-pending").text($("#badge-pending").data('number'));
 411                     this.set_checkbox_from_data(data.value, true);
 412                     break;
 413                 case FIELD_REQUEST_REMOVE:
 414                 case FIELD_REQUEST_REMOVE_RESET:
 415                         $("#badge-pending").data('number', $("#badge-pending").data('number') - 1 );
 416                         $("#badge-pending").text($("#badge-pending").data('number'));
 417                     this.set_checkbox_from_data(data.value, false);
 418                     break;
 419                 default:
 420                     break;
 421             }
 422         },
 423
 424         /* XXX TODO: make this generic a plugin has to subscribe to a set of Queries to avoid duplicated code ! */
 425         // all
 426         on_all_field_state_changed: function(data)
 427         {
 428             switch(data.request) {
 429                 case FIELD_REQUEST_ADD:
 430                 case FIELD_REQUEST_ADD_RESET:
 431                     this.set_checkbox_from_data(data.value, true);
 432                     break;
 433                 case FIELD_REQUEST_REMOVE:
 434                 case FIELD_REQUEST_REMOVE_RESET:
 435                     this.set_checkbox_from_data(data.value, false);
 436                     break;
 437                 default:
 438                     break;
 439             }
 440         },
 441
 442         on_all_new_record: function(record)
 443         {
 444             this.new_record(record);
 445         },
 446
 447         on_all_clear_records: function()
 448         {
 449             this.clear_table();
 450
 451         },
 452
 453         on_all_query_in_progress: function()
 454         {
 455             // XXX parent
 456             this.spin();
 457         }, // on_all_query_in_progress
 458
 459         on_all_query_done: function()
 460         {
 461                 if (debug) messages.debug("1-shot initializing dataTables content with " + this.buffered_lines.length + " lines");
 462                 this.table.fnAddData (this.buffered_lines);
 463                 this.buffered_lines=[];
 464
 465             var self = this;
 466             // if we've already received the slice query, we have not been able to set
 467             // checkboxes on the fly at that time (dom not yet created)
 468             $.each(this.buffered_records_to_check, function(i, record) {
 469                                 if (debug) messages.debug ("querytable delayed turning on checkbox " + i + " record= " + record);
 470                 self.set_checkbox_from_record(record, true);
 471             });
 472                 this.buffered_records_to_check = [];
 473
 474             this.received_all_query = true;
 475             // unspin once we have received both
 476             if (this.received_all_query && this.received_query) this.unspin();
 477
 478         }, // on_all_query_done
 479
 480         /************************** PRIVATE METHODS ***************************/
 481
 482         /**
 483          * @brief QueryTable filtering function
 484          */
 485         _querytable_filter: function(oSettings, aData, iDataIndex)
 486         {
 487             var ret = true;
 488             $.each (this.filters, function(index, filter) {
 489                 /* XXX How to manage checkbox ? */
 490                 var key = filter[0];
 491                 var op = filter[1];
 492                 var value = filter[2];
 493
 494                 /* Determine index of key in the table columns */
 495                 var col = $.map(oSettings.aoColumns, function(x, i) {if (x.sTitle == key) return i;})[0];
 496
 497                 /* Unknown key: no filtering */
 498                 if (typeof(col) == 'undefined')
 499                     return;
 500
 501                 col_value=unfold.get_value(aData[col]);
 502                 /* Test whether current filter is compatible with the column */
 503                 if (op == '=' || op == '==') {
 504                     if ( col_value != value || col_value==null || col_value=="" || col_value=="n/a")
 505                         ret = false;
 506                 }else if (op == 'included') {
 507                     $.each(value, function(i,x) {
 508                       if(x == col_value){
 509                           ret = true;
 510                           return false;
 511                       }else{
 512                           ret = false;
 513                       }
 514                     });
 515                 }else if (op == '!=') {
 516                     if ( col_value == value || col_value==null || col_value=="" || col_value=="n/a")
 517                         ret = false;
 518                 } else if(op=='<') {
 519                     if ( parseFloat(col_value) >= value || col_value==null || col_value=="" || col_value=="n/a")
 520                         ret = false;
 521                 } else if(op=='>') {
 522                     if ( parseFloat(col_value) <= value || col_value==null || col_value=="" || col_value=="n/a")
 523                         ret = false;
 524                 } else if(op=='<=' || op=='≤') {
 525                     if ( parseFloat(col_value) > value || col_value==null || col_value=="" || col_value=="n/a")
 526                         ret = false;
 527                 } else if(op=='>=' || op=='≥') {
 528                     if ( parseFloat(col_value) < value || col_value==null || col_value=="" || col_value=="n/a")
 529                         ret = false;
 530                 }else{
 531                     // How to break out of a loop ?
 532                     alert("filter not supported");
 533                     return false;
 534                 }
 535
 536             });
 537             return ret;
 538         },
 539
 540         _querytable_draw_callback: function()
 541         {
 542             /*
 543              * Handle clicks on checkboxes: reassociate checkbox click every time
 544              * the table is redrawn
 545              */
 546             this.elts('querytable-checkbox').unbind('click').click(this, this._check_click);
 547
 548             if (!this.table)
 549                 return;
 550
 551             /* Remove pagination if we show only a few results */
 552             var wrapper = this.table; //.parent().parent().parent();
 553             var rowsPerPage = this.table.fnSettings()._iDisplayLength;
 554             var rowsToShow = this.table.fnSettings().fnRecordsDisplay();
 555             var minRowsPerPage = this.table.fnSettings().aLengthMenu[0];
 556
 557             if ( rowsToShow <= rowsPerPage || rowsPerPage == -1 ) {
 558                 $('.querytable_paginate', wrapper).css('visibility', 'hidden');
 559             } else {
 560                 $('.querytable_paginate', wrapper).css('visibility', 'visible');
 561             }
 562
 563             if ( rowsToShow <= minRowsPerPage ) {
 564                 $('.querytable_length', wrapper).css('visibility', 'hidden');
 565             } else {
 566                 $('.querytable_length', wrapper).css('visibility', 'visible');
 567             }
 568         },
 569
 570         _check_click: function(e)
 571         {
 572             e.stopPropagation();
 573
 574             var self = e.data;
 575             var id=this.id;
 576
 577             // this.id = key of object to be added... what about multiple keys ?
 578             if (debug) messages.debug("querytable._check_click key="+this.canonical_key+"->"+id+" checked="+this.checked);
 579             manifold.raise_event(self.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, id);
 580             //return false; // prevent checkbox to be checked, waiting response from manifold plugin api
 581
 582         },
 583
 584         _selectAll: function()
 585         {
 586             // requires jQuery id
 587             var uuid=this.id.split("-");
 588             var oTable=$("#querytable-"+uuid[1]).dataTable();
 589             // Function available in QueryTable 1.9.x
 590             // Filter : displayed data only
 591             var filterData = oTable._('tr', {"filter":"applied"});
 592             /* TODO: WARNING if too many nodes selected, use filters to reduce nuber of nodes */
 593             if(filterData.length<=100){
 594                 $.each(filterData, function(index, obj) {
 595                     var last=$(obj).last();
 596                     var key_value=unfold.get_value(last[0]);
 597                     if(typeof($(last[0]).attr('checked'))=="undefined"){
 598                         $.publish('selected', 'add/'+key_value);
 599                     }
 600                 });
 601             }
 602         },
 603
 604     });
 605
 606     $.plugin('QueryTable', QueryTable);
 607
 608   /* define the 'dom-checkbox' type for sorting in datatables
 609      http://datatables.net/examples/plug-ins/dom_sort.html
 610      using trial and error I found that the actual column number
 611      was in fact given as a third argument, and not second
 612      as the various online resources had it - go figure */
 613     $.fn.dataTableExt.afnSortData['dom-checkbox'] = function  ( oSettings, _, iColumn ) {
 614                 return $.map( oSettings.oApi._fnGetTrNodes(oSettings), function (tr, i) {
 615                     return result=$('td:eq('+iColumn+') input', tr).prop('checked') ? '1' : '0';
 616                 });
 617     };
 618
 619 })(jQuery);
 620