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   var m_data;
 117   var m_needRedraw = false;
 118   var m_frozen = false;
 119
 120   this.team.queue("searchtriggered").subscribe(function() {
 121     var op = that.config.newsearch_opacity;
 122     if (op !== undefined) { that.node.fadeTo(500, op); }
 123   });
 124
 125   function refreshRecordData() {
 126     that.node.css('opacity', 1);
 127
 128     if (m_needRedraw) {
 129       for (var i = 0; i < m_data.hits.length; i++) {
 130         var hit = m_data.hits[i];
 131         hit.detailLinkId = team.recordElementId(hit.recid[0]);
 132         hit.detailClick = "mkws.showDetails('" + team.name() + "', '" + hit.recid[0] + "');return false;";
 133         hit.containerClass = "mkws-summary mkwsSummary mkws-team-" + team.name();
 134         hit.containerClass += " " + hit.detailLinkId;
 135         // ### At some point, we may be able to move the
 136         // m_currentRecordId and m_currentRecordData members
 137         // from the team object into this widget.
 138         if (hit.recid == team.currentRecordId()) {
 139           if (team.currentRecordData()) {
 140             hit.renderedDetails = team.renderDetails(team.currentRecordData());
 141           }
 142         }
 143       }
 144       var template = team.loadTemplate(that.config.template || "records");
 145       var summaryPartial = team.loadTemplate(that.config['summary-template'] || "summary");
 146       var tdata = $.extend({}, {"hits": m_data.hits}, that.config.template_vars);
 147       that.node.html(template(tdata, {"partials":{"summary":summaryPartial}}));
 148     }
 149
 150     m_needRedraw = false;
 151   }
 152
 153   function setRecordData(data) {
 154     m_data = data;
 155     m_needRedraw = true;
 156     if (!m_frozen) {
 157       refreshRecordData();
 158     }
 159   }
 160
 161   this.team.queue("records").subscribe(setRecordData);
 162
 163   var m_timer;
 164   this.node.mousemove(function() {
 165     that.info("freezing display records");
 166     that.node.css('opacity', 0.5);
 167     m_frozen = true;
 168     clearTimeout(m_timer);
 169     m_timer = setTimeout(unfreezeRecordDisplay, 1000);
 170   });
 171
 172   function unfreezeRecordDisplay() {
 173     clearTimeout(m_timer);
 174     that.info("refreshing records");
 175     that.node.css('opacity', 1);
 176     m_frozen = false;
 177     refreshRecordData();
 178   }
 179   this.node.mouseleave(unfreezeRecordDisplay);
 180
 181   that.autosearch();
 182 });
 183
 184
 185 mkws.registerWidgetType('navi', function() {
 186   var that = this;
 187   var teamName = this.team.name();
 188
 189   this.team.queue("searchtriggered").subscribe(function() {
 190     var filters = that.team.filters();
 191     var output = {filters:[]};
 192
 193     filters.visitTargets(function(id, name) {
 194       var cur = {};
 195       cur.facet = 'source';
 196       cur.value = name;
 197       cur.click = "mkws.delimitTarget('" + teamName + "', '" + id + "'); return false;";
 198       output.filters.push(cur);
 199     });
 200
 201     filters.visitFields(function(field, value) {
 202       var cur = {};
 203       cur.facet = field;
 204       cur.value = value;
 205       cur.click = "mkws.delimitQuery('" + teamName + "', '" + field + "', '" + value + "'" + ");return false;";
 206       output.filters.push(cur);
 207     });
 208
 209     var template = that.team.loadTemplate(that.config.template || "navi");
 210     that.node.html(template(output));
 211   });
 212 });
 213
 214
 215 // It seems this and the Perpage widget doen't need to subscribe to
 216 // anything, since they produce events rather than consuming them.
 217 //
 218 mkws.registerWidgetType('sort', function() {
 219   var that = this;
 220
 221   this.node.change(function() {
 222     that.team.set_sortOrder(that.node.val());
 223     if (that.team.submitted()) {
 224       that.team.reShow();
 225     }
 226     return false;
 227   });
 228 });
 229
 230
 231 mkws.registerWidgetType('per-page', function() {
 232   var that = this;
 233
 234   this.node.change(function() {
 235     that.team.set_perpage(that.node.val());
 236     if (that.team.submitted()) {
 237       that.team.reShow();
 238     }
 239     return false;
 240   });
 241 });
 242
 243
 244 mkws.registerWidgetType('done', function() {
 245   var that = this;
 246   this.team.queue("complete").subscribe(function(n) {
 247     var template = that.team.loadTemplate(that.config.template || "done");
 248     that.node.html(template({count: n}));
 249   });
 250 });
 251
 252
 253 mkws.registerWidgetType('switch', function() {
 254   if (!this.config.show_switch) return;
 255   var tname = this.team.name();
 256   var output = {};
 257   output.recordClick = "mkws.switchView(\'" + tname + "\', \'records\')";
 258   output.targetClick = "mkws.switchView(\'" + tname + "\', \'targets\')";
 259   var template = this.team.loadTemplate(this.config.template || "switch");
 260   this.node.html(template(output));
 261   this.hideWhenNarrow();
 262 });
 263
 264
 265 mkws.registerWidgetType('search', function() {
 266   var output = {};
 267   output.team = this.team.name();
 268   var template = this.team.loadTemplate(this.config.template || "search");
 269   this.node.html(template(output));
 270 });
 271
 272
 273 mkws.registerWidgetType('search-form', function() {
 274   var team = this.team;
 275   this.node.submit(function() {
 276     var val = team.widget('query').value();
 277     team.newSearch(val);
 278     return false;
 279   });
 280 });
 281
 282
 283 mkws.registerWidgetType('results', function() {
 284   var template = this.team.loadTemplate(this.config.template || "results");
 285   this.node.html(template({team: this.team.name()}));
 286   this.autosearch();
 287 });
 288
 289
 290 mkws.registerWidgetType('ranking', function() {
 291   var output = {};
 292   output.perPage = [];
 293   output.sort = [];
 294   output.team = this.team.name();
 295   output.showSort = this.config.show_sort;
 296   output.showPerPage = this.config.show_perpage;
 297
 298   var order = this.team.sortOrder();
 299   this.info("making sort, sortOrder = '" + order + "'");
 300   for (var i = 0; i < this.config.sort_options.length; i++) {
 301     var cur = {};
 302     var opt = this.config.sort_options[i];
 303     cur.key = opt[0];
 304     cur.label = opt.length == 1 ? opt[0] : mkws.M(opt[1]);
 305     if (order == cur.key || order == cur.label) cur.selected = true;
 306     output.sort.push(cur);
 307   }
 308
 309   var perpage = this.team.perpage();
 310   this.info("making perpage, perpage = " + perpage);
 311   for(var i = 0; i < this.config.perpage_options.length; i++) {
 312     var cur = {};
 313     cur.perPage = this.config.perpage_options[i];
 314     if (cur.perPage == perpage) cur.selected = true;
 315     output.perPage.push(cur);
 316   }
 317
 318   var template = this.team.loadTemplate(this.config.template || "ranking");
 319   this.node.html(template(output));
 320 });
 321
 322
 323 mkws.registerWidgetType('lang', function() {
 324   // dynamic URL or static page? /path/foo?query=test
 325   /* create locale language menu */
 326   if (!this.config.show_lang) return;
 327
 328   var lang_default = "en";
 329   var lang = this.config.lang || lang_default;
 330   var list = [];
 331
 332   /* display a list of configured languages, or all */
 333   var lang_options = this.config.lang_options;
 334   var toBeIncluded = {};
 335   for (var i = 0; i < lang_options.length; i++) {
 336     toBeIncluded[lang_options[i]] = true;
 337   }
 338
 339   for (var k in mkws.locale_lang) {
 340     if (toBeIncluded[k] || lang_options.length == 0) {
 341       cur = {};
 342       if (lang === k) cur.selected = true;
 343       cur.code = k;
 344       cur.url = lang_url(k);
 345       list.push(cur);
 346     }
 347   }
 348
 349   // add english link
 350   if (lang_options.length == 0 || toBeIncluded[lang_default]) {
 351       cur = {};
 352       if (lang === lang_default) cur.selected = true;
 353       cur.code = lang_default;
 354       cur.url = lang_url(lang_default);
 355       list.push(cur);
 356   }
 357
 358   this.info("language menu: " + list.join(", "));
 359
 360   var template = this.team.loadTemplate(this.config.template || "lang");
 361   this.node.html(template({languages: list}));
 362   this.hideWhenNarrow();
 363
 364   // set or re-set "lang" URL parameter
 365   function lang_url(lang) {
 366     var query = location.search;
 367     // no query parameters? done
 368     if (!query) {
 369       return "?lang=" + lang;
 370     }
 371
 372     // parameter does not exist
 373     if (!query.match(/[\?&]lang=/)) {
 374       return query + "&lang=" + lang;
 375     }
 376
 377     // replace existing parameter
 378     query = query.replace(/\?lang=([^&#;]*)/, "?lang=" + lang);
 379     query = query.replace(/\&lang=([^&#;]*)/, "&lang=" + lang);
 380     return query;
 381   }
 382 });
 383
 384
 385 mkws.registerWidgetType('motd', function() {
 386   var container = this.team.widget('motd-container');
 387   if (container) {
 388     // Move the MOTD from the provided element down into the container
 389     this.node.appendTo(container.node);
 390   }
 391 });
 392
 393
 394 // This widget has no functionality of its own, but its configuration
 395 // is copied up into its team, allowing it to affect other widgets in
 396 // the team.
 397 //
 398 mkws.registerWidgetType('config', function() {
 399   var c = this.config;
 400   for (var name in c) {
 401     if (c.hasOwnProperty(name)) {
 402       this.team.config[name] = c[name];
 403       this.info(this + " copied property " + name + "='" + c[name] + "' up to team");
 404     }
 405   }
 406 });
 407
 408
 409 mkws.registerWidgetType('progress', function() {
 410   var that = this;
 411   this.node.hide();
 412   this.team.queue("stat").subscribe(function(data) {
 413     var template = that.team.loadTemplate(that.config.template || "progress");
 414     that.node.html(template({
 415       done: data.clients - data.activeclients,
 416       waiting: data.activeclients
 417     }));
 418     that.node.show();
 419   });
 420 });
 421
 422
 423 mkws.registerWidgetType('waiting', function() {
 424   var that = this;
 425
 426   this.node.css("visibility", "hidden");
 427   var template = that.team.loadTemplate(that.config.template || "waiting");
 428   this.node.html(template({
 429     src: this.config.src || "http://mkws.indexdata.com/progress.gif"
 430   }));
 431
 432   this.team.queue("searchtriggered").subscribe(function(data) {
 433     that.node.css("visibility", "visible");
 434   });
 435   this.team.queue("complete").subscribe(function(n) {
 436     that.node.css("visibility", "hidden");
 437   });
 438 });
 439
 440
 441 // Some elements have mkws* classes that makes them appear as widgets
 442 // -- for example, because we want to style them using CSS -- but have
 443 // no actual functionality. We register these to prevent ignorable
 444 // warnings when they occur.
 445
 446 mkws.registerWidgetType('query', function() {});
 447 mkws.registerWidgetType('motd-container', function() {});
 448 mkws.registerWidgetType('button', function() {});
 449
 450
 451 })(mkws.$); // jQuery wrapper