More comments
[mkws-moved-to-github.git] / src / mkws-team.js
1 // Factory function for team objects. As much as possible, this uses
2 // only member variables (prefixed "m_") and inner functions with
3 // private scope.
4 //
5 // Some functions are visible as member-functions to be called from
6 // outside code -- specifically, from generated HTML. These functions
7 // are that.switchView(), showDetails(), limitTarget(), limitQuery(),
8 // delimitTarget(), delimitQuery(), showPage(), pagerPrev(),
9 // pagerNext().
10 //
11 function team($, teamName) {
12     var that = {};
13     var m_teamName = teamName;
14     var m_submitted = false;
15     var m_query; // initially undefined
16     var m_sortOrder; // will be set below
17     var m_perpage; // will be set below
18     var m_filters = [];
19     var m_totalRecordCount = 0;
20     var m_currentPage = 1;
21     var m_currentRecordId = '';
22     var m_currentRecordData = null;
23     var m_logTime = {
24         // Timestamps for logging
25         "start": $.now(),
26         "last": $.now()
27     };
28     var m_paz; // will be initialised below
29     var m_template = {};
30
31
32     // Accessor methods for individual widgets: readers
33     that.name = function() { return m_teamName; }
34     that.submitted = function() { return m_submitted; }
35     that.perpage = function() { return m_perpage; }
36     that.totalRecordCount = function() { return m_totalRecordCount; }
37     that.currentPage = function() { return m_currentPage; }
38     that.currentRecordId = function() { return m_currentRecordId; }
39     that.currentRecordData = function() { return m_currentRecordData; }
40     that.filters = function() { return m_filters; }
41
42     // Accessor methods for individual widgets: writers
43     that.set_sortOrder = function(val) { m_sortOrder = val };
44     that.set_perpage = function(val) { m_perpage = val };
45
46
47     var log = function (s) {
48         var now = $.now();
49         var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
50         m_logTime.last = now;
51
52         mkws.log(m_teamName + ": " + timestamp + s);
53     }
54     that.log = log;
55
56     log("start running MKWS");
57
58     m_sortOrder = mkws_config.sort_default;
59     m_perpage = mkws_config.perpage_default;
60
61     log("Create main pz2 object");
62     // create a parameters array and pass it to the pz2's constructor
63     // then register the form submit event with the pz2.search function
64     // autoInit is set to true on default
65     m_paz = new pz2({ "windowid": teamName,
66                       "pazpar2path": mkws_config.pazpar2_url,
67                       "usesessions" : mkws_config.use_service_proxy ? false : true,
68                       "oninit": onInit,
69                       "onbytarget": onBytarget,
70                       "onstat": onStat,
71                       "onterm": (mkws_config.facets.length ? onTerm : undefined),
72                       "onshow": onShow,
73                       "onrecord": onRecord,
74                       "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
75                       "termlist": mkws_config.facets.join(',')
76                     });
77
78
79     //
80     // pz2.js event handlers:
81     //
82     function onInit() {
83         log("init");
84         m_paz.stat();
85         m_paz.bytarget();
86     }
87
88
89     function onBytarget(data) {
90         log("target");
91         queue("targets").publish(data);
92     }
93
94
95     function onStat(data) {
96         log("stat");
97         queue("stat").publish(data);
98     }
99
100
101     function onTerm(data) {
102         log("term");
103         queue("termlists").publish(data);
104     }
105
106
107     function onShow(data, teamName) {
108         log("show");
109         m_totalRecordCount = data.merged;
110         queue("pager").publish(data);
111         queue("records").publish(data);
112     }
113
114
115     function onRecord(data, args, teamName) {
116         log("record");
117         // FIXME: record is async!!
118         clearTimeout(m_paz.recordTimer);
119         // ##### restrict to current team
120         var detRecordDiv = document.getElementById(recordDetailsId(data.recid[0]));
121         if (detRecordDiv) {
122             // in case on_show was faster to redraw element
123             return;
124         }
125         m_currentRecordData = data;
126         var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
127         var html = renderDetails(m_currentRecordData);
128         $(recordDiv).append(html);
129     }
130
131
132     // Used by promoteRecords() and onRecord()
133     function recordElementId(s) {
134         return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
135     }
136     that.recordElementId = recordElementId;
137
138     // Used by onRecord(), showDetails() and renderDetails()
139     function recordDetailsId(s) {
140         return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
141     }
142     that.recordElementId = recordElementId;
143
144
145     that.targetFiltered = function(id) {
146         for (var i = 0; i < m_filters.length; i++) {
147             if (m_filters[i].id === id ||
148                 m_filters[i].id === 'pz:id=' + id) {
149                 return true;
150             }
151         }
152         return false;
153     }
154
155
156     ////////////////////////////////////////////////////////////////////////////////
157     ////////////////////////////////////////////////////////////////////////////////
158
159
160     // when search button pressed
161     function onFormSubmitEventHandler()
162     {
163         var val = findnode('.mkwsQuery').val();
164         newSearch(val);
165         return false;
166     }
167
168
169     function newSearch(query, sortOrder, targets)
170     {
171         log("newSearch: " + query);
172
173         if (mkws_config.use_service_proxy && !mkws.authenticated) {
174             alert("searching before authentication");
175             return;
176         }
177
178         m_filters = []
179         triggerSearch(query, sortOrder, targets);
180         switchView('records'); // In case it's configured to start off as hidden
181         m_submitted = true;
182     }
183
184
185     // limit by target functions
186     that.limitTarget  = function (id, name)
187     {
188         log("limitTarget(id=" + id + ", name=" + name + ")");
189         m_filters.push({ id: id, name: name });
190         triggerSearch();
191         return false;
192     }
193
194
195     // limit the query after clicking the facet
196     that.limitQuery = function (field, value)
197     {
198         log("limitQuery(field=" + field + ", value=" + value + ")");
199         m_filters.push({ field: field, value: value });
200         triggerSearch();
201         return false;
202     }
203
204
205     that.delimitTarget = function (id)
206     {
207         log("delimitTarget(id=" + id + ")");
208         var newFilters = [];
209         for (var i in m_filters) {
210             var filter = m_filters[i];
211             if (filter.id) {
212                 log("delimitTarget() removing filter " + $.toJSON(filter));
213             } else {
214                 log("delimitTarget() keeping filter " + $.toJSON(filter));
215                 newFilters.push(filter);
216             }
217         }
218         m_filters = newFilters;
219
220         triggerSearch();
221         return false;
222     }
223
224
225     that.delimitQuery = function (field, value)
226     {
227         log("delimitQuery(field=" + field + ", value=" + value + ")");
228         var newFilters = [];
229         for (var i in m_filters) {
230             var filter = m_filters[i];
231             if (filter.field &&
232                 field == filter.field &&
233                 value == filter.value) {
234                 log("delimitQuery() removing filter " + $.toJSON(filter));
235             } else {
236                 log("delimitQuery() keeping filter " + $.toJSON(filter));
237                 newFilters.push(filter);
238             }
239         }
240         m_filters = newFilters;
241
242         triggerSearch();
243         return false;
244     }
245
246
247     function resetPage()
248     {
249         m_currentPage = 1;
250         m_totalRecordCount = 0;
251     }
252     that.resetPage = resetPage;
253
254
255     function triggerSearch (query, sortOrder, targets)
256     {
257         resetPage();
258         queue("navi").publish();
259
260         var pp2filter = "";
261         var pp2limit = "";
262
263         // Continue to use previous query/sort-order unless new ones are specified
264         if (query) {
265             m_query = query;
266         }
267         if (sortOrder) {
268             m_sortOrder = sortOrder;
269         }
270         if (targets) {
271             m_filters.push({ id: targets, name: targets });
272         }
273
274         for (var i in m_filters) {
275             var filter = m_filters[i];
276             if (filter.id) {
277                 if (pp2filter)
278                     pp2filter += ",";
279                 if (filter.id.match(/^[a-z:]+[=~]/)) {
280                     log("filter '" + filter.id + "' already begins with SETTING OP");
281                 } else {
282                     filter.id = 'pz:id=' + filter.id;
283                 }
284                 pp2filter += filter.id;
285             } else {
286                 if (pp2limit)
287                     pp2limit += ",";
288                 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
289             }
290         }
291
292         var params = {};
293         if (pp2limit) {
294             params.limit = pp2limit;
295         }
296
297         log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
298
299         // We can use: params.torusquery = "udb=NAME"
300         // Note: that won't work when running against raw pazpar2
301         m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
302     }
303
304
305     that.reShow = function() {
306         m_paz.show(0, m_perpage, m_sortOrder);
307     }
308
309
310
311     that.showPage = function (pageNum)
312     {
313         m_currentPage = pageNum;
314         m_paz.showPage(m_currentPage - 1);
315     }
316
317
318     // simple paging functions
319     that.pagerNext = function () {
320         if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
321             m_paz.showNext();
322             m_currentPage++;
323         }
324     }
325
326
327     that.pagerPrev = function () {
328         if (m_paz.showPrev() != false)
329             m_currentPage--;
330     }
331
332
333     // switching view between targets and records
334     function switchView(view) {
335         var targets = findnode('.mkwsTargets');
336         var results = findnode('.mkwsResults,.mkwsRecords');
337         var blanket = findnode('.mkwsBlanket');
338         var motd    = findnode('.mkwsMOTD');
339
340         switch(view) {
341         case 'targets':
342             if (targets) targets.css('display', 'block');
343             if (results) results.css('display', 'none');
344             if (blanket) blanket.css('display', 'none');
345             if (motd) motd.css('display', 'none');
346             break;
347         case 'records':
348             if (targets) targets.css('display', 'none');
349             if (results) results.css('display', 'block');
350             if (blanket) blanket.css('display', 'block');
351             if (motd) motd.css('display', 'none');
352             break;
353         case 'none':
354             alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
355             if (targets) targets.css('display', 'none');
356             if (results) results.css('display', 'none');
357             if (blanket) blanket.css('display', 'none');
358             if (motd) motd.css('display', 'none');
359             break;
360         default:
361             alert("Unknown view '" + view + "'");
362         }
363     }
364     that.switchView = switchView;
365
366
367     // detailed record drawing
368     that.showDetails = function (recId) {
369         var oldRecordId = m_currentRecordId;
370         m_currentRecordId = recId;
371
372         // remove current detailed view if any
373         // ##### restrict to current team
374         var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
375         // lovin DOM!
376         if (detRecordDiv)
377             detRecordDiv.parentNode.removeChild(detRecordDiv);
378
379         // if the same clicked, just hide
380         if (recId == oldRecordId) {
381             m_currentRecordId = '';
382             m_currentRecordData = null;
383             return;
384         }
385         // request the record
386         log("showDetails() requesting record '" + recId + "'");
387         m_paz.record(recId);
388     }
389
390
391     /*
392      * All the HTML stuff to render the search forms and
393      * result pages.
394      */
395     function mkwsHtmlAll() {
396         mkwsSetLang();
397         if (mkws_config.show_lang)
398             mkwsHtmlLang();
399
400         log("HTML search form");
401         findnode('.mkwsSearch').html('\
402 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
403   <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws_config.query_width + '" />\
404   <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
405 </form>');
406
407         log("HTML records");
408         // If the team has a .mkwsResults, populate it in the usual
409         // way. If not, assume that it's a smarter application that
410         // defines its own subcomponents, some or all of the
411         // following:
412         //      .mkwsTermlists
413         //      .mkwsRanking
414         //      .mkwsPager
415         //      .mkwsNavi
416         //      .mkwsRecords
417         findnode(".mkwsResults").html('\
418 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
419   <tr>\
420     <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
421       <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
422     </td>\
423     <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
424       <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
425       <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
426       <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
427       <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
428     </td>\
429   </tr>\
430   <tr>\
431     <td colspan="2">\
432       <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
433     </td>\
434   </tr>\
435 </table>');
436
437         var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
438         if (mkws_config.show_sort) {
439             ranking_data +=  M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
440         }
441         if (mkws_config.show_perpage) {
442             ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
443         }
444         ranking_data += '</form>';
445         findnode(".mkwsRanking").html(ranking_data);
446
447         mkwsHtmlSwitch();
448
449         findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
450
451         // on first page, hide the termlist
452         $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
453         var container = findnode(".mkwsMOTDContainer");
454         if (container.length) {
455             // Move the MOTD from the provided element down into the container
456             findnode(".mkwsMOTD").appendTo(container);
457         }
458     }
459
460
461     function mkwsSetLang()  {
462         var lang = getParameterByName("lang") || mkws_config.lang;
463         if (!lang || !mkws.locale_lang[lang]) {
464             mkws_config.lang = ""
465         } else {
466             mkws_config.lang = lang;
467         }
468
469         log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
470         return mkws_config.lang;
471     }
472
473
474     /* create locale language menu */
475     function mkwsHtmlLang() {
476         var lang_default = "en";
477         var lang = mkws_config.lang || lang_default;
478         var list = [];
479
480         /* display a list of configured languages, or all */
481         var lang_options = mkws_config.lang_options || [];
482         var toBeIncluded = {};
483         for (var i = 0; i < lang_options.length; i++) {
484             toBeIncluded[lang_options[i]] = true;
485         }
486
487         for (var k in mkws.locale_lang) {
488             if (toBeIncluded[k] || lang_options.length == 0)
489                 list.push(k);
490         }
491
492         // add english link
493         if (lang_options.length == 0 || toBeIncluded[lang_default])
494             list.push(lang_default);
495
496         log("Language menu for: " + list.join(", "));
497
498         /* the HTML part */
499         var data = "";
500         for(var i = 0; i < list.length; i++) {
501             var l = list[i];
502
503             if (data)
504                 data += ' | ';
505
506             if (lang == l) {
507                 data += ' <span>' + l + '</span> ';
508             } else {
509                 data += ' <a href="?lang=' + l + '">' + l + '</a> '
510             }
511         }
512
513         findnode(".mkwsLang").html(data);
514     }
515
516
517     function mkwsHtmlSort() {
518         log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
519         var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
520
521         for(var i = 0; i < mkws_config.sort_options.length; i++) {
522             var opt = mkws_config.sort_options[i];
523             var key = opt[0];
524             var val = opt.length == 1 ? opt[0] : opt[1];
525
526             sort_html += '<option value="' + key + '"';
527             if (m_sortOrder == key || m_sortOrder == val) {
528                 sort_html += ' selected="selected"';
529             }
530             sort_html += '>' + M(val) + '</option>';
531         }
532         sort_html += '</select>';
533
534         return sort_html;
535     }
536
537
538     function mkwsHtmlPerpage() {
539         log("HTML perpage, m_perpage = " + m_perpage);
540         var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
541
542         for(var i = 0; i < mkws_config.perpage_options.length; i++) {
543             var key = mkws_config.perpage_options[i];
544
545             perpage_html += '<option value="' + key + '"';
546             if (key == m_perpage) {
547                 perpage_html += ' selected="selected"';
548             }
549             perpage_html += '>' + key + '</option>';
550         }
551         perpage_html += '</select>';
552
553         return perpage_html;
554     }
555
556
557     function mkwsHtmlSwitch() {
558         log("HTML switch for team " + m_teamName);
559
560         var node = findnode(".mkwsSwitch");
561         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
562         node.append($("<span/>", { text: " | " }));
563         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
564
565         log("HTML targets");
566         var node = findnode(".mkwsTargets");
567         node.html('\
568 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
569   No information available yet.\
570 </div>');
571         node.css("display", "none");
572     }
573
574
575     that.runAutoSearch = function() {
576         var node = findnode('.mkwsRecords,.mkwsTermlists');
577         var query = node.attr('autosearch');
578         if (!query)
579             return;
580
581         if (query.match(/^!param!/)) {
582             var param = query.replace(/^!param!/, '');
583             query = getParameterByName(param);
584             log("obtained query '" + query + "' from param '" + param + "'");
585             if (!query) {
586                 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
587             }
588         } else if (query.match(/^!path!/)) {
589             var index = query.replace(/^!path!/, '');
590             var path = window.location.pathname.split('/');
591             query = path[path.length - index];
592             log("obtained query '" + query + "' from path-component '" + index + "'");
593             if (!query) {
594                 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
595             }
596         }
597
598         log("node=" + node + ", class='" + node.className + "', query=" + query);
599
600         var sortOrder = node.attr('sort');
601         var targets = node.attr('targets');
602         var s = "running auto search: '" + query + "'";
603         if (sortOrder) s += " sorted by '" + sortOrder + "'";
604         if (targets) s += " in targets '" + targets + "'";
605         log(s);
606
607         newSearch(query, sortOrder, targets);
608     }
609
610
611     // This function is taken from a StackOverflow answer
612     // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
613     function getParameterByName(name) {
614         name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
615         var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
616             results = regex.exec(location.search);
617         return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
618     }
619
620
621     // Translation function. At present, this is properly a
622     // global-level function (hence the assignment to mkws.M) but we
623     // want to make it per-team so different teams can operate in
624     // different languages.
625     //
626     function M(word) {
627         var lang = mkws_config.lang;
628
629         if (!lang || !mkws.locale_lang[lang])
630             return word;
631
632         return mkws.locale_lang[lang][word] || word;
633     }
634     mkws.M = M; // so the Handlebars helper can use it
635
636
637     // Finds the node of the specified class within the current team
638     // Multiple OR-clauses separated by commas are handled
639     // More complex cases may not work
640     //
641     function findnode(selector, teamName) {
642         teamName = teamName || m_teamName;
643
644         selector = $.map(selector.split(','), function(s, i) {
645             return s + '.mkwsTeam_' + teamName;
646         }).join(',');
647
648         return $(selector);
649     }
650
651
652     function renderDetails(data, marker)
653     {
654         var template = loadTemplate("Record");
655         var details = template(data);
656         return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
657     }
658     that.renderDetails = renderDetails;
659
660
661     function loadTemplate(name)
662     {
663         var template = m_template[name];
664
665         if (template === undefined) {
666             // Fall back to generic template if there is no team-specific one
667             var node = findnode(".mkwsTemplate_" + name);
668             if (!node.length) {
669                 node = findnode(".mkwsTemplate_" + name, "ALL");
670             }
671
672             var source = node.html();
673             if (!source) {
674                 source = defaultTemplate(name);
675             }
676
677             template = Handlebars.compile(source);
678             log("compiled template '" + name + "'");
679             m_template[name] = template;
680         }
681
682         return template;
683     }
684     that.loadTemplate = loadTemplate;
685
686
687     function defaultTemplate(name)
688     {
689         if (name === 'Record') {
690             return '\
691 <table>\
692   <tr>\
693     <th>{{translate "Title"}}</th>\
694     <td>\
695       {{md-title}}\
696       {{#if md-title-remainder}}\
697         ({{md-title-remainder}})\
698       {{/if}}\
699       {{#if md-title-responsibility}}\
700         <i>{{md-title-responsibility}}</i>\
701       {{/if}}\
702     </td>\
703   </tr>\
704   {{#if md-date}}\
705   <tr>\
706     <th>{{translate "Date"}}</th>\
707     <td>{{md-date}}</td>\
708   </tr>\
709   {{/if}}\
710   {{#if md-author}}\
711   <tr>\
712     <th>{{translate "Author"}}</th>\
713     <td>{{md-author}}</td>\
714   </tr>\
715   {{/if}}\
716   {{#if md-electronic-url}}\
717   <tr>\
718     <th>{{translate "Links"}}</th>\
719     <td>\
720       {{#each md-electronic-url}}\
721         <a href="{{this}}">Link{{index1}}</a>\
722       {{/each}}\
723     </td>\
724   </tr>\
725   {{/if}}\
726   {{#if-any location having="md-subject"}}\
727   <tr>\
728     <th>{{translate "Subject"}}</th>\
729     <td>\
730       {{#first location having="md-subject"}}\
731         {{#if md-subject}}\
732           {{#commaList md-subject}}\
733             {{this}}{{/commaList}}\
734         {{/if}}\
735       {{/first}}\
736     </td>\
737   </tr>\
738   {{/if-any}}\
739   <tr>\
740     <th>{{translate "Locations"}}</th>\
741     <td>\
742       {{#commaList location}}\
743         {{attr "@name"}}{{/commaList}}\
744     </td>\
745   </tr>\
746 </table>\
747 ';
748         } else if (name === "Summary") {
749             return '\
750 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
751   <b>{{md-title}}</b>\
752 </a>\
753 {{#if md-title-remainder}}\
754   <span>{{md-title-remainder}}</span>\
755 {{/if}}\
756 {{#if md-title-responsibility}}\
757   <span><i>{{md-title-responsibility}}</i></span>\
758 {{/if}}\
759 ';
760         }
761
762         var s = "There is no default '" + name +"' template!";
763         alert(s);
764         return s;
765     }
766
767
768     // The following PubSub code is modified from the jQuery manual:
769     // https://api.jquery.com/jQuery.Callbacks/
770     //
771     // Use as:
772     //  team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
773     //  team.queue("eventName").publish(arg1, arg2, ...);
774
775     var queues = {};
776     var queue = function(id) {
777         if (!queues[id]) {
778             var callbacks = $.Callbacks();
779             queues[id] = {
780                 publish: callbacks.fire,
781                 subscribe: callbacks.add,
782                 unsubscribe: callbacks.remove
783             };
784         }
785         return queues[id];
786     }
787     that.queue = queue;
788
789
790     // main
791     (function() {
792         try {
793             mkwsHtmlAll()
794         }
795
796         catch (e) {
797             mkws_config.error = e.message;
798             // alert(e.message);
799         }
800     })();
801
802     // Bizarrely, 'that' is just an empty hash. All its state is in
803     // the closure variables defined earlier in this function.
804     return that;
805 };