src/mkws-team.js

   1 "use strict";
   2 // Factory function for team objects. As much as possible, this uses
   3 // only member variables (prefixed "m_") and inner functions with
   4 // private scope.
   5 //
   6 // Some functions are visible as member-functions to be called from
   7 // outside code -- specifically, from generated HTML. These functions
   8 // are that.switchView(), showDetails(), limitTarget(), limitQuery(),
   9 // limitCategory(), delimitTarget(), delimitQuery(), showPage(),
  10 // pagerPrev(), pagerNext().
  11 //
  12 // Before the team can be used for searching and related operations,
  13 // its pz2 object must be created by calling team.makePz2().
  14 //
  15 mkws.makeTeam = function($, teamName) {
  16   var that = {};
  17
  18   // Member variables are separated into two categories
  19
  20   // 1. Persistent state (to be coded in URL fragment)
  21   var m_state = {
  22     query: null,                // initially undefined
  23     sort: null,                 // will be set below
  24     size: null,                 // will be set below
  25     page: 1,
  26     recid: '',
  27     filters: filterSet(that)
  28   }
  29
  30   // 2. Internal state (not to be coded)
  31   var m_teamName = teamName;
  32   var m_paz; // will be initialised below
  33   var m_submitted = false;
  34   var m_totalRecordCount = 0;
  35   var m_currentRecordData = null;
  36   var m_logTime = {
  37     // Timestamps for logging
  38     "start": $.now(),
  39     "last": $.now()
  40   };
  41   var m_templateText = {}; // widgets can register templates to be compiled
  42   var m_template = {}; // compiled templates, from any source
  43   var m_widgets = {}; // Maps widget-type to array of widget objects
  44   var m_gotRecords = false;
  45
  46   var config = mkws.objectInheritingFrom(mkws.config);
  47   that.config = config;
  48
  49   that.toString = function() { return '[Team ' + teamName + ']'; };
  50
  51   // Accessor methods for individual widgets: readers
  52   that.name = function() { return m_teamName; };
  53   that.submitted = function() { return m_submitted; };
  54   that.sortOrder = function() { return m_state.sort; };
  55   that.perpage = function() { return m_state.size; };
  56   that.query = function() { return m_state.query; };
  57   that.totalRecordCount = function() { return m_totalRecordCount; };
  58   that.currentPage = function() { return m_state.page; };
  59   that.currentRecordId = function() { return m_state.recid; };
  60   that.currentRecordData = function() { return m_currentRecordData; };
  61   that.filters = function() { return m_state.filters; };
  62   that.gotRecords = function() { return m_gotRecords; };
  63
  64   // Accessor methods for individual widgets: writers
  65   that.set_sortOrder = function(val) { m_state.sort = val };
  66   that.set_perpage = function(val) { m_state.size = val };
  67
  68   m_state.sort = config.sort_default;
  69   m_state.size = config.perpage_default;
  70
  71   var m_default = $.extend(true, {}, m_state);
  72   var tmp = m_default.filters;
  73   delete m_default.filters;
  74   $.extend(m_default, tmp.fragmentItems());
  75
  76   that.urlFragment = function () {
  77     var s;
  78
  79     // Expand the filterSet into a set of key=value properties
  80     var state = $.extend(true, {}, m_state);
  81     var tmp = state.filters;
  82     delete state.filters;
  83     $.extend(state, tmp.fragmentItems());
  84
  85     for (var key in state) {
  86       if (state.hasOwnProperty(key) &&
  87           state[key] != m_default[key]) {
  88         if (!s) {
  89           var s = 'mkws';
  90           if (m_teamName !== 'AUTO') s += m_teamName;
  91           s += '=';
  92         } else {
  93           s += "@";
  94         }
  95
  96         // ### how do we need to quote this?
  97         s += key + '=' + state[key];
  98       }
  99     }
 100
 101     return s;
 102   }
 103
 104
 105   // The following PubSub code is modified from the jQuery manual:
 106   // http://api.jquery.com/jQuery.Callbacks/
 107   //
 108   // Use as:
 109   //    team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
 110   //    team.queue("eventName").publish(arg1, arg2, ...);
 111   //
 112   var m_queues = {};
 113   function queue(id) {
 114     if (!m_queues[id]) {
 115       var callbacks = $.Callbacks();
 116       m_queues[id] = {
 117         publish: callbacks.fire,
 118         subscribe: callbacks.add,
 119         unsubscribe: callbacks.remove
 120       };
 121     }
 122     return m_queues[id];
 123   };
 124   that.queue = queue;
 125
 126
 127   function _log(fn, s) {
 128     var now = $.now();
 129     var timestamp = (((now - m_logTime.start)/1000).toFixed(3) + " (+" +
 130                      ((now - m_logTime.last)/1000).toFixed(3) + ") ");
 131     m_logTime.last = now;
 132     fn.call(mkws.log, m_teamName + ": " + timestamp + s);
 133     that.queue("log").publish(m_teamName, timestamp, s);
 134   }
 135
 136   that.trace = function(x) { _log(mkws.trace, x) };
 137   that.debug = function(x) { _log(mkws.debug, x) };
 138   that.info = function(x) { _log(mkws.info, x) };
 139   that.warn = function(x) { _log(mkws.warn, x) };
 140   that.error = function(x) { _log(mkws.error, x) };
 141   that.fatal = function(x) { _log(mkws.fatal, x) };
 142
 143   that.info("making new widget team");
 144
 145   // pz2.js event handlers:
 146   function onInit() {
 147     that.info("init");
 148     m_paz.stat();
 149     m_paz.bytarget();
 150   }
 151
 152   function onBytarget(data) {
 153     that.info("bytarget");
 154     queue("targets").publish(data);
 155   }
 156
 157   function onStat(data) {
 158     queue("stat").publish(data);
 159     var hitcount = parseInt(data.hits[0], 10);
 160     if (!m_gotRecords && hitcount > 0) {
 161       m_gotRecords = true;
 162       queue("firstrecords").publish(hitcount);
 163     }
 164     if (parseInt(data.activeclients[0], 10) === 0) {
 165       that.info("complete");
 166       queue("complete").publish(hitcount);
 167     }
 168   }
 169
 170   function onTerm(data) {
 171     that.info("term");
 172     queue("facets").publish(data);
 173   }
 174
 175   function onShow(data, teamName) {
 176     that.info("show");
 177     m_totalRecordCount = data.merged;
 178     that.info("found " + m_totalRecordCount + " records");
 179     queue("pager").publish(data);
 180     queue("records").publish(data);
 181   }
 182
 183   function onRecord(data, args, teamName) {
 184     that.info("record");
 185     // FIXME: record is async!!
 186     clearTimeout(m_paz.recordTimer);
 187     queue("record").publish(data);
 188     var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
 189     if (detRecordDiv.length) {
 190       // in case on_show was faster to redraw element
 191       return;
 192     }
 193     m_currentRecordData = data;
 194     var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
 195     var html = renderDetails(m_currentRecordData);
 196     $(recordDiv).append(html);
 197   }
 198
 199
 200   // create a parameters array and pass it to the pz2's constructor
 201   // then register the form submit event with the pz2.search function
 202   // autoInit is set to true on default
 203   that.makePz2 = function() {
 204     that.debug("m_queues=" + $.toJSON(m_queues));
 205     var params = {
 206       "windowid": teamName,
 207       "pazpar2path": mkws.pazpar2_url(),
 208       "usesessions" : config.use_service_proxy ? false : true,
 209       "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
 210       "termlist": config.facets.join(',')
 211     };
 212
 213     params.oninit = onInit;
 214     if (m_queues.targets) {
 215       params.onbytarget = onBytarget;
 216       that.info("setting bytarget callback");
 217     }
 218     if (m_queues.stat || m_queues.firstrecords || m_queues.complete) {
 219       params.onstat = onStat;
 220       that.info("setting stat callback");
 221     }
 222     if (m_queues.facets && config.facets.length) {
 223       params.onterm = onTerm;
 224       that.info("setting term callback");
 225     }
 226     if (m_queues.records) {
 227       that.info("setting show callback");
 228       params.onshow = onShow;
 229       // Record callback is subscribed from records callback
 230       that.info("setting record callback");
 231       params.onrecord = onRecord;
 232     }
 233
 234     m_paz = new pz2(params);
 235     that.info("created main pz2 object");
 236   }
 237
 238
 239   // Used by the Records widget and onRecord()
 240   function recordElementId(s) {
 241     return 'mkws-rec_' + s.replace(/[^a-z0-9]/ig, '_');
 242   }
 243   that.recordElementId = recordElementId;
 244
 245   // Used by onRecord(), showDetails() and renderDetails()
 246   function recordDetailsId(s) {
 247     return 'mkws-det_' + s.replace(/[^a-z0-9]/ig, '_');
 248   }
 249
 250
 251   that.targetFiltered = function(id) {
 252     return m_state.filters.targetFiltered(id);
 253   };
 254
 255
 256   that.limitTarget = function(id, name) {
 257     that.info("limitTarget(id=" + id + ", name=" + name + ")");
 258     m_state.filters.add(targetFilter(id, name));
 259     if (m_state.query) triggerSearch();
 260     return false;
 261   };
 262
 263
 264   that.limitQuery = function(field, value) {
 265     that.info("limitQuery(field=" + field + ", value=" + value + ")");
 266     m_state.filters.add(fieldFilter(field, value));
 267     if (m_state.query) triggerSearch();
 268     return false;
 269   };
 270
 271
 272   that.limitCategory = function(id) {
 273     that.info("limitCategory(id=" + id + ")");
 274     // Only one category filter at a time
 275     m_state.filters.removeMatching(function(f) { return f.type === 'category' });
 276     if (id !== '') m_state.filters.add(categoryFilter(id));
 277     if (m_state.query) triggerSearch();
 278     return false;
 279   };
 280
 281
 282   that.delimitTarget = function(id) {
 283     that.info("delimitTarget(id=" + id + ")");
 284     m_state.filters.removeMatching(function(f) { return f.type === 'target' });
 285     if (m_state.query) triggerSearch();
 286     return false;
 287   };
 288
 289
 290   that.delimitQuery = function(field, value) {
 291     that.info("delimitQuery(field=" + field + ", value=" + value + ")");
 292     m_state.filters.removeMatching(function(f) { return f.type == 'field' &&
 293                                              field == f.field && value == f.value });
 294     if (m_state.query) triggerSearch();
 295     return false;
 296   };
 297
 298
 299   that.showPage = function(pageNum) {
 300     m_state.page = pageNum;
 301     m_paz.showPage(m_state.page - 1);
 302   };
 303
 304
 305   that.pagerNext = function() {
 306     if (m_totalRecordCount - m_state.size * m_state.page > 0) {
 307       m_paz.showNext();
 308       m_state.page++;
 309     }
 310   };
 311
 312
 313   that.pagerPrev = function() {
 314     if (m_paz.showPrev() != false)
 315       m_state.page--;
 316   };
 317
 318
 319   that.reShow = function() {
 320     resetPage();
 321     m_paz.show(0, m_state.size, m_state.sort);
 322     // ### not really the right place for this but it will do for now.
 323     that.warn("fragment: " + that.urlFragment());
 324   };
 325
 326
 327   function resetPage() {
 328     m_state.page = 1;
 329     m_totalRecordCount = 0;
 330     m_gotRecords = false;
 331   }
 332   that.resetPage = resetPage;
 333
 334
 335   function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
 336     that.info("newSearch: " + query);
 337
 338     if (config.use_service_proxy && !mkws.authenticated) {
 339       alert("searching before authentication");
 340       return;
 341     }
 342
 343     m_state.filters.removeMatching(function(f) { return f.type !== 'category' });
 344     triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery);
 345     switchView('records'); // In case it's configured to start off as hidden
 346     m_submitted = true;
 347   }
 348   that.newSearch = newSearch;
 349
 350
 351   function triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
 352     resetPage();
 353
 354     // Continue to use previous query/sort-order unless new ones are specified
 355     if (query) m_state.query = query;
 356     if (sortOrder) m_state.sort = sortOrder;
 357     if (perpage) m_state.size = perpage;
 358     if (targets) m_state.filters.add(targetFilter(targets, targets));
 359
 360     var pp2filter = m_state.filters.pp2filter();
 361     var pp2limit = m_state.filters.pp2limit(limit);
 362     var pp2catLimit = m_state.filters.pp2catLimit();
 363     if (pp2catLimit) {
 364       pp2filter = pp2filter ? pp2filter + "," + pp2catLimit : pp2catLimit;
 365     }
 366
 367     var params = {};
 368     if (pp2limit) params.limit = pp2limit;
 369     if (maxrecs) params.maxrecs = maxrecs;
 370     if (torusquery) {
 371       if (!mkws.config.use_service_proxy)
 372         alert("can't narrow search by torusquery when not authenticated");
 373       params.torusquery = torusquery;
 374     }
 375
 376     that.info("triggerSearch(" + m_state.query + "): filters = " + m_state.filters.toJSON() + ", " +
 377         "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
 378
 379     m_paz.search(m_state.query, m_state.size, m_state.sort, pp2filter, undefined, params);
 380     queue("searchtriggered").publish();
 381
 382     // ### not really the right place for this but it will do for now.
 383     that.warn("fragment: " + that.urlFragment());
 384   }
 385
 386   // fetch record details to be retrieved from the record queue
 387   that.fetchDetails = function(recId) {
 388     that.info("fetchDetails() requesting record '" + recId + "'");
 389     m_paz.record(recId);
 390   };
 391
 392
 393   // switching view between targets and records
 394   function switchView(view) {
 395     var targets = widgetNode('targets');
 396     var results = widgetNode('results') || widgetNode('records');
 397     var blanket = widgetNode('blanket');
 398     var motd    = widgetNode('motd');
 399
 400     switch(view) {
 401     case 'targets':
 402       if (targets) $(targets).show();
 403       if (results) $(results).hide();
 404       if (blanket) $(blanket).hide();
 405       if (motd) $(motd).hide();
 406       break;
 407     case 'records':
 408       if (targets) $(targets).hide();
 409       if (results) $(results).show();
 410       if (blanket) $(blanket).show();
 411       if (motd) $(motd).hide();
 412       break;
 413     default:
 414       alert("Unknown view '" + view + "'");
 415     }
 416   }
 417   that.switchView = switchView;
 418
 419
 420   // detailed record drawing
 421   that.showDetails = function(recId) {
 422     var oldRecordId = m_state.recid;
 423     m_state.recid = recId;
 424
 425     // remove current detailed view if any
 426     findnode('#' + recordDetailsId(oldRecordId)).remove();
 427
 428     // if the same clicked, just hide
 429     if (recId == oldRecordId) {
 430       m_state.recid = '';
 431       m_currentRecordData = null;
 432       return;
 433     }
 434     // request the record
 435     that.info("showDetails() requesting record '" + recId + "'");
 436     m_paz.record(recId);
 437   };
 438
 439
 440   // Finds the node of the specified class within the current team
 441   function findnode(selector, teamName) {
 442     teamName = teamName || m_teamName;
 443
 444     if (teamName === 'AUTO') {
 445       selector = (selector + '.mkws-team-' + teamName + ',' +
 446                   selector + ':not([class^="mkws-team"],[class*=" mkws-team"])');
 447     } else {
 448       selector = selector + '.mkws-team-' + teamName;
 449     }
 450
 451     var node = $(selector);
 452     //that.debug('findnode(' + selector + ') found ' + node.length + ' nodes');
 453     return node;
 454   }
 455
 456
 457   function widgetNode(type) {
 458     var w = that.widget(type);
 459     return w ? w.node : undefined;
 460   }
 461
 462   function renderDetails(data, marker) {
 463     var template = loadTemplate("details");
 464     var details = template(data);
 465     return '<div class="mkws-details mkwsDetails mkwsTeam_' + m_teamName + '" ' +
 466       'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
 467   }
 468   that.renderDetails = renderDetails;
 469
 470
 471   that.registerTemplate = function(name, text) {
 472     if(mkws._old2new.hasOwnProperty(name)) {
 473       that.warn("registerTemplate: old widget name: " + name + " => " + mkws._old2new[name]);
 474       name = mkws._old2new[name];
 475     }
 476     m_templateText[name] = text;
 477   };
 478
 479
 480   function loadTemplate(name, fallbackString) {
 481     if(mkws._old2new.hasOwnProperty(name)) {
 482        that.warn("loadTemplate: old widget name: " + name + " => " + mkws._old2new[name]);
 483        name = mkws._old2new[name];
 484     }
 485
 486     var template = m_template[name];
 487     if (template === undefined && Handlebars.compile) {
 488       var source;
 489       var node = $(".mkws-template-" + name + " .mkws-team-" + that.name());
 490       if (node && node.length < 1) {
 491         node = $(".mkws-template-" + name);
 492       }
 493       if (node) source = node.html();
 494       if (!source) source = m_templateText[name];
 495       if (source) {
 496         template = Handlebars.compile(source);
 497         that.info("compiled template '" + name + "'");
 498       }
 499     }
 500     //if (template === undefined) template = mkws_templatesbyteam[m_teamName][name];
 501     if (template === undefined && Handlebars.templates) {
 502       template = Handlebars.templates["mkws-template-" + name];
 503     }
 504     if (template === undefined && mkws.defaultTemplates) {
 505       template = mkws.defaultTemplates[name];
 506     }
 507     if (template) {
 508       m_template[name] = template;
 509       return template;
 510     }
 511     else {
 512       that.info("No MKWS template for " + name);
 513       return null;
 514     }
 515   }
 516   that.loadTemplate = loadTemplate;
 517
 518
 519   that.addWidget = function(w) {
 520     if (m_widgets[w.type] === undefined) {
 521       m_widgets[w.type] = [ w ];
 522     } else {
 523       m_widgets[w.type].push(w);
 524     }
 525   }
 526
 527   that.widget = function(type) {
 528     var list = m_widgets[type];
 529
 530     if (!list)
 531       return undefined;
 532     if (list.length > 1) {
 533       alert("widget('" + type + "') finds " + list.length + " widgets: using first");
 534     }
 535     return list[0];
 536   }
 537
 538   that.visitWidgets = function(callback) {
 539     for (var type in m_widgets) {
 540       var list = m_widgets[type];
 541       for (var i = 0; i < list.length; i++) {
 542         var res = callback(type, list[i]);
 543         if (res !== undefined) {
 544           return res;
 545         }
 546       }
 547     }
 548     return undefined;
 549   };
 550
 551   return that;
 552 };