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