Open-ILS/web/reports/oils_rpt_report_editor.js

   1 dojo.requireLocalization("openils.reports", "reports");
   2
   3 var rpt_strings = dojo.i18n.getLocalization("openils.reports", "reports");
   4
   5 oilsRptSetSubClass('oilsRptReportEditor', 'oilsRptObject');
   6 var oilsRptReportEditorFolderTree;
   7
   8 function oilsRptReportEditor(rptObject, folderWindow, readonly) {
   9         var tmpl = rptObject.templateObject;
  10         var rpt = rptObject.reportObject;
  11         this.folderWindow = folderWindow;
  12     this.readonly = readonly;
  13
  14         this.template = tmpl;
  15         this.report = rpt;
  16
  17     if (rpt && rpt.runs() && rpt.runs().length)
  18         this.last_run = rpt.runs()[rpt.runs().length - 1];
  19
  20         appendClear(DOM.oils_rpt_report_editor_template_name, tmpl.name());
  21         appendClear(DOM.oils_rpt_report_editor_template_creator, tmpl.owner().usrname());
  22         appendClear(DOM.oils_rpt_report_editor_template_description, tmpl.description());
  23
  24     hideMe(DOM.oils_rpt_report_editor_template_doc_url_row);
  25     if (rptObject.def.version >= 4) {
  26         if (URL = rptObject.def.doc_url) {
  27             var link = DOM.oils_rpt_report_editor_template_doc_url;
  28             link.innerHTML = URL;
  29             if (typeof xulG == 'undefined') {
  30                 link.setAttribute('href', URL);
  31                 link.setAttribute('target', '_blank');
  32             } else {
  33                 link.onclick = function() {xulG.new_tab(URL); return false}
  34             }
  35             unHideMe(DOM.oils_rpt_report_editor_template_doc_url_row);
  36         }
  37     }
  38
  39     appendClear(DOM.oils_rpt_report_editor_cols,'');
  40         iterate(rptObject.def.select,
  41                 function(i) {
  42                         if(i)
  43                                 DOM.oils_rpt_report_editor_cols.appendChild(text(i.alias));
  44                 if (i.field_doc) {
  45                                     DOM.oils_rpt_report_editor_cols.appendChild(
  46                         elem('span', {'class':'oils_rpt_field_hint'}, i.field_doc));
  47                 }
  48                                 DOM.oils_rpt_report_editor_cols.appendChild(document.createElement('br'));
  49                 }
  50         );
  51
  52 /*
  53 oils_rpt_editor_pivot_label
  54 oils_rpt_editor_pivot_data
  55 */
  56
  57     var hasAgg = false;
  58     iterate(rptObject.def.select,
  59         function(i) {
  60             if(OILS_RPT_TRANSFORMS[i.column.transform].aggregate)
  61                 hasAgg = true;
  62         }
  63     );
  64
  65     while(DOM.oils_rpt_editor_pivot_label.getElementsByTagName('option').length > 1)
  66         DOM.oils_rpt_editor_pivot_label.removeChild(DOM.oils_rpt_editor_pivot_label.lastChild);
  67
  68     while(DOM.oils_rpt_editor_pivot_data.lastChild)
  69         DOM.oils_rpt_editor_pivot_data.removeChild(DOM.oils_rpt_editor_pivot_data.lastChild);
  70
  71     if(hasAgg) {
  72         unHideMe(DOM.oils_rpt_editor_pivot_label_row);
  73         unHideMe(DOM.oils_rpt_editor_pivot_data_row);
  74
  75         for(var i in rptObject.def.select) {
  76             var col = rptObject.def.select[i];
  77             if(OILS_RPT_TRANSFORMS[col.column.transform].aggregate)
  78                insertSelectorVal(DOM.oils_rpt_editor_pivot_data, -1, col.alias, parseInt(i)+1);
  79             else
  80                insertSelectorVal(DOM.oils_rpt_editor_pivot_label, -1, col.alias, parseInt(i)+1);
  81         }
  82
  83     } else {
  84         hideMe(DOM.oils_rpt_editor_pivot_label_row);
  85         hideMe(DOM.oils_rpt_editor_pivot_data_row);
  86     }
  87
  88
  89         if( rpt ) {
  90         // populate the report edit form w/ report data
  91
  92         this.orig_rpt_name = rpt.name();
  93
  94                 DOM.oils_rpt_report_editor_name.value = rpt.name();
  95                 DOM.oils_rpt_report_editor_name.onchange(); // validation
  96                 DOM.oils_rpt_report_editor_desc.value = rpt.description();
  97
  98         if (rpt.recur() == 't') {
  99             DOM.oils_rpt_recur.checked = true;
 100             DOM.oils_rpt_recur.onclick(); // enable recurrance selector
 101         }
 102
 103         if (rpt.recurrence()) {
 104             var parts = rpt.recurrence().split(/ /);
 105             setSelector(DOM.oils_rpt_recur_count, parts[0]);
 106             setSelector(DOM.oils_rpt_recur_interval_type, parts[1]);
 107         }
 108
 109         if (run = this.last_run) {
 110                     DOM.oils_rpt_report_editor_name.disabled = true;
 111                     DOM.oils_rpt_report_editor_desc.disabled = true;
 112             DOM.oils_rpt_format_csv.checked = run.csv_format() == 't';
 113             DOM.oils_rpt_format_excel.checked = run.excel_format() == 't';
 114             DOM.oils_rpt_format_html.checked = run.html_format() == 't';
 115             DOM.oils_rpt_format_chart_bar.checked = run.chart_bar() == 't';
 116             DOM.oils_rpt_format_chart_line.checked = run.chart_line() == 't';
 117         }
 118         }
 119
 120     if (this.readonly) {
 121         DOM.oils_rpt_report_editor_name.disabled = true;
 122         DOM.oils_rpt_report_editor_desc.disabled = true;
 123         DOM.oils_rpt_recur.disabled = true;
 124         DOM.oils_rpt_recur_count.disabled = true;
 125         DOM.oils_rpt_recur_interval_type.disabled = true;
 126         DOM.oils_rpt_report_editor_run_now.disabled = true;
 127         DOM.oils_rpt_format_csv.disabled = true;
 128         DOM.oils_rpt_format_excel.disabled = true;
 129         DOM.oils_rpt_format_html.disabled = true;
 130         DOM.oils_rpt_format_chart_bar.disabled = true;
 131         DOM.oils_rpt_format_chart_line.disabled = true;
 132         DOM.oils_rpt_param_editor_sched_email.disabled = true;
 133
 134         hideMe(DOM.oils_rpt_report_editor_save);
 135         hideMe(DOM.oils_rpt_report_editor_save_new);
 136         hideMe(DOM.oils_rpt_report_editor_cancel);
 137         unHideMe(DOM.oils_rpt_report_editor_exit);
 138
 139     } else {
 140         // these DOM elements are shared across instances
 141         // of the UI.  Re-enable everything.
 142         DOM.oils_rpt_report_editor_name.disabled = false;
 143         DOM.oils_rpt_report_editor_desc.disabled = false;
 144         DOM.oils_rpt_recur.disabled = false;
 145         DOM.oils_rpt_recur_count.disabled = false;
 146         DOM.oils_rpt_recur_interval_type.disabled = false;
 147         DOM.oils_rpt_report_editor_run_now.disabled = false;
 148         DOM.oils_rpt_format_csv.disabled = false;
 149         DOM.oils_rpt_format_excel.disabled = false;
 150         DOM.oils_rpt_format_html.disabled = false;
 151         DOM.oils_rpt_format_chart_bar.disabled = false;
 152         DOM.oils_rpt_format_chart_line.disabled = false;
 153         DOM.oils_rpt_param_editor_sched_email.disabled = false;
 154         DOM.oils_rpt_report_editor_save.disabled = false;
 155
 156         unHideMe(DOM.oils_rpt_report_editor_save);
 157         unHideMe(DOM.oils_rpt_report_editor_save_new);
 158         unHideMe(DOM.oils_rpt_report_editor_cancel);
 159         hideMe(DOM.oils_rpt_report_editor_exit);
 160     }
 161
 162         this.paramEditor = new oilsRptParamEditor(
 163                 rptObject, DOM.oils_rpt_param_editor_tbody, this.readonly);
 164         this.paramEditor.draw();
 165
 166         removeChildren(DOM.oils_rpt_report_editor_selected_folder);
 167         removeChildren(DOM.oils_rpt_output_selected_folder);
 168
 169         var obj = this;
 170         oilsRptBuildFolder(
 171                 'report',
 172                 DOM.oils_rpt_report_editor_dest_folder,
 173                 'oilsRptReportEditorFolderTree',
 174                 rpt_strings.REPORT_EDITOR_REPORT_FOLDERS,
 175                 function(node) {
 176                         appendClear(DOM.oils_rpt_report_editor_selected_folder, node.folder.name());
 177                         obj.selectedFolder = node;
 178         },
 179         null,
 180         function(node) {
 181             // apply the previously selected report folder
 182             if (rpt && rpt.folder() == node.folder.id()) {
 183                             appendClear(DOM.oils_rpt_report_editor_selected_folder, node.folder.name());
 184                             obj.selectedFolder = node;
 185             }
 186         }
 187     );
 188
 189         oilsRptBuildFolder(
 190                 'output',
 191                 DOM.oils_rpt_output_dest_folder,
 192                 'oilsRptReportEditorOutputTree',
 193                 rpt_strings.REPORT_EDITOR_OUTPUT_FOLDERS,
 194                 function(node) {
 195                         appendClear(DOM.oils_rpt_output_selected_folder, node.folder.name());
 196                         obj.selectedOutputFolder = node;
 197         },
 198         null,
 199         function(node) {
 200             // apply the previously selected output folder
 201             if (obj.last_run && obj.last_run.folder() == node.folder.id()) {
 202                             appendClear(DOM.oils_rpt_output_selected_folder, node.folder.name());
 203                             obj.selectedOutputFolder = node;
 204             }
 205         }
 206     );
 207
 208
 209         var obj = this;
 210         DOM.oils_rpt_report_editor_save.onclick = function(){obj.save();}
 211         DOM.oils_rpt_report_editor_save_new.onclick = function(){obj.save({save_new : true});}
 212         DOM.oils_rpt_report_editor_exit.onclick = function(){obj.exit();}
 213         DOM.oils_rpt_report_editor_cancel.onclick = function(){obj.exit();}
 214
 215         DOM.oils_rpt_param_editor_sched_email.value =
 216         this.last_run ? this.last_run.email() : USER.email();
 217
 218         DOM.oils_rpt_param_editor_sched_start_date.value = mkYearMonDay();
 219
 220         _debug("fleshing template:\n" + tmpl.name() + '\n' + formatJSON(tmpl.data()));
 221 }
 222
 223
 224 // options.save_new : save as a new report, even if we
 225 // were editing an exitingn report.
 226 //
 227 // options.modify_schedule : update the pending schedule
 228 // object instead of creating a new one.
 229 oilsRptReportEditor.prototype.save = function(options) {
 230     if (!options) options = {};
 231
 232         if(!this.selectedFolder)
 233                 return alert(rpt_strings.REPORT_EDITOR_PROVIDE_FOLDER_ALERT);
 234
 235         if(!DOM.oils_rpt_report_editor_name.value)
 236                 return alert(rpt_strings.REPORT_EDITOR_ENTER_NAME_ALERT);
 237
 238         if(!this.selectedOutputFolder)
 239                 return alert(rpt_strings.REPORT_EDITOR_PROVIDE_OUTPUT_ALERT);
 240
 241         var report = this.report;
 242
 243     if (report && options.save_new) {
 244         // user is saving an existing report as a new report.
 245         // The new report must have a different name.
 246         if (DOM.oils_rpt_report_editor_name.value == this.orig_rpt_name)
 247             return alert(rpt_strings.REPORT_EDITOR_ENTER_NEW_NAME_ALERT);
 248
 249         report = null;
 250     }
 251
 252     if (!report) {
 253         report = new rr();
 254         report.isnew(true);
 255             report.owner( USER.id() );
 256             report.template( this.template.id() );
 257     }
 258
 259         report.folder( this.selectedFolder.folder.id() );
 260         report.name( DOM.oils_rpt_report_editor_name.value );
 261         report.description( DOM.oils_rpt_report_editor_desc.value );
 262         report.recur(this.paramEditor.recur());
 263         report.recurrence(this.paramEditor.recurInterval());
 264
 265         /* collect the param data */
 266         var data = {};
 267         for( var p in this.paramEditor.params ) {
 268                 var par = this.paramEditor.params[p];
 269                 _debug("adding report param "+par.key+" to report data");
 270                 var val = par.widget.getValue();
 271
 272                 if(!val || val.length == 0 )
 273                         return alertId('oils_rpt_empty_param');
 274
 275                 if( typeof val == 'object') {
 276                         for( var i = i; i < val.length; i++ ) {
 277                                 _debug("looking at widget value" + val[i]);
 278                                 if( val[i] == '' || val[i] == null )
 279                                         return alertId('oils_rpt_empty_param');
 280                         }
 281                 }
 282
 283                 data[par.key] = val;
 284         }
 285
 286     if(getSelectorVal(DOM.oils_rpt_editor_pivot_data)) {
 287         data.__pivot_label = getSelectorVal(DOM.oils_rpt_editor_pivot_label);
 288         data.__pivot_data = getSelectorVal(DOM.oils_rpt_editor_pivot_data);
 289     }
 290
 291
 292         data = js2JSON(data);
 293         _debug("complete report data = "+data);
 294         report.data(data);
 295
 296         _debug("Built report:\n"+js2JSON(report));
 297
 298
 299         var time;
 300         if( DOM.oils_rpt_report_editor_run_now.checked ) {
 301                 DOM.oils_rpt_report_editor_run_now.checked = false;
 302                 time = 'now';
 303
 304         } else {
 305
 306                 var dt = DOM.oils_rpt_param_editor_sched_start_date.value;
 307                 if(!dt || !dt.match(/^\d{4}-\d{2}-\d{2}$/) ) {
 308                         /* for now.. make this better in the future */
 309                         alert(rpt_strings.REPORT_EDITOR_INVALID_DATE_ALERT);
 310                         return;
 311                 }
 312                 var hour = getSelectorVal(DOM.oils_rpt_param_editor_sched_start_hour);
 313                 time = dt +'T'+hour+':00';
 314                 _debug("built run_time "+time);
 315         }
 316
 317     // if the last run has yet to actually start, then we update it
 318     // instead of creating a new one.
 319     var schedule = options.save_new ? null : this.last_run;
 320
 321     if (schedule && !schedule.start_time()) {
 322         if (!options.modify_schedule) {
 323             // warn the user that this action will modify an existing
 324             // schedule object if they continue
 325             return this.showPendingScheduleDialog();
 326         }
 327     } else {
 328         // no schedules exist or the most recent one has already
 329         // started.  Create a new one.
 330             schedule = new rs();
 331         schedule.isnew(true);
 332     }
 333
 334         schedule.folder(this.selectedOutputFolder.folder.id());
 335         schedule.email(DOM.oils_rpt_param_editor_sched_email.value);
 336         schedule.run_time(time);
 337         schedule.runner(USER.id());
 338
 339         schedule.excel_format((DOM.oils_rpt_format_excel.checked) ? 't' : 'f');
 340         schedule.html_format((DOM.oils_rpt_format_html.checked) ? 't' : 'f');
 341         schedule.csv_format((DOM.oils_rpt_format_csv.checked) ? 't' : 'f');
 342         //schedule.chart_pie((DOM.oils_rpt_format_chart_pie.checked) ? 't' : 'f');
 343         schedule.chart_bar((DOM.oils_rpt_format_chart_bar.checked) ? 't' : 'f');
 344         schedule.chart_line((DOM.oils_rpt_format_chart_line.checked) ? 't' : 'f');
 345
 346         debugFMObject(report);
 347         debugFMObject(schedule);
 348
 349     if (report.isnew()) {
 350         this.createReport(report, schedule);
 351     } else {
 352         this.updateReport(report, schedule);
 353     }
 354 }
 355
 356 // Modify an existing report.
 357 // Modify or create the schedule depending on isnew()
 358 oilsRptReportEditor.prototype.updateReport = function(report, schedule) {
 359
 360     var this_ = this;
 361     function success() {
 362         oilsRptAlertSuccess();
 363         this_.exit();
 364     }
 365
 366     oilsRptUpdateReport(report, function(ok) {
 367         if (!ok) return oilsRptAlertFailure();
 368
 369         if (schedule.isnew()) {
 370
 371             var req = new Request(OILS_RPT_CREATE_SCHEDULE, SESSION, schedule);
 372             req.callback(function(res) {
 373                 if(checkILSEvent(res))
 374                     return alertILSEvent(res);
 375                 success();
 376             });
 377             req.send()
 378
 379         } else {
 380
 381             oilsRptUpdateSchedule(schedule, function(ok2) {
 382                 if (ok2) return success();
 383                 _debug("schedule update failed " + js2JSON(schedule));
 384                 oilsRptAlertFailure();
 385             });
 386         }
 387     });
 388 }
 389
 390 oilsRptReportEditor.prototype.createReport = function(report, schedule) {
 391         var obj = this;
 392     var folderReq = new Request(OILS_RPT_REPORT_EXISTS, SESSION, report);
 393     folderReq.callback(
 394         function(r1) {
 395             if(r1.getResultObject() == 1) {
 396                 alertId('oils_rpt_report_exists');
 397                 return;
 398             } else {
 399                 var req = new Request(OILS_RPT_CREATE_REPORT, SESSION, report, schedule );
 400                 req.callback(
 401                     function(r) {
 402                         var res = r.getResultObject();
 403                         if(checkILSEvent(res)) {
 404                             alertILSEvent(res);
 405                         } else {
 406                             if( res && res != '0' ) {
 407                                 oilsRptAlertSuccess();
 408                                 obj.exit();
 409                             }
 410                         }
 411                     }
 412                 );
 413                 req.send();
 414             }
 415         }
 416     );
 417     folderReq.send();
 418 }
 419
 420 oilsRptReportEditor.prototype.showPendingScheduleDialog = function() {
 421     hideMe(DOM.oils_rpt_editor_table);
 422     unHideMe(DOM.oils_rpt_editor_sched_confirm);
 423
 424     function close() {
 425         unHideMe(DOM.oils_rpt_editor_table);
 426         hideMe(DOM.oils_rpt_editor_sched_confirm);
 427     }
 428
 429     var this_ = this;
 430     DOM.oils_rpt_report_editor_sched_apply.onclick = function() {
 431         close();
 432         this_.save({modify_schedule : true});
 433     }
 434
 435     DOM.oils_rpt_report_editor_sched_asnew.onclick = function() {
 436
 437         if (DOM.oils_rpt_report_editor_name.value == this_.orig_rpt_name) {
 438             // user is saving as new but has not yet modified the name
 439             // Prompt for a new name, then udpate the name entry so save()
 440             // will see it.  Don't let them escape until they comply.
 441             var new_name;
 442             while (true) {
 443
 444                 new_name = prompt(
 445                     rpt_strings.REPORT_EDITOR_ENTER_NEW_NAME_ALERT,
 446                     this_.orig_rpt_name
 447                 );
 448
 449                 if (new_name && new_name != this_.orig_rpt_name)
 450                     break;
 451             }
 452
 453             DOM.oils_rpt_report_editor_name.value = new_name;
 454         }
 455
 456         close();
 457         this_.save({save_new : true})
 458     }
 459     DOM.oils_rpt_report_editor_sched_cancel.onclick = close;
 460 }
 461
 462
 463 oilsRptReportEditor.prototype.exit = function() {
 464     oilsRptCurrentFolderManager.draw();
 465     this.folderWindow.draw();
 466 }