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