Remove extraneous comment.
[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     function log(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     that.showPage = function (pageNum)
311     {
312         m_currentPage = pageNum;
313         m_paz.showPage(m_currentPage - 1);
314     }
315
316
317     that.pagerNext = function () {
318         if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
319             m_paz.showNext();
320             m_currentPage++;
321         }
322     }
323
324
325     that.pagerPrev = function () {
326         if (m_paz.showPrev() != false)
327             m_currentPage--;
328     }
329
330
331     // switching view between targets and records
332     function switchView(view) {
333         var targets = findnode('.mkwsTargets');
334         var results = findnode('.mkwsResults,.mkwsRecords');
335         var blanket = findnode('.mkwsBlanket');
336         var motd    = findnode('.mkwsMOTD');
337
338         switch(view) {
339         case 'targets':
340             if (targets) targets.css('display', 'block');
341             if (results) results.css('display', 'none');
342             if (blanket) blanket.css('display', 'none');
343             if (motd) motd.css('display', 'none');
344             break;
345         case 'records':
346             if (targets) targets.css('display', 'none');
347             if (results) results.css('display', 'block');
348             if (blanket) blanket.css('display', 'block');
349             if (motd) motd.css('display', 'none');
350             break;
351         case 'none':
352             alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
353             if (targets) targets.css('display', 'none');
354             if (results) results.css('display', 'none');
355             if (blanket) blanket.css('display', 'none');
356             if (motd) motd.css('display', 'none');
357             break;
358         default:
359             alert("Unknown view '" + view + "'");
360         }
361     }
362     that.switchView = switchView;
363
364
365     // detailed record drawing
366     that.showDetails = function (recId) {
367         var oldRecordId = m_currentRecordId;
368         m_currentRecordId = recId;
369
370         // remove current detailed view if any
371         // ##### restrict to current team
372         var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
373         // lovin DOM!
374         if (detRecordDiv)
375             detRecordDiv.parentNode.removeChild(detRecordDiv);
376
377         // if the same clicked, just hide
378         if (recId == oldRecordId) {
379             m_currentRecordId = '';
380             m_currentRecordData = null;
381             return;
382         }
383         // request the record
384         log("showDetails() requesting record '" + recId + "'");
385         m_paz.record(recId);
386     }
387
388
389     /*
390      * All the HTML stuff to render the search forms and
391      * result pages.
392      */
393     function mkwsHtmlAll() {
394         mkwsSetLang();
395         if (mkws_config.show_lang)
396             mkwsHtmlLang();
397
398         log("HTML search form");
399         findnode('.mkwsSearch').html('\
400 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
401   <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws_config.query_width + '" />\
402   <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
403 </form>');
404
405         log("HTML records");
406         // If the team has a .mkwsResults, populate it in the usual
407         // way. If not, assume that it's a smarter application that
408         // defines its own subcomponents, some or all of the
409         // following:
410         //      .mkwsTermlists
411         //      .mkwsRanking
412         //      .mkwsPager
413         //      .mkwsNavi
414         //      .mkwsRecords
415         findnode(".mkwsResults").html('\
416 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
417   <tr>\
418     <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
419       <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
420     </td>\
421     <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
422       <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
423       <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
424       <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
425       <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
426     </td>\
427   </tr>\
428   <tr>\
429     <td colspan="2">\
430       <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
431     </td>\
432   </tr>\
433 </table>');
434
435         var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
436         if (mkws_config.show_sort) {
437             ranking_data +=  M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
438         }
439         if (mkws_config.show_perpage) {
440             ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
441         }
442         ranking_data += '</form>';
443         findnode(".mkwsRanking").html(ranking_data);
444
445         mkwsHtmlSwitch();
446
447         findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
448
449         // on first page, hide the termlist
450         $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
451         var container = findnode(".mkwsMOTDContainer");
452         if (container.length) {
453             // Move the MOTD from the provided element down into the container
454             findnode(".mkwsMOTD").appendTo(container);
455         }
456     }
457
458
459     function mkwsSetLang()  {
460         var lang = getParameterByName("lang") || mkws_config.lang;
461         if (!lang || !mkws.locale_lang[lang]) {
462             mkws_config.lang = ""
463         } else {
464             mkws_config.lang = lang;
465         }
466
467         log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
468         return mkws_config.lang;
469     }
470
471
472     /* create locale language menu */
473     function mkwsHtmlLang() {
474         var lang_default = "en";
475         var lang = mkws_config.lang || lang_default;
476         var list = [];
477
478         /* display a list of configured languages, or all */
479         var lang_options = mkws_config.lang_options || [];
480         var toBeIncluded = {};
481         for (var i = 0; i < lang_options.length; i++) {
482             toBeIncluded[lang_options[i]] = true;
483         }
484
485         for (var k in mkws.locale_lang) {
486             if (toBeIncluded[k] || lang_options.length == 0)
487                 list.push(k);
488         }
489
490         // add english link
491         if (lang_options.length == 0 || toBeIncluded[lang_default])
492             list.push(lang_default);
493
494         log("Language menu for: " + list.join(", "));
495
496         /* the HTML part */
497         var data = "";
498         for(var i = 0; i < list.length; i++) {
499             var l = list[i];
500
501             if (data)
502                 data += ' | ';
503
504             if (lang == l) {
505                 data += ' <span>' + l + '</span> ';
506             } else {
507                 data += ' <a href="?lang=' + l + '">' + l + '</a> '
508             }
509         }
510
511         findnode(".mkwsLang").html(data);
512     }
513
514
515     function mkwsHtmlSort() {
516         log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
517         var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
518
519         for(var i = 0; i < mkws_config.sort_options.length; i++) {
520             var opt = mkws_config.sort_options[i];
521             var key = opt[0];
522             var val = opt.length == 1 ? opt[0] : opt[1];
523
524             sort_html += '<option value="' + key + '"';
525             if (m_sortOrder == key || m_sortOrder == val) {
526                 sort_html += ' selected="selected"';
527             }
528             sort_html += '>' + M(val) + '</option>';
529         }
530         sort_html += '</select>';
531
532         return sort_html;
533     }
534
535
536     function mkwsHtmlPerpage() {
537         log("HTML perpage, m_perpage = " + m_perpage);
538         var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
539
540         for(var i = 0; i < mkws_config.perpage_options.length; i++) {
541             var key = mkws_config.perpage_options[i];
542
543             perpage_html += '<option value="' + key + '"';
544             if (key == m_perpage) {
545                 perpage_html += ' selected="selected"';
546             }
547             perpage_html += '>' + key + '</option>';
548         }
549         perpage_html += '</select>';
550
551         return perpage_html;
552     }
553
554
555     function mkwsHtmlSwitch() {
556         log("HTML switch for team " + m_teamName);
557
558         var node = findnode(".mkwsSwitch");
559         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
560         node.append($("<span/>", { text: " | " }));
561         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
562
563         log("HTML targets");
564         var node = findnode(".mkwsTargets");
565         node.html('\
566 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
567   No information available yet.\
568 </div>');
569         node.css("display", "none");
570     }
571
572
573     that.runAutoSearch = function() {
574         var node = findnode('.mkwsRecords,.mkwsTermlists');
575         var query = node.attr('autosearch');
576         if (!query)
577             return;
578
579         if (query.match(/^!param!/)) {
580             var param = query.replace(/^!param!/, '');
581             query = getParameterByName(param);
582             log("obtained query '" + query + "' from param '" + param + "'");
583             if (!query) {
584                 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
585             }
586         } else if (query.match(/^!path!/)) {
587             var index = query.replace(/^!path!/, '');
588             var path = window.location.pathname.split('/');
589             query = path[path.length - index];
590             log("obtained query '" + query + "' from path-component '" + index + "'");
591             if (!query) {
592                 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
593             }
594         }
595
596         log("node=" + node + ", class='" + node.className + "', query=" + query);
597
598         var sortOrder = node.attr('sort');
599         var targets = node.attr('targets');
600         var s = "running auto search: '" + query + "'";
601         if (sortOrder) s += " sorted by '" + sortOrder + "'";
602         if (targets) s += " in targets '" + targets + "'";
603         log(s);
604
605         newSearch(query, sortOrder, targets);
606     }
607
608
609     // This function is taken from a StackOverflow answer
610     // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
611     function getParameterByName(name) {
612         name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
613         var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
614             results = regex.exec(location.search);
615         return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
616     }
617
618
619     // Translation function. At present, this is properly a
620     // global-level function (hence the assignment to mkws.M) but we
621     // want to make it per-team so different teams can operate in
622     // different languages.
623     //
624     function M(word) {
625         var lang = mkws_config.lang;
626
627         if (!lang || !mkws.locale_lang[lang])
628             return word;
629
630         return mkws.locale_lang[lang][word] || word;
631     }
632     mkws.M = M; // so the Handlebars helper can use it
633
634
635     // Finds the node of the specified class within the current team
636     // Multiple OR-clauses separated by commas are handled
637     // More complex cases may not work
638     //
639     function findnode(selector, teamName) {
640         teamName = teamName || m_teamName;
641
642         selector = $.map(selector.split(','), function(s, i) {
643             return s + '.mkwsTeam_' + teamName;
644         }).join(',');
645
646         return $(selector);
647     }
648
649
650     function renderDetails(data, marker)
651     {
652         var template = loadTemplate("Record");
653         var details = template(data);
654         return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
655     }
656     that.renderDetails = renderDetails;
657
658
659     function loadTemplate(name)
660     {
661         var template = m_template[name];
662
663         if (template === undefined) {
664             // Fall back to generic template if there is no team-specific one
665             var node = findnode(".mkwsTemplate_" + name);
666             if (!node.length) {
667                 node = findnode(".mkwsTemplate_" + name, "ALL");
668             }
669
670             var source = node.html();
671             if (!source) {
672                 source = defaultTemplate(name);
673             }
674
675             template = Handlebars.compile(source);
676             log("compiled template '" + name + "'");
677             m_template[name] = template;
678         }
679
680         return template;
681     }
682     that.loadTemplate = loadTemplate;
683
684
685     function defaultTemplate(name)
686     {
687         if (name === 'Record') {
688             return '\
689 <table>\
690   <tr>\
691     <th>{{translate "Title"}}</th>\
692     <td>\
693       {{md-title}}\
694       {{#if md-title-remainder}}\
695         ({{md-title-remainder}})\
696       {{/if}}\
697       {{#if md-title-responsibility}}\
698         <i>{{md-title-responsibility}}</i>\
699       {{/if}}\
700     </td>\
701   </tr>\
702   {{#if md-date}}\
703   <tr>\
704     <th>{{translate "Date"}}</th>\
705     <td>{{md-date}}</td>\
706   </tr>\
707   {{/if}}\
708   {{#if md-author}}\
709   <tr>\
710     <th>{{translate "Author"}}</th>\
711     <td>{{md-author}}</td>\
712   </tr>\
713   {{/if}}\
714   {{#if md-electronic-url}}\
715   <tr>\
716     <th>{{translate "Links"}}</th>\
717     <td>\
718       {{#each md-electronic-url}}\
719         <a href="{{this}}">Link{{index1}}</a>\
720       {{/each}}\
721     </td>\
722   </tr>\
723   {{/if}}\
724   {{#if-any location having="md-subject"}}\
725   <tr>\
726     <th>{{translate "Subject"}}</th>\
727     <td>\
728       {{#first location having="md-subject"}}\
729         {{#if md-subject}}\
730           {{#commaList md-subject}}\
731             {{this}}{{/commaList}}\
732         {{/if}}\
733       {{/first}}\
734     </td>\
735   </tr>\
736   {{/if-any}}\
737   <tr>\
738     <th>{{translate "Locations"}}</th>\
739     <td>\
740       {{#commaList location}}\
741         {{attr "@name"}}{{/commaList}}\
742     </td>\
743   </tr>\
744 </table>\
745 ';
746         } else if (name === "Summary") {
747             return '\
748 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
749   <b>{{md-title}}</b>\
750 </a>\
751 {{#if md-title-remainder}}\
752   <span>{{md-title-remainder}}</span>\
753 {{/if}}\
754 {{#if md-title-responsibility}}\
755   <span><i>{{md-title-responsibility}}</i></span>\
756 {{/if}}\
757 ';
758         }
759
760         var s = "There is no default '" + name +"' template!";
761         alert(s);
762         return s;
763     }
764
765
766     // The following PubSub code is modified from the jQuery manual:
767     // https://api.jquery.com/jQuery.Callbacks/
768     //
769     // Use as:
770     //  team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
771     //  team.queue("eventName").publish(arg1, arg2, ...);
772
773     var queues = {};
774     var queue = function(id) {
775         if (!queues[id]) {
776             var callbacks = $.Callbacks();
777             queues[id] = {
778                 publish: callbacks.fire,
779                 subscribe: callbacks.add,
780                 unsubscribe: callbacks.remove
781             };
782         }
783         return queues[id];
784     }
785     that.queue = queue;
786
787
788     // main
789     (function() {
790         try {
791             mkwsHtmlAll()
792         }
793
794         catch (e) {
795             mkws_config.error = e.message;
796             // alert(e.message);
797         }
798     })();
799
800     // Bizarrely, 'that' is just an empty hash. All its state is in
801     // the closure variables defined earlier in this function.
802     return that;
803 };