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 // limitCategory(), delimitTarget(), delimitQuery(), showPage(),
   9 // pagerPrev(), 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_filterSet = filterSet(that);
  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_tempateText = {}; // widgets can register tempates to be compiled
  30   var m_template = {}; // compiled templates, from any source
  31   var m_config = mkws.objectInheritingFrom(mkws.config);
  32   var m_widgets = {}; // Maps widget-type to array of widget objects
  33
  34   that.toString = function() { return '[Team ' + teamName + ']'; };
  35
  36   // Accessor methods for individual widgets: readers
  37   that.name = function() { return m_teamName; };
  38   that.submitted = function() { return m_submitted; };
  39   that.sortOrder = function() { return m_sortOrder; };
  40   that.perpage = function() { return m_perpage; };
  41   that.totalRecordCount = function() { return m_totalRecordCount; };
  42   that.currentPage = function() { return m_currentPage; };
  43   that.currentRecordId = function() { return m_currentRecordId; };
  44   that.currentRecordData = function() { return m_currentRecordData; };
  45   that.filters = function() { return m_filterSet; };
  46   that.config = function() { return m_config; };
  47
  48   // Accessor methods for individual widgets: writers
  49   that.set_sortOrder = function(val) { m_sortOrder = val };
  50   that.set_perpage = function(val) { m_perpage = val };
  51
  52
  53   // The following PubSub code is modified from the jQuery manual:
  54   // http://api.jquery.com/jQuery.Callbacks/
  55   //
  56   // Use as:
  57   //    team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
  58   //    team.queue("eventName").publish(arg1, arg2, ...);
  59   //
  60   var queues = {};
  61   function queue(id) {
  62     if (!queues[id]) {
  63       var callbacks = $.Callbacks();
  64       queues[id] = {
  65         publish: callbacks.fire,
  66         subscribe: callbacks.add,
  67         unsubscribe: callbacks.remove
  68       };
  69     }
  70     return queues[id];
  71   };
  72   that.queue = queue;
  73
  74
  75   function log(s) {
  76     var now = $.now();
  77     var timestamp = (((now - m_logTime.start)/1000).toFixed(3) + " (+" +
  78                      ((now - m_logTime.last)/1000).toFixed(3) + ") ");
  79     m_logTime.last = now;
  80     mkws.log(m_teamName + ": " + timestamp + s);
  81     that.queue("log").publish(m_teamName, timestamp, s);
  82   }
  83   that.log = log;
  84
  85
  86   log("start running MKWS");
  87
  88   m_sortOrder = m_config.sort_default;
  89   m_perpage = m_config.perpage_default;
  90
  91   log("Create main pz2 object");
  92   // create a parameters array and pass it to the pz2's constructor
  93   // then register the form submit event with the pz2.search function
  94   // autoInit is set to true on default
  95   m_paz = new pz2({ "windowid": teamName,
  96                     "pazpar2path": m_config.pazpar2_url,
  97                     "usesessions" : m_config.use_service_proxy ? false : true,
  98                     "oninit": onInit,
  99                     "onbytarget": onBytarget,
 100                     "onstat": onStat,
 101                     "onterm": (m_config.facets.length ? onTerm : undefined),
 102                     "onshow": onShow,
 103                     "onrecord": onRecord,
 104                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
 105                     "termlist": m_config.facets.join(',')
 106                   });
 107
 108   // pz2.js event handlers:
 109   function onInit() {
 110     log("init");
 111     m_paz.stat();
 112     m_paz.bytarget();
 113   }
 114
 115   function onBytarget(data) {
 116     log("target");
 117     queue("targets").publish(data);
 118   }
 119
 120   function onStat(data) {
 121     queue("stat").publish(data);
 122     if (parseInt(data.activeclients[0], 10) === 0)
 123       queue("complete").publish(parseInt(data.hits[0], 10));
 124   }
 125
 126   function onTerm(data) {
 127     log("term");
 128     queue("termlists").publish(data);
 129   }
 130
 131   function onShow(data, teamName) {
 132     log("show");
 133     m_totalRecordCount = data.merged;
 134     log("found " + m_totalRecordCount + " records");
 135     queue("pager").publish(data);
 136     queue("records").publish(data);
 137   }
 138
 139   function onRecord(data, args, teamName) {
 140     log("record");
 141     // FIXME: record is async!!
 142     clearTimeout(m_paz.recordTimer);
 143     var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
 144     if (detRecordDiv.length) {
 145       // in case on_show was faster to redraw element
 146       return;
 147     }
 148     m_currentRecordData = data;
 149     var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
 150     var html = renderDetails(m_currentRecordData);
 151     $(recordDiv).append(html);
 152   }
 153
 154
 155   // Used by the Records widget and onRecord()
 156   function recordElementId(s) {
 157     return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
 158   }
 159   that.recordElementId = recordElementId;
 160
 161   // Used by onRecord(), showDetails() and renderDetails()
 162   function recordDetailsId(s) {
 163     return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
 164   }
 165
 166
 167   that.targetFiltered = function(id) {
 168     return m_filterSet.targetFiltered(id);
 169   };
 170
 171
 172   that.limitTarget = function(id, name) {
 173     log("limitTarget(id=" + id + ", name=" + name + ")");
 174     m_filterSet.add(targetFilter(id, name));
 175     if (m_query) triggerSearch();
 176     return false;
 177   };
 178
 179
 180   that.limitQuery = function(field, value) {
 181     log("limitQuery(field=" + field + ", value=" + value + ")");
 182     m_filterSet.add(fieldFilter(field, value));
 183     if (m_query) triggerSearch();
 184     return false;
 185   };
 186
 187
 188   that.limitCategory = function(id) {
 189     log("limitCategory(id=" + id + ")");
 190     // Only one category filter at a time
 191     m_filterSet.removeMatching(function(f) { return f.type === 'category' });
 192     if (id !== '') m_filterSet.add(categoryFilter(id));
 193     if (m_query) triggerSearch();
 194     return false;
 195   };
 196
 197
 198   that.delimitTarget = function(id) {
 199     log("delimitTarget(id=" + id + ")");
 200     m_filterSet.removeMatching(function(f) { return f.type === 'target' });
 201     if (m_query) triggerSearch();
 202     return false;
 203   };
 204
 205
 206   that.delimitQuery = function(field, value) {
 207     log("delimitQuery(field=" + field + ", value=" + value + ")");
 208     m_filterSet.removeMatching(function(f) { return f.type == 'field' &&
 209                                              field == f.field && value == f.value });
 210     if (m_query) triggerSearch();
 211     return false;
 212   };
 213
 214
 215   that.showPage = function(pageNum) {
 216     m_currentPage = pageNum;
 217     m_paz.showPage(m_currentPage - 1);
 218   };
 219
 220
 221   that.pagerNext = function() {
 222     if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
 223       m_paz.showNext();
 224       m_currentPage++;
 225     }
 226   };
 227
 228
 229   that.pagerPrev = function() {
 230     if (m_paz.showPrev() != false)
 231       m_currentPage--;
 232   };
 233
 234
 235   that.reShow = function() {
 236     resetPage();
 237     m_paz.show(0, m_perpage, m_sortOrder);
 238   };
 239
 240
 241   function resetPage() {
 242     m_currentPage = 1;
 243     m_totalRecordCount = 0;
 244   }
 245   that.resetPage = resetPage;
 246
 247
 248   function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
 249     log("newSearch: " + query);
 250
 251     if (m_config.use_service_proxy && !mkws.authenticated) {
 252       alert("searching before authentication");
 253       return;
 254     }
 255
 256     m_filterSet.removeMatching(function(f) { return f.type !== 'category' });
 257     triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery);
 258     switchView('records'); // In case it's configured to start off as hidden
 259     m_submitted = true;
 260   }
 261   that.newSearch = newSearch;
 262
 263
 264   function triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
 265     resetPage();
 266     queue("navi").publish();
 267
 268     // Continue to use previous query/sort-order unless new ones are specified
 269     if (query) m_query = query;
 270     if (sortOrder) m_sortOrder = sortOrder;
 271     if (perpage) m_perpage = perpage;
 272     if (targets) m_filterSet.add(targetFilter(targets, targets));
 273
 274     var pp2filter = m_filterSet.pp2filter();
 275     var pp2limit = m_filterSet.pp2limit(limit);
 276     var pp2catLimit = m_filterSet.pp2catLimit();
 277     if (pp2catLimit) {
 278       pp2filter = pp2filter ? pp2filter + "," + pp2catLimit : pp2catLimit;
 279     }
 280
 281     var params = {};
 282     if (pp2limit) params.limit = pp2limit;
 283     if (maxrecs) params.maxrecs = maxrecs;
 284     if (torusquery) {
 285       if (!mkws.config.use_service_proxy)
 286         alert("can't narrow search by torusquery when Service Proxy is not in use");
 287       params.torusquery = torusquery;
 288     }
 289
 290     log("triggerSearch(" + m_query + "): filters = " + m_filterSet.toJSON() + ", " +
 291         "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
 292
 293     m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
 294   }
 295
 296
 297   // switching view between targets and records
 298   function switchView(view) {
 299     var targets = widgetNode('Targets');
 300     var results = widgetNode('Results') || widgetNode('Records');
 301     var blanket = widgetNode('Blanket');
 302     var motd    = widgetNode('MOTD');
 303
 304     switch(view) {
 305     case 'targets':
 306       if (targets) $(targets).show();
 307       if (results) $(results).hide();
 308       if (blanket) $(blanket).hide();
 309       if (motd) $(motd).hide();
 310       break;
 311     case 'records':
 312       if (targets) $(targets).hide();
 313       if (results) $(results).show();
 314       if (blanket) $(blanket).show();
 315       if (motd) $(motd).hide();
 316       break;
 317     default:
 318       alert("Unknown view '" + view + "'");
 319     }
 320   }
 321   that.switchView = switchView;
 322
 323
 324   // detailed record drawing
 325   that.showDetails = function(recId) {
 326     var oldRecordId = m_currentRecordId;
 327     m_currentRecordId = recId;
 328
 329     // remove current detailed view if any
 330     findnode('#' + recordDetailsId(oldRecordId)).remove();
 331
 332     // if the same clicked, just hide
 333     if (recId == oldRecordId) {
 334       m_currentRecordId = '';
 335       m_currentRecordData = null;
 336       return;
 337     }
 338     // request the record
 339     log("showDetails() requesting record '" + recId + "'");
 340     m_paz.record(recId);
 341   };
 342
 343
 344   // Finds the node of the specified class within the current team
 345   function findnode(selector, teamName) {
 346     teamName = teamName || m_teamName;
 347
 348     if (teamName === 'AUTO') {
 349       selector = (selector + '.mkwsTeam_' + teamName + ',' +
 350                   selector + ':not([class^="mkwsTeam"],[class*=" mkwsTeam"])');
 351     } else {
 352       selector = selector + '.mkwsTeam_' + teamName;
 353     }
 354
 355     var node = $(selector);
 356     //log('findnode(' + selector + ') found ' + node.length + ' nodes');
 357     return node;
 358   }
 359
 360
 361   function widgetNode(type) {
 362     var w = that.widget(type);
 363     return w ? $(w.node) : undefined;
 364   }
 365
 366   function renderDetails(data, marker) {
 367     var template = loadTemplate("Record");
 368     var details = template(data);
 369     return '<div class="details mkwsTeam_' + m_teamName + '" ' +
 370       'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
 371   }
 372   that.renderDetails = renderDetails;
 373
 374
 375   that.registerTemplate = function(name, text) {
 376     m_tempateText[name] = text;
 377   };
 378
 379
 380   function loadTemplate(name) {
 381     var template = m_template[name];
 382
 383     if (template === undefined) {
 384       // Fall back to generic template if there is no team-specific one
 385       var source;
 386       var node = widgetNode("Template_" + name);
 387       if (!node) {
 388         node = widgetNode("Template_" + name, "ALL");
 389       }
 390       if (node) {
 391         source = node.html();
 392       }
 393
 394       if (!source) {
 395         source = m_tempateText[name];
 396       }
 397       if (!source) {
 398         source = mkws.defaultTemplate(name);
 399       }
 400
 401       template = Handlebars.compile(source);
 402       log("compiled template '" + name + "'");
 403       m_template[name] = template;
 404     }
 405
 406     return template;
 407   }
 408   that.loadTemplate = loadTemplate;
 409
 410
 411   that.addWidget = function(w) {
 412     if (m_widgets[w.type] === undefined) {
 413       m_widgets[w.type] = [ w ];
 414       log("Added '" + w.type + "' widget to team '" + m_teamName + "'");
 415     } else {
 416       m_widgets[w.type].push(w);
 417       log("Added '" + w.type + "' widget #" + m_widgets[w.type].length + "' to team '" + m_teamName + "'");
 418     }
 419   }
 420
 421   that.widget = function(type) {
 422     var list = m_widgets[type];
 423
 424     if (!list)
 425       return undefined;
 426     if (list.length > 1) {
 427       alert("widget('" + type + "') finds " + list.length + " widgets: using first");
 428     }
 429     return list[0];
 430   }
 431
 432   that.visitWidgets = function(callback) {
 433     for (var type in m_widgets) {
 434       var list = m_widgets[type];
 435       for (var i = 0; i < list.length; i++) {
 436         var res = callback(type, list[i]);
 437         if (res !== undefined) {
 438           return res;
 439         }
 440       }
 441     }
 442     return undefined;
 443   }
 444
 445
 446   return that;
 447 };