1 // Factory function for team objects. As much as possible, this uses
2 // only member variables (prefixed "m_") and inner functions with
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().
11 // Before the team can be used for searching and related operations,
12 // its pz2 object must be created by calling team.makePz2().
14 mkws.makeTeam = function($, teamName) {
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;
27 // Timestamps for logging
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;
37 var config = mkws.objectInheritingFrom(mkws.config);
40 that.toString = function() { return '[Team ' + teamName + ']'; };
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; };
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 };
60 // The following PubSub code is modified from the jQuery manual:
61 // http://api.jquery.com/jQuery.Callbacks/
64 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
65 // team.queue("eventName").publish(arg1, arg2, ...);
70 var callbacks = $.Callbacks();
72 publish: callbacks.fire,
73 subscribe: callbacks.add,
74 unsubscribe: callbacks.remove
82 function _log(fn, s) {
84 var timestamp = (((now - m_logTime.start)/1000).toFixed(3) + " (+" +
85 ((now - m_logTime.last)/1000).toFixed(3) + ") ");
87 fn.call(mkws.log, m_teamName + ": " + timestamp + s);
88 that.queue("log").publish(m_teamName, timestamp, s);
91 that.log = function (x) { _log(mkws.log, x) };
94 that.log("making new widget team");
96 m_sortOrder = config.sort_default;
97 m_perpage = config.perpage_default;
99 // pz2.js event handlers:
106 function onBytarget(data) {
107 that.log("bytarget");
108 queue("targets").publish(data);
111 function onStat(data) {
112 queue("stat").publish(data);
113 var hitcount = parseInt(data.hits[0], 10);
114 if (!m_gotRecords && hitcount > 0) {
116 queue("firstrecords").publish(hitcount);
118 if (parseInt(data.activeclients[0], 10) === 0) {
119 that.log("complete");
120 queue("complete").publish(hitcount);
124 function onTerm(data) {
126 queue("facets").publish(data);
129 function onShow(data, teamName) {
131 m_totalRecordCount = data.merged;
132 that.log("found " + m_totalRecordCount + " records");
133 queue("pager").publish(data);
134 queue("records").publish(data);
137 function onRecord(data, args, teamName) {
139 // FIXME: record is async!!
140 clearTimeout(m_paz.recordTimer);
141 queue("record").publish(data);
142 var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
143 if (detRecordDiv.length) {
144 // in case on_show was faster to redraw element
147 m_currentRecordData = data;
148 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
149 var html = renderDetails(m_currentRecordData);
150 $(recordDiv).append(html);
154 // create a parameters array and pass it to the pz2's constructor
155 // then register the form submit event with the pz2.search function
156 // autoInit is set to true on default
157 that.makePz2 = function() {
158 that.log("m_queues=" + $.toJSON(m_queues));
160 "windowid": teamName,
161 "pazpar2path": mkws.pazpar2_url(),
162 "usesessions" : config.use_service_proxy ? false : true,
163 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
164 "termlist": config.facets.join(',')
167 params.oninit = onInit;
168 if (m_queues.targets) {
169 params.onbytarget = onBytarget;
170 that.log("setting bytarget callback");
173 params.onstat = onStat;
174 that.log("setting stat callback");
176 if (m_queues.facets && config.facets.length) {
177 params.onterm = onTerm;
178 that.log("setting term callback");
180 if (m_queues.records) {
181 that.log("setting show callback");
182 params.onshow = onShow;
183 // Record callback is subscribed from records callback
184 that.log("setting record callback");
185 params.onrecord = onRecord;
188 m_paz = new pz2(params);
189 that.log("created main pz2 object");
193 // Used by the Records widget and onRecord()
194 function recordElementId(s) {
195 return 'mkws-rec_' + s.replace(/[^a-z0-9]/ig, '_');
197 that.recordElementId = recordElementId;
199 // Used by onRecord(), showDetails() and renderDetails()
200 function recordDetailsId(s) {
201 return 'mkws-det_' + s.replace(/[^a-z0-9]/ig, '_');
205 that.targetFiltered = function(id) {
206 return m_filterSet.targetFiltered(id);
210 that.limitTarget = function(id, name) {
211 that.log("limitTarget(id=" + id + ", name=" + name + ")");
212 m_filterSet.add(targetFilter(id, name));
213 if (m_query) triggerSearch();
218 that.limitQuery = function(field, value) {
219 that.log("limitQuery(field=" + field + ", value=" + value + ")");
220 m_filterSet.add(fieldFilter(field, value));
221 if (m_query) triggerSearch();
226 that.limitCategory = function(id) {
227 that.log("limitCategory(id=" + id + ")");
228 // Only one category filter at a time
229 m_filterSet.removeMatching(function(f) { return f.type === 'category' });
230 if (id !== '') m_filterSet.add(categoryFilter(id));
231 if (m_query) triggerSearch();
236 that.delimitTarget = function(id) {
237 that.log("delimitTarget(id=" + id + ")");
238 m_filterSet.removeMatching(function(f) { return f.type === 'target' });
239 if (m_query) triggerSearch();
244 that.delimitQuery = function(field, value) {
245 that.log("delimitQuery(field=" + field + ", value=" + value + ")");
246 m_filterSet.removeMatching(function(f) { return f.type == 'field' &&
247 field == f.field && value == f.value });
248 if (m_query) triggerSearch();
253 that.showPage = function(pageNum) {
254 m_currentPage = pageNum;
255 m_paz.showPage(m_currentPage - 1);
259 that.pagerNext = function() {
260 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
267 that.pagerPrev = function() {
268 if (m_paz.showPrev() != false)
273 that.reShow = function() {
275 m_paz.show(0, m_perpage, m_sortOrder);
279 function resetPage() {
281 m_totalRecordCount = 0;
282 m_gotRecords = false;
284 that.resetPage = resetPage;
287 function newSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
288 that.log("newSearch: " + query);
290 if (config.use_service_proxy && !mkws.authenticated) {
291 alert("searching before authentication");
295 m_filterSet.removeMatching(function(f) { return f.type !== 'category' });
296 triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery);
297 switchView('records'); // In case it's configured to start off as hidden
300 that.newSearch = newSearch;
303 function triggerSearch(query, sortOrder, maxrecs, perpage, limit, targets, torusquery) {
305 queue("navi").publish();
307 // Continue to use previous query/sort-order unless new ones are specified
308 if (query) m_query = query;
309 if (sortOrder) m_sortOrder = sortOrder;
310 if (perpage) m_perpage = perpage;
311 if (targets) m_filterSet.add(targetFilter(targets, targets));
313 var pp2filter = m_filterSet.pp2filter();
314 var pp2limit = m_filterSet.pp2limit(limit);
315 var pp2catLimit = m_filterSet.pp2catLimit();
317 pp2filter = pp2filter ? pp2filter + "," + pp2catLimit : pp2catLimit;
321 if (pp2limit) params.limit = pp2limit;
322 if (maxrecs) params.maxrecs = maxrecs;
324 if (!mkws.config.use_service_proxy)
325 alert("can't narrow search by torusquery when not authenticated");
326 params.torusquery = torusquery;
329 that.log("triggerSearch(" + m_query + "): filters = " + m_filterSet.toJSON() + ", " +
330 "pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
332 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
335 // fetch record details to be retrieved from the record queue
336 that.fetchDetails = function(recId) {
337 that.log("fetchDetails() requesting record '" + recId + "'");
342 // switching view between targets and records
343 function switchView(view) {
344 var targets = widgetNode('targets');
345 var results = widgetNode('results') || widgetNode('records');
346 var blanket = widgetNode('blanket');
347 var motd = widgetNode('motd');
351 if (targets) $(targets).show();
352 if (results) $(results).hide();
353 if (blanket) $(blanket).hide();
354 if (motd) $(motd).hide();
357 if (targets) $(targets).hide();
358 if (results) $(results).show();
359 if (blanket) $(blanket).show();
360 if (motd) $(motd).hide();
363 alert("Unknown view '" + view + "'");
366 that.switchView = switchView;
369 // detailed record drawing
370 that.showDetails = function(recId) {
371 var oldRecordId = m_currentRecordId;
372 m_currentRecordId = recId;
374 // remove current detailed view if any
375 findnode('#' + recordDetailsId(oldRecordId)).remove();
377 // if the same clicked, just hide
378 if (recId == oldRecordId) {
379 m_currentRecordId = '';
380 m_currentRecordData = null;
383 // request the record
384 that.log("showDetails() requesting record '" + recId + "'");
389 // Finds the node of the specified class within the current team
390 function findnode(selector, teamName) {
391 teamName = teamName || m_teamName;
393 if (teamName === 'AUTO') {
394 selector = (selector + '.mkws-team-' + teamName + ',' +
395 selector + ':not([class^="mkws-team"],[class*=" mkws-team"])');
397 selector = selector + '.mkws-team-' + teamName;
400 var node = $(selector);
401 //that.log('findnode(' + selector + ') found ' + node.length + ' nodes');
406 function widgetNode(type) {
407 var w = that.widget(type);
408 return w ? w.node : undefined;
411 function renderDetails(data, marker) {
412 var template = loadTemplate("details");
413 var details = template(data);
414 return '<div class="mkws-details mkwsDetails mkwsTeam_' + m_teamName + '" ' +
415 'id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
417 that.renderDetails = renderDetails;
420 that.registerTemplate = function(name, text) {
421 if(mkws._old2new.hasOwnProperty(name)) {
422 that.log("Warning: registerTemplate old widget name: " + name + " => " + mkws._old2new[name]);
423 name = mkws._old2new[name];
425 m_templateText[name] = text;
429 function loadTemplate(name, fallbackString) {
430 if(mkws._old2new.hasOwnProperty(name)) {
431 that.log("Warning loadTemplate: old widget name: " + name + " => " + mkws._old2new[name]);
432 name = mkws._old2new[name];
435 var template = m_template[name];
436 if (template === undefined && Handlebars.compile) {
438 var node = $(".mkws-template-" + name + " .mkws-team-" + that.name());
439 if (node && node.length < 1) {
440 node = $(".mkws-template-" + name);
442 if (node) source = node.html();
443 if (!source) source = m_templateText[name];
445 template = Handlebars.compile(source);
446 that.log("compiled template '" + name + "'");
449 //if (template === undefined) template = mkws_templatesbyteam[m_teamName][name];
450 if (template === undefined && Handlebars.templates) {
451 template = Handlebars.templates["mkws-template-" + name];
453 if (template === undefined && mkws.defaultTemplates) {
454 template = mkws.defaultTemplates[name];
457 m_template[name] = template;
461 that.log("No MKWS template for " + name);
465 that.loadTemplate = loadTemplate;
468 that.addWidget = function(w) {
469 if (m_widgets[w.type] === undefined) {
470 m_widgets[w.type] = [ w ];
472 m_widgets[w.type].push(w);
476 that.widget = function(type) {
477 var list = m_widgets[type];
481 if (list.length > 1) {
482 alert("widget('" + type + "') finds " + list.length + " widgets: using first");
487 that.visitWidgets = function(callback) {
488 for (var type in m_widgets) {
489 var list = m_widgets[type];
490 for (var i = 0; i < list.length; i++) {
491 var res = callback(type, list[i]);
492 if (res !== undefined) {