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