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