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