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