src/mkws-widget-main.js

   1 (function($) { // jQuery wrapper
   2
   3 // Functions follow for promoting the regular widget object into
   4 // widgets of specific types. These could be moved into their own
   5 // source files.
   6
   7
   8 mkws.registerWidgetType('targets', function() {
   9   if (!this.config.show_switch) return;
  10   var that = this;
  11
  12   this.node.html('No information available yet.');
  13   this.node.css("display", "none");
  14
  15   this.team.queue("targets").subscribe(function(data) {
  16     // There is a bug in pz2.js wherein it makes each data object an array but
  17     // simply assigns properties to it.
  18     // TODO: remove this when PAZ-946 is addressed.
  19     var cleandata = [];
  20     for (var i = 0; i < data.length; i++) {
  21       var cur = {};
  22       cur.name = data[i].name;
  23       cur.id = data[i].id;
  24       cur.hits = data[i].hits;
  25       cur.diagnostic = data[i].diagnostic;
  26       cur.message = data[i].message;
  27       cur.records = data[i].records;
  28       cur.state = data[i].state.replace(/^Client_/, '');
  29       cleandata.push(cur);
  30     }
  31
  32     cleandata.sort(function(a,b) { return a.name.localeCompare(b.name) });
  33
  34     var template = that.team.loadTemplate(that.config.template || "targets");
  35     that.node.html(template({data: cleandata}));
  36   });
  37 });
  38
  39
  40 mkws.registerWidgetType('stat', function() {
  41   var that = this;
  42   this.team.queue("stat").subscribe(function(data) {
  43     var template = that.team.loadTemplate(that.config.template || "stat");
  44     that.node.html(template(data));
  45   });
  46 });
  47
  48
  49 mkws.registerWidgetType('pager', function() {
  50   var that = this;
  51   var M = mkws.M;
  52
  53   this.team.queue("pager").subscribe(function(data) {
  54     var teamName = that.team.name();
  55     var output = {};
  56     output.first = data.start + 1;
  57     output.last = data.start + data.num;
  58     output.count = data.merged;
  59     output.found = data.total;
  60
  61     //client indexes pages from 1 but pz2 from 0
  62     var onsides = 5;
  63     var pages = Math.ceil(that.team.totalRecordCount() / that.team.perpage());
  64     var currentPage = that.team.currentPage();
  65
  66     var firstClkbl = (currentPage - onsides > 0)
  67       ? currentPage - onsides
  68       : 1;
  69     var lastClkbl = firstClkbl + 2*onsides < pages
  70       ? firstClkbl + 2*onsides
  71       : pages;
  72
  73     if (firstClkbl > 1) output.morePrev = true;
  74     if (lastClkbl < pages) output.moreNext = true;
  75
  76     if (currentPage > 1) output.prevClick = "mkws.pagerPrev(\'" + teamName + "\');";
  77
  78     output.pages = [];
  79     for(var i = firstClkbl; i <= lastClkbl; i++) {
  80       var o = {};
  81       o.number = i;
  82       if (i !== currentPage) {
  83         o.click = "mkws.showPage(\'" + teamName + "\', " + i + ");";
  84       }
  85       output.pages.push(o);
  86     }
  87
  88     if (pages - currentPage > 0) output.nextClick = "mkws.pagerNext(\'" + teamName + "\')";
  89
  90     var template = that.team.loadTemplate(that.config.template || "pager");
  91     that.node.html(template(output));
  92   });
  93 });
  94
  95 mkws.registerWidgetType('details', function() {
  96   var that = this;
  97   var recid = that.node.attr("data-mkws-recid");
  98   if (this.team.gotRecords()) {
  99     that.team.fetchDetails(recid);
 100   } else {
 101     this.team.queue("firstrecords").subscribe(function() {
 102       that.team.fetchDetails(recid);
 103     });
 104   }
 105   this.team.queue("record").subscribe(function(data) {
 106     if ($.inArray(recid, data.recid) > -1) {
 107       var template = that.team.loadTemplate(that.config.template || "details");
 108       that.node.html(template(data));
 109     }
 110   });
 111 });
 112
 113 mkws.registerWidgetType('records', function() {
 114   var that = this;
 115   var team = this.team;
 116
 117   this.team.queue("searchtriggered").subscribe(function() {
 118     var op = that.config.newsearch_opacity;
 119     if (op !== undefined) { that.node.fadeTo(500, op); }
 120   });
 121
 122   var m_dataToRedraw = null;
 123   function refreshRecordData() {
 124     that.node.css('opacity', 1);
 125
 126     if (m_dataToRedraw) {
 127       for (var i = 0; i < m_dataToRedraw.hits.length; i++) {
 128         var hit = m_dataToRedraw.hits[i];
 129         hit.detailLinkId = team.recordElementId(hit.recid[0]);
 130         hit.detailClick = "mkws.showDetails('" + team.name() + "', '" + hit.recid[0] + "');return false;";
 131         hit.containerClass = "mkws-summary mkwsSummary mkws-team-" + team.name();
 132         hit.containerClass += " " + hit.detailLinkId;
 133         // ### At some point, we may be able to move the
 134         // m_currentRecordId and m_currentRecordData members
 135         // from the team object into this widget.
 136         if (hit.recid == team.currentRecordId()) {
 137           if (team.currentRecordData()) {
 138             hit.renderedDetails = team.renderDetails(team.currentRecordData());
 139           }
 140         }
 141       }
 142       var template = team.loadTemplate(that.config.template || "records");
 143       var summaryPartial = team.loadTemplate(that.config['summary-template'] || "summary");
 144       var tdata = $.extend({}, {"hits": m_dataToRedraw.hits}, that.config.template_vars);
 145       that.node.html(template(tdata, {"partials":{"summary":summaryPartial}}));
 146     }
 147
 148     m_dataToRedraw = null;
 149   }
 150
 151   var m_frozen = false;
 152   this.team.queue("records").subscribe(function(data) {
 153     m_dataToRedraw = data;
 154     if (!m_frozen) {
 155       refreshRecordData();
 156     }
 157   });
 158
 159   var m_timer;
 160   this.node.mousemove(function() {
 161     that.debug("freezing display records");
 162     var op = that.config.freeze_opacity;
 163     if (op !== undefined) { that.node.css('opacity', op); }
 164     m_frozen = true;
 165     clearTimeout(m_timer);
 166     m_timer = setTimeout(unfreezeRecordDisplay, 1000);
 167   });
 168
 169   function unfreezeRecordDisplay() {
 170     clearTimeout(m_timer);
 171     that.debug("refreshing records");
 172     that.node.css('opacity', 1);
 173     m_frozen = false;
 174     refreshRecordData();
 175   }
 176   this.node.mouseleave(unfreezeRecordDisplay);
 177
 178   that.autosearch();
 179 });
 180
 181
 182 mkws.registerWidgetType('navi', function() {
 183   var that = this;
 184   var teamName = this.team.name();
 185
 186   this.team.queue("searchtriggered").subscribe(function() {
 187     var filters = that.team.filters();
 188     var output = {filters:[]};
 189
 190     filters.visitTargets(function(id, name) {
 191       var cur = {};
 192       cur.facet = 'source';
 193       cur.value = name;
 194       cur.click = "mkws.delimitTarget('" + teamName + "', '" + id + "'); return false;";
 195       output.filters.push(cur);
 196     });
 197
 198     filters.visitFields(function(field, value) {
 199       var cur = {};
 200       cur.facet = field;
 201       cur.value = value;
 202       cur.click = "mkws.delimitQuery('" + teamName + "', '" + field + "', '" + value + "'" + ");return false;";
 203       output.filters.push(cur);
 204     });
 205
 206     var template = that.team.loadTemplate(that.config.template || "navi");
 207     that.node.html(template(output));
 208   });
 209 });
 210
 211
 212 // It seems this and the Perpage widget doen't need to subscribe to
 213 // anything, since they produce events rather than consuming them.
 214 //
 215 mkws.registerWidgetType('sort', function() {
 216   var that = this;
 217
 218   this.node.change(function() {
 219     that.team.set_sortOrder(that.node.val());
 220     if (that.team.submitted()) {
 221       that.team.reShow();
 222     }
 223     return false;
 224   });
 225 });
 226
 227
 228 mkws.registerWidgetType('per-page', function() {
 229   var that = this;
 230
 231   this.node.change(function() {
 232     that.team.set_perpage(that.node.val());
 233     if (that.team.submitted()) {
 234       that.team.reShow();
 235     }
 236     return false;
 237   });
 238 });
 239
 240
 241 mkws.registerWidgetType('done', function() {
 242   var that = this;
 243   this.team.queue("complete").subscribe(function(n) {
 244     var template = that.team.loadTemplate(that.config.template || "done");
 245     that.node.html(template({count: n}));
 246   });
 247 });
 248
 249
 250 mkws.registerWidgetType('switch', function() {
 251   if (!this.config.show_switch) return;
 252   var tname = this.team.name();
 253   var output = {};
 254   output.recordClick = "mkws.switchView(\'" + tname + "\', \'records\')";
 255   output.targetClick = "mkws.switchView(\'" + tname + "\', \'targets\')";
 256   var template = this.team.loadTemplate(this.config.template || "switch");
 257   this.node.html(template(output));
 258   this.hideWhenNarrow();
 259 });
 260
 261
 262 mkws.registerWidgetType('search', function() {
 263   var output = {};
 264   output.team = this.team.name();
 265   var template = this.team.loadTemplate(this.config.template || "search");
 266   this.node.html(template(output));
 267 });
 268
 269
 270 mkws.registerWidgetType('search-form', function() {
 271   var team = this.team;
 272   this.node.submit(function() {
 273     var val = team.widget('query').value();
 274     team.newSearch(val);
 275     return false;
 276   });
 277 });
 278
 279
 280 mkws.registerWidgetType('results', function() {
 281   var template = this.team.loadTemplate(this.config.template || "results");
 282   this.node.html(template({team: this.team.name()}));
 283   this.autosearch();
 284 });
 285
 286
 287 mkws.registerWidgetType('ranking', function() {
 288   var output = {};
 289   output.perPage = [];
 290   output.sort = [];
 291   output.team = this.team.name();
 292   output.showSort = this.config.show_sort;
 293   output.showPerPage = this.config.show_perpage;
 294
 295   var order = this.team.sortOrder();
 296   this.info("making sort, sortOrder = '" + order + "'");
 297   for (var i = 0; i < this.config.sort_options.length; i++) {
 298     var cur = {};
 299     var opt = this.config.sort_options[i];
 300     cur.key = opt[0];
 301     cur.label = opt.length == 1 ? opt[0] : mkws.M(opt[1]);
 302     if (order == cur.key || order == cur.label) cur.selected = true;
 303     output.sort.push(cur);
 304   }
 305
 306   var perpage = this.team.perpage();
 307   this.info("making perpage, perpage = " + perpage);
 308   for(var i = 0; i < this.config.perpage_options.length; i++) {
 309     var cur = {};
 310     cur.perPage = this.config.perpage_options[i];
 311     if (cur.perPage == perpage) cur.selected = true;
 312     output.perPage.push(cur);
 313   }
 314
 315   var template = this.team.loadTemplate(this.config.template || "ranking");
 316   this.node.html(template(output));
 317 });
 318
 319
 320 mkws.registerWidgetType('lang', function() {
 321   // dynamic URL or static page? /path/foo?query=test
 322   /* create locale language menu */
 323   if (!this.config.show_lang) return;
 324
 325   var lang_default = "en";
 326   var lang = this.config.lang || lang_default;
 327   var list = [];
 328
 329   /* display a list of configured languages, or all */
 330   var lang_options = this.config.lang_options;
 331   var toBeIncluded = {};
 332   for (var i = 0; i < lang_options.length; i++) {
 333     toBeIncluded[lang_options[i]] = true;
 334   }
 335
 336   for (var k in mkws.locale_lang) {
 337     if (toBeIncluded[k] || lang_options.length == 0) {
 338       cur = {};
 339       if (lang === k) cur.selected = true;
 340       cur.code = k;
 341       cur.url = lang_url(k);
 342       list.push(cur);
 343     }
 344   }
 345
 346   // add english link
 347   if (lang_options.length == 0 || toBeIncluded[lang_default]) {
 348       cur = {};
 349       if (lang === lang_default) cur.selected = true;
 350       cur.code = lang_default;
 351       cur.url = lang_url(lang_default);
 352       list.push(cur);
 353   }
 354
 355   this.info("language menu: " + list.join(", "));
 356
 357   var template = this.team.loadTemplate(this.config.template || "lang");
 358   this.node.html(template({languages: list}));
 359   this.hideWhenNarrow();
 360
 361   // set or re-set "lang" URL parameter
 362   function lang_url(lang) {
 363     var query = location.search;
 364     // no query parameters? done
 365     if (!query) {
 366       return "?lang=" + lang;
 367     }
 368
 369     // parameter does not exist
 370     if (!query.match(/[\?&]lang=/)) {
 371       return query + "&lang=" + lang;
 372     }
 373
 374     // replace existing parameter
 375     query = query.replace(/\?lang=([^&#;]*)/, "?lang=" + lang);
 376     query = query.replace(/\&lang=([^&#;]*)/, "&lang=" + lang);
 377     return query;
 378   }
 379 });
 380
 381
 382 mkws.registerWidgetType('motd', function() {
 383   var container = this.team.widget('motd-container');
 384   if (container) {
 385     // Move the MOTD from the provided element down into the container
 386     this.node.appendTo(container.node);
 387   }
 388 });
 389
 390
 391 // This widget has no functionality of its own, but its configuration
 392 // is copied up into its team, allowing it to affect other widgets in
 393 // the team.
 394 //
 395 mkws.registerWidgetType('config', function() {
 396   var c = this.config;
 397   for (var name in c) {
 398     if (c.hasOwnProperty(name)) {
 399       this.team.config[name] = c[name];
 400       this.info(this + " copied property " + name + "='" + c[name] + "' up to team");
 401     }
 402   }
 403 });
 404
 405
 406 mkws.registerWidgetType('progress', function() {
 407   var that = this;
 408   this.node.hide();
 409   this.team.queue("stat").subscribe(function(data) {
 410     var template = that.team.loadTemplate(that.config.template || "progress");
 411     that.node.html(template({
 412       done: data.clients - data.activeclients,
 413       waiting: data.activeclients
 414     }));
 415     that.node.show();
 416   });
 417 });
 418
 419
 420 mkws.registerWidgetType('waiting', function() {
 421   var that = this;
 422
 423   this.node.css("visibility", "hidden");
 424   var template = that.team.loadTemplate(that.config.template || "waiting");
 425   this.node.html(template({
 426     src: this.config.src || "http://mkws.indexdata.com/progress.gif"
 427   }));
 428
 429   this.team.queue("searchtriggered").subscribe(function(data) {
 430     that.node.css("visibility", "visible");
 431   });
 432   this.team.queue("complete").subscribe(function(n) {
 433     that.node.css("visibility", "hidden");
 434   });
 435 });
 436
 437
 438 // Some elements have mkws* classes that makes them appear as widgets
 439 // -- for example, because we want to style them using CSS -- but have
 440 // no actual functionality. We register these to prevent ignorable
 441 // warnings when they occur.
 442
 443 mkws.registerWidgetType('query', function() {});
 444 mkws.registerWidgetType('motd-container', function() {});
 445 mkws.registerWidgetType('button', function() {});
 446
 447
 448 })(mkws.$); // jQuery wrapper