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