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