Open-ILS/web/reports/oils_rpt_builder.js

   1 /** initializes reports, some basid display settings,
   2   * grabs and builds the IDL tree
   3   */
   4 function oilsInitReportBuilder() {
   5         oilsInitReports();
   6         oilsReportBuilderReset();
   7         DOM.oils_rpt_table.onclick =
   8                 function(){hideMe(DOM.oils_rpt_column_editor)};
   9         //oilsRptBuildCalendars();
  10         oilsDrawRptTree(
  11                 function() {
  12                         hideMe(DOM.oils_rpt_tree_loading);
  13                         unHideMe(DOM.oils_rpt_table);
  14                 }
  15         );
  16 }
  17
  18 function oilsReportBuilderReset() {
  19         var n = (oilsRpt) ? oilsRpt.name : "";
  20         oilsRpt = new oilsReport();
  21         oilsRpt.name = n;
  22         oilsRptDisplaySelector  = DOM.oils_rpt_display_selector;
  23         oilsRptFilterSelector   = DOM.oils_rpt_filter_selector;
  24         removeChildren(oilsRptDisplaySelector);
  25         removeChildren(oilsRptFilterSelector);
  26         oilsRptDebug();
  27         oilsRptResetParams();
  28 }
  29
  30
  31 /*
  32 function oilsRptBuildCalendars() {
  33         Calendar.setup({
  34                 inputField  : "oils_rpt_filter_tform_timestamp_input", // id of the input field
  35                 ifFormat    : "%Y-%m-%d", // format of the input field
  36                 button      : "oils_rpt_filter_tform_timestamp_cal",  // trigger for the calendar (button ID)
  37                 align       : "Tl", // alignment (defaults to "Bl")
  38                 singleClick : true
  39         });
  40         Calendar.setup({
  41                 inputField  : "oils_rpt_filter_tform_timestamp_input_2", // id of the input field
  42                 ifFormat    : "%Y-%m-%d", // format of the input field
  43                 button      : "oils_rpt_filter_tform_timestamp_cal2",  // trigger for the calendar (button ID)
  44                 align       : "Tl", // alignment (defaults to "Bl")
  45                 singleClick : true
  46         });
  47 }
  48 */
  49
  50
  51 /* creates a label "path" based on the column path */
  52 function oilsRptMakeLabel(path) {
  53         var parts = path.split(/-/);
  54         var str = '';
  55         for( var i = 0; i < parts.length; i++ ) {
  56                 if(i%2 == 0) {
  57                         if( i == 0 )
  58                                 str += oilsIDL[parts[i]].label;
  59                 } else {
  60                         var f = oilsRptFindField(oilsIDL[parts[i-1]], parts[i]);
  61                         str += ":"+f.label;
  62                 }
  63         }
  64         return str;
  65 }
  66
  67
  68 /* adds an item to the display window */
  69 function oilsAddRptDisplayItem(path, name, tform, params) {
  70         if( ! oilsAddSelectorItem(oilsRptDisplaySelector, path, name) )
  71                 return;
  72
  73         /* add the selected columns to the report output */
  74         name = (name) ? name : oilsRptPathCol(path);
  75         var param = oilsRptNextParam();
  76
  77         /* add this item to the select blob */
  78         var sel = {
  79                 relation:oilsRptPathRel(path),
  80                 alias:param
  81         };
  82
  83         if( tform ) {
  84                 sel.column = {};
  85                 if( params ) {
  86                         params.unshift(oilsRptPathCol(path));
  87                         sel.column[tform] = params;
  88                 } else {
  89                         sel.column[tform] = oilsRptPathCol(path);
  90                 }
  91         } else { sel.column = oilsRptPathCol(path); }
  92
  93         oilsRpt.def.select.push(sel);
  94
  95         mergeObjects( oilsRpt.def.from, oilsRptBuildFromClause(path));
  96         oilsRpt.params[param] = name;
  97         oilsRptDebug();
  98 }
  99
 100 /* takes a column path and builds a from-clause object for the path */
 101 function oilsRptBuildFromClause(path) {
 102
 103         /* the path is the full path (relation) from the source
 104                 object to the column in question (e.g. au-home_ou-aou-name)*/
 105         var parts = path.split(/-/);
 106
 107         /* the final from clause */
 108         var obj = {};
 109
 110         /* reference to the current position in the from clause */
 111         var tobj = obj;
 112
 113         var newpath = "";
 114
 115         /* walk the path, fleshing the from clause as we go */
 116         for( var i = 0; i < parts.length; i += 2 ) {
 117
 118                 var cls = parts[i]; /* class name (id) */
 119                 var col = parts[i+1]; /* column name */
 120
 121                 /* a "node" is a class description from the IDL, it
 122                         contains relevant info, plus a list of "fields",
 123                         or column objects */
 124                 var node = oilsIDL[cls];
 125
 126                 /* a "field" is a parsed version of a column from the IDL,
 127                         contains datatype, column name, etc. */
 128                 var field = oilsRptFindField(node, col);
 129
 130                 /* re-construct the path as we go so
 131                         we know what all we've seen thus far */
 132                 newpath = (newpath) ? newpath + '-'+ cls : cls;
 133
 134                 /* extract relevant info */
 135                 tobj.table = node.table;
 136                 tobj.alias = newpath;
 137                 _debug('field type is ' + field.type);
 138                 if( i == (parts.length - 2) ) break;
 139
 140                 /* we still have columns left in the path, keep adding join's */
 141                 tobj.join = {};
 142                 tobj = tobj.join;
 143                 tobj[col] = {};
 144                 tobj = tobj[col];
 145                 if( field.type == 'link' )
 146                         tobj.key = field.key;
 147
 148                 newpath = newpath + '-'+ col;
 149         }
 150
 151         _debug("built 'from' clause: path="+path+"\n"+formatJSON(js2JSON(obj)));
 152         return obj;
 153 }
 154
 155
 156 /* removes a specific item from the display window */
 157 function oilsDelDisplayItem(val) {
 158         oilsDelSelectorItem(oilsRptDisplaySelector, val);
 159 }
 160
 161 /* removes selected items from the display window */
 162 function oilsDelSelectedDisplayItems() {
 163         var list = oilsDelSelectedItems(oilsRptDisplaySelector);
 164
 165         /* remove the de-selected columns from the report output */
 166         oilsRpt.def.select = grep( oilsRpt.def.select,
 167                 function(i) {
 168                         for( var j = 0; j < list.length; j++ ) {
 169                                 var d = list[j];
 170                                 var col = i.column;
 171
 172                                 /* if this columsn has a transform,
 173                                         it will be an object { tform => column } */
 174                                 if( typeof col != 'string' )
 175                                         for( var c in col ) col = col[c];
 176
 177                                 /* if this transform requires params, the column
 178                                         will be the first item in the param set array */
 179                                 if( typeof col != 'string' ) col = col[0];
 180
 181                                 if( oilsRptPathRel(d) == i.relation && oilsRptPathCol(d) == col ) {
 182                                         var param = (i.alias) ? i.alias.match(/::PARAM\d*/) : null;
 183                                         if( param ) delete oilsRpt.params[param];
 184                                         return false;
 185                                 }
 186                         }
 187                         return true;
 188                 }
 189         );
 190
 191         if(!oilsRpt.def.select) {
 192                 oilsRpt.def.select = [];
 193                 oilsReportBuilderReset();
 194
 195         } else {
 196                 for( var j = 0; j < list.length; j++ )
 197                         /* if there are no items left in the "select" clause for the given
 198                                 relation, trim this relation from the "from" clause */
 199                         if(!grep(oilsRpt.def.select,
 200                                         function(i){ return (i.relation == oilsRptPathRel(list[j])); }))
 201                                 oilsRptPruneFromClause(oilsRptPathRel(list[j]));
 202         }
 203
 204         oilsRptDebug();
 205 }
 206
 207 /* for each item in the path list, remove the associated data
 208         from the "from" clause */
 209
 210 function oilsRptPruneFromClause(relation, node) {
 211         _debug("removing relation from 'from' clause " + relation);
 212         if(!node) node = oilsRpt.def.from.join;
 213         for( var i in node ) {
 214                 if( node[i].alias == relation ) {
 215                         if( node[i].join ) {
 216                                 /* if we have subtrees, don't delete our tree node */
 217                                 return false;
 218                         } else {
 219                                 delete node[i];
 220                                 return true;
 221                         }
 222                 } else {
 223                         if( node[i].join ) {
 224                                 if( oilsRptPruneFromClause(relation, node[i].join ) ) {
 225                                         if(oilsRptObjectKeys(node[i].join).length == 0) {
 226                                                 delete node[i].join;
 227                                                 /* if there are no items in the select clause with a relation matching
 228                                                         this nodes alias, we can safely remove this node from the tree */
 229                                                 if(!grep(oilsRpt.def.select,function(r){return (r.relation==node[i].alias)}))
 230                                                         delete node[i];
 231                                                 return true;
 232                                         }
 233                                 }
 234                         }
 235                 }
 236         }
 237         return false;
 238 }
 239
 240 /* adds an item to the display window */
 241 function oilsAddRptFilterItem(val) {
 242         oilsAddSelectorItem(oilsRptFilterSelector, val);
 243 }
 244
 245 /* removes a specific item from the display window */
 246 function oilsDelFilterItem(val) {
 247         oilsDelSelectorItem(oilsRptFilterSelector, val);
 248 }
 249
 250 /* removes selected items from the display window */
 251 function oilsDelSelectedFilterItems() {
 252         oilsDelSelectedItems(oilsRptFilterSelector);
 253 }
 254
 255
 256 /* adds an item to the display window */
 257 function oilsAddSelectorItem(sel, val, name) {
 258         name = (name) ? name : oilsRptMakeLabel(val);
 259         _debug("adding selector item "+name+' = ' +val);
 260         for( var i = 0; i < sel.options.length; i++ ) {
 261                 var opt = sel.options[i];
 262                 if( opt.value == val ) return false;
 263         }
 264         insertSelectorVal( sel, -1, name, val );
 265         return true;
 266 }
 267
 268
 269 /* removes a specific item from the display window */
 270 function oilsDelSelectorItem(sel, val) {
 271         _debug("deleting selector item "+val);
 272         var opts = sel.options;
 273         for( var i = 0; i < opts.length; i++ ) {
 274                 var opt = opts[i];
 275                 if( opt.value == val )  {
 276                         if( i == opts.length - 1 )
 277                                 opts[i] = null;
 278                         else opts[i] = opts[i+1];
 279                         return;
 280                 }
 281         }
 282 }
 283
 284 /* removes selected items from the display window */
 285 function oilsDelSelectedItems(sel) {
 286         var list = getSelectedList(sel);
 287         for( var i = 0; i < list.length; i++ )
 288                 oilsDelSelectorItem(sel, list[i]);
 289         return list;
 290 }
 291
 292
 293 /* hides the different field editor tabs */
 294 function oilsRptHideEditorDivs() {
 295         hideMe(DOM.oils_rpt_tform_div);
 296         hideMe(DOM.oils_rpt_filter_div);
 297         hideMe(DOM.oils_rpt_agg_filter_div);
 298 }
 299
 300
 301 /**
 302   This draws the 3-tabbed window containing the transform,
 303   filter, and aggregate filter picker window
 304   */
 305 function oilsRptDrawDataWindow(path) {
 306         var col = oilsRptPathCol(path);
 307         var cls = oilsRptPathClass(path);
 308         var field = oilsRptFindField(oilsIDL[cls], col);
 309
 310         appendClear(DOM.oils_rpt_editor_window_label, text(oilsRptMakeLabel(path)));
 311         appendClear(DOM.oils_rpt_editor_window_datatype, text(field.datatype));
 312
 313         _debug("setting update data window for column "+col+' on class '+cls);
 314
 315         var div = DOM.oils_rpt_column_editor;
 316         /* set a preliminary top position so the page won't bounce around */
 317         div.setAttribute('style','top:'+oilsMouseX+'px');
 318
 319         /* unhide the div so we can determine the dimensions */
 320         unHideMe(div);
 321
 322         /* don't let them see the floating div until the position is fully determined */
 323         div.style.visibility='hidden';
 324
 325         oilsRptDrawTransformWindow(path, col, cls, field);
 326         oilsRptDrawFilterWindow(path, col, cls, field);
 327
 328         //oilsRptSetFilters(field.datatype);
 329
 330         //oilsRptDoFilterWidgets();
 331
 332         //DOM.oils_rpt_filter_tform_selector.onchange = oilsRptDoFilterWidgets;
 333
 334         buildFloatingDiv(div, 600);
 335
 336         /* now let them see it */
 337         div.style.visibility='visible';
 338
 339         oilsRptSetDataWindowActions(div);
 340 }
 341
 342
 343 function oilsRptSetDataWindowActions(div) {
 344         /* give the tab links behavior */
 345         DOM.oils_rpt_tform_tab.onclick =
 346                 function(){oilsRptHideEditorDivs();unHideMe(DOM.oils_rpt_tform_div)};
 347         DOM.oils_rpt_filter_tab.onclick =
 348                 function(){oilsRptHideEditorDivs();unHideMe(DOM.oils_rpt_filter_div)};
 349         DOM.oils_rpt_agg_filter_tab.onclick =
 350                 function(){oilsRptHideEditorDivs();unHideMe(DOM.oils_rpt_agg_filter_div)};
 351
 352         DOM.oils_rpt_tform_tab.onclick();
 353         DOM.oils_rpt_column_editor_close_button.onclick = function(){hideMe(div);};
 354 }
 355
 356
 357 function oilsRptDrawFilterWindow(path, col, cls, field) {
 358         oilsRptCurrentFilterTform = new oilsRptTFormManager(DOM.oils_rpt_filter_tform_table);
 359         oilsRptCurrentFilterTform.build(field.datatype, false, true);
 360         oilsRptCurrentFilterOpManager = new oilsRptOpManager(DOM.oils_rpt_filter_op_table);
 361 }
 362
 363
 364 /* draws the transform window */
 365 function oilsRptDrawTransformWindow(path, col, cls, field) {
 366         DOM.oils_rpt_tform_label_input.value = oilsRptMakeLabel(path);
 367         var dtype = field.datatype;
 368
 369         DOM.oils_rpt_tform_submit.onclick =
 370                 function(){
 371                         /*
 372                         var tform = oilsRptGetTform(dtype);
 373                         _debug('found tform: ' + js2JSON(tform));
 374                         var params = getRptTformParams(dtype, tform);
 375                         _debug('found tform params: ' + js2JSON(params));
 376                         tform = (tform == 'raw') ? null : tform;
 377                         */
 378
 379                         var tform = oilsRptCurrentTform.getCurrentTForm();
 380                         oilsAddRptDisplayItem(path, DOM.oils_rpt_tform_label_input.value, tform.value, tform.params )
 381                 };
 382
 383
 384         DOM.oils_rpt_tform_label_input.focus();
 385         DOM.oils_rpt_tform_label_input.select();
 386
 387         oilsRptCurrentTform = new oilsRptTFormManager(DOM.oils_rpt_tform_table);
 388         oilsRptCurrentTform.build(dtype, true, true);
 389
 390         /*
 391         oilsRptHideTformFields();
 392         oilsRptUnHideTformFields(dtype);
 393         */
 394
 395         _debug("Building transiform window for datatype "+dtype);
 396
 397         /*
 398         unHideMe($('oils_rpt_tform_'+dtype+'_div'));
 399         $('oils_rpt_tform_all_raw').checked = true;
 400         */
 401 }
 402
 403 /*
 404 function oilsRptHideTformFields() {
 405         var rows = DOM.oils_rpt_tform_tbody.childNodes;
 406         for( var i = 0; i < rows.length; i++ )
 407                 if( rows[i] && rows[i].nodeType == 1 )
 408                         hideMe(rows[i]);
 409 }
 410
 411 function oilsRptUnHideTformFields(dtype) {
 412         var rows = DOM.oils_rpt_tform_tbody.childNodes;
 413         for( var i = 0; i < rows.length; i++ ) {
 414                 var row = rows[i]
 415                 if( row && row.nodeType == 1 &&
 416                         (row.getAttribute('datatype')=='all'
 417                                 || row.getAttribute('datatype') == dtype)) {
 418                         unHideMe(row);
 419                 }
 420         }
 421 }
 422
 423
 424 function oilsRptGetTform(datatype) {
 425         for( var i in oilsRptTransforms[datatype] )
 426                 if( $('oils_rpt_tform_'+datatype+'_'+oilsRptTransforms[datatype][i]).checked )
 427                         return oilsRptTransforms[datatype][i];
 428         for( var i in oilsRptTransforms.all )
 429                 if( $('oils_rpt_tform_all_'+oilsRptTransforms.all[i]).checked )
 430                         return oilsRptTransforms.all[i];
 431         return null;
 432 }
 433 */
 434
 435
 436 /*
 437 function getRptTformParams(type, tform) {
 438         switch(type) {
 439                 case 'string' :
 440                         switch(tform) {
 441                                 case 'substring' :
 442                                         return [
 443                                                 DOM.oils_rpt_tform_string_substring_offset.value,
 444                                                 DOM.oils_rpt_tform_string_substring_length.value];
 445                         }
 446         }
 447 }
 448 */
 449
 450
 451 /* given a transform selector, this displays the appropriate
 452         transforms for the given datatype.
 453         if aggregate is true, is displays the aggregate transforms */
 454 /*
 455 function oilsRptSetTransforms(sel, dtype, show_agg, show_noagg) {
 456         for( var i = 0; i < sel.options.length; i++ ) {
 457                 var opt = sel.options[i];
 458                 var t = opt.getAttribute('datatype');
 459                 if( t && t != dtype ){
 460                         hideMe(opt);
 461                 } else {
 462                         var ag = opt.getAttribute('aggregate');
 463                         if( ag && show_agg )
 464                                 unHideMe(opt);
 465                         else if( ag && ! show_agg )
 466                                 hideMe(opt)
 467                         else if( !ag && show_noagg )
 468                                 unHideMe(opt);
 469                         else
 470                                 hideMe(opt);
 471                 }
 472         }
 473 }
 474 */
 475
 476
 477 /* displays the correct filter-transforms for the given datatype */
 478 /*
 479 function oilsRptSetFilters(dtype) {
 480
 481         DOM.oils_rpt_filter_submit.onclick = function() {
 482                 var data = oilsRptDoFilterWidgets();
 483                 alert(js2JSON(data));
 484         }
 485
 486         var sel = DOM.oils_rpt_filter_tform_selector;
 487         for( var i = 0; i < sel.options.length; i++ ) {
 488                 var opt = sel.options[i];
 489                 _debug(opt.getAttribute('op'));
 490                 var t = opt.getAttribute('datatype');
 491                 if( t && t != dtype ) hideMe(opt);
 492                 else unHideMe(opt);
 493         }
 494 }
 495 */
 496
 497 /* hides all of the filter widgets */
 498 function oilsRptHideFilterWidgets(node) {
 499         if(!node)
 500                 node = DOM.oils_rpt_filter_tform_widget_td;
 501         if( node.nodeType != 1 ) return;
 502         if( node.getAttribute('widget') ) {
 503                 hideMe(node);
 504         } else {
 505                 var cs = node.childNodes;
 506                 for( var i = 0; cs && i < cs.length; i++ )
 507                         oilsRptHideFilterWidgets(cs[i]);
 508         }
 509 }
 510
 511 /* what does this need to do? */
 512 function oilsRptSetFilterOpActions() {
 513 }
 514
 515
 516
 517 /* hides/unhides the appropriate widgets and returns the parameter
 518         array appropriate for the selected widget */
 519 function oilsRptDoFilterWidgets() {
 520         filter = getSelectorVal(DOM.oils_rpt_filter_tform_selector);
 521         oilsRptHideFilterWidgets();
 522         var op = null;
 523         var tform = null;
 524         var params = null;
 525
 526         switch(filter) {
 527
 528                 /* generic transforms */
 529                 case 'equals':
 530                         if(!op) op = 'equals';
 531                 case 'like':
 532                         if(!op) op = 'like';
 533                 case 'ilike':
 534                         if(!op) op = 'ilike';
 535                 case 'gt':
 536                         if(!op) op = '>';
 537                 case 'gte':
 538                         if(!op) op = '>=';
 539                 case 'lt':
 540                         if(!op) op = '<';
 541                 case 'lte':
 542                         if(!op) op = '<=';
 543                 case 'in':
 544                         if(!op) op = 'in';
 545                 case 'not_in':
 546                         if(!op) op = 'not in';
 547                 case 'between':
 548                         if(!op) op = 'between';
 549                 case 'not_between':
 550                         if(!op) op = 'not between';
 551                         unHideMe(DOM.oils_rpt_filter_tform_input);
 552                         params = [DOM.oils_rpt_filter_tform_input.value];
 553                         break;
 554
 555                 /* timestamp transforms */
 556                 case 'date_between':
 557                         if(!op) op = 'between';
 558                 case 'date_not_between':
 559                         if(!op) op = 'not between';
 560                         tform = 'date';
 561                         var d = new Date();
 562                         unHideMe(DOM.oils_rpt_filter_tform_date_1);
 563                         unHideMe(DOM.oils_rpt_filter_tform_date_2);
 564                         unHideMe(DOM.oils_rpt_filter_tform_date_hint);
 565                         DOM.oils_rpt_filter_tform_date_1.value = mkYearMonDay();
 566                         DOM.oils_rpt_filter_tform_date_2.value = mkYearMonDay();
 567                         params = [
 568                                 DOM.oils_rpt_filter_tform_date_1.value,
 569                                 DOM.oils_rpt_filter_tform_date_2.value
 570                         ];
 571                         break;
 572
 573                 case 'dow_between':
 574                         op = 'between';
 575                         if(!tform) tform = 'dow';
 576                 case 'dow_not_between':
 577                         if(!op) op = 'not between';
 578                         if(!tform) tform = 'dow';
 579                         break;
 580
 581                 case 'dom_between':
 582                         op = 'between';
 583                         if(!tform) tform = 'dom';
 584                 case 'dom_not_between':
 585                         if(!op) op = 'not between';
 586                         if(!tform) tform = 'dom';
 587                         break;
 588
 589                 case 'month_between':
 590                         op = 'between';
 591                         if(!tform) tform = 'moy';
 592                 case 'month_not_between':
 593                         if(!op) op = 'not between';
 594                         if(!tform) tform = 'moy';
 595                         break;
 596
 597                 case 'quarter_between':
 598                         op = 'between';
 599                         if(!tform) tform = 'qoy';
 600                 case 'quarter_not_between':
 601                         if(!op) op = 'not between';
 602                         if(!tform) tform = 'qoy';
 603                         break;
 604
 605                 case 'year_between':
 606                         if(!op) op = 'between';
 607                         if(!tform) tform = 'year_trunc';
 608                 case 'year_not_between':
 609                         if(!op) op = 'not between';
 610                         if(!tform) tform = 'year_trunc';
 611                         break;
 612
 613                 case 'age_between':
 614                         if(!op) op = 'between';
 615                         if(!tform) tform = 'age';
 616                 case 'age_not_between':
 617                         if(!op) op = 'not between';
 618                         if(!tform) tform = 'age';
 619                         break;
 620
 621                 /* string transforms */
 622                 case 'substring':
 623                         if(!tform) tform = 'substring';
 624                         break;
 625
 626                 case 'lower':
 627                         if(!op) op = '';
 628                         if(!tform) tform = 'dow';
 629
 630                 case 'upper':
 631                         if(!op) op = '';
 632                         if(!tform) tform = 'dow';
 633
 634                 /* numeric transforms */
 635                 case 'round':
 636                         if(!op) op = '';
 637                         if(!tform) tform = 'dow';
 638
 639                 case 'int':
 640                         if(!op) op = '';
 641                         if(!tform) tform = 'dow';
 642         }
 643
 644         return { op : op, params : params, tform : tform };
 645 }
 646
 647
 648
 649