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