"use strict"; // HTML5: disable for debug_level >= 2
+
+// Handlebars helpers
+Handlebars.registerHelper('json', function(obj) {
+ return $.toJSON(obj);
+});
+
+
+Handlebars.registerHelper('translate', function(s) {
+ debug("translating '" + s + "'");
+ return mkws.M(s);
+});
+
+
+// We need {{attr '@name'}} because Handlebars can't parse {{@name}}
+Handlebars.registerHelper('attr', function(attrName) {
+ return this[attrName];
+});
+
+
+/*
+ * Use as follows: {{#if-any NAME1 having="NAME2"}}
+ * Applicable when NAME1 is the name of an array
+ * The guarded code runs only if at least one element of the NAME1
+ * array has a subelement called NAME2.
+ */
+Handlebars.registerHelper('if-any', function(items, options) {
+ var having = options.hash.having;
+ for (var i in items) {
+ var item = items[i]
+ if (!having || item[having]) {
+ return options.fn(this);
+ }
+ }
+ return "";
+});
+
+
+Handlebars.registerHelper('first', function(items, options) {
+ var having = options.hash.having;
+ for (var i in items) {
+ var item = items[i]
+ if (!having || item[having]) {
+ return options.fn(item);
+ }
+ }
+ return "";
+});
+
+
+Handlebars.registerHelper('commaList', function(items, options) {
+ var out = "";
+
+ for (var i in items) {
+ if (i > 0) out += ", ";
+ out += options.fn(items[i])
+ }
+
+ return out;
+});
+
+
+
// Some functions are visible to be called from outside code, namely
// generated HTML: mkws.switchView(), showDetails(), limitTarget(),
// limitQuery(), delimitTarget(), delimitQuery(), pagerPrev(),
-// pagerNext(), showPage()
+// pagerNext(), showPage(). Also mkws.M() is made available for the
+// Handlebars helper 'translate'
+
-// Set up global mkws object. Contains a hash of session objects,
+// Set up global mkws object. Contains a hash of team objects,
// indexed by windowid.
var mkws = {
authenticated: false,
- init: false,
debug_function: undefined, // will be set during initialisation
debug_level: undefined, // will be initialised from mkws_config
- sessions: {},
+ paz: undefined, // will be set up during initialisation
+ teams: {},
locale_lang: {
"de": {
"Authors": "Autoren",
}
};
+
// Define empty mkws_config for simple applications that don't define it.
if (mkws_config == null || typeof mkws_config != 'object') {
var mkws_config = {};
}
+
// wrapper for jQuery lib
function _make_mkws_team($, teamName) {
- if (console && console.log)
- console.log("run _make_mkws_team(" + (teamName ? teamName : "") + ")");
-
- // call this function only once
- if (mkws.init) {
- alert("_make_mkws_team() called twice: how did that happen?!");
- return;
- }
-
+ var that = {};
+ var m_termName = teamName;
+ var m_submitted = false;
+ var m_query; // initially undefined
var m_sort = 'relevance';
var m_filters = [];
-
- // keep time state for debugging
+ var m_totalRec = 0;
+ var m_recPerPage = 20;
+ var m_curPage = 1;
+ var m_curDetRecId = '';
+ var m_curDetRecData = null;
var m_debug_time = {
+ // Timestamps for logging
"start": $.now(),
"last": $.now()
};
+
+ // if (console && console.log) // disabled, will fail in IE8
+ // console.log("run _make_mkws_team(" + (teamName ? teamName : "") + ")");
+
+
+ // Needs to be defined inside _make_mkws_team() so it can see m_debug_time
mkws.debug_function = function (string) {
if (!mkws.debug_level)
return;
debug("start running MKWS");
- Handlebars.registerHelper('json', function(obj) {
- return $.toJSON(obj);
- });
-
-
- Handlebars.registerHelper('translate', function(s) {
- debug("translating '" + s + "'");
- return M(s);
- });
-
-
- // We need {{attr '@name'}} because Handlebars can't parse {{@name}}
- Handlebars.registerHelper('attr', function(attrName) {
- return this[attrName];
- });
-
-
- /*
- * Use as follows: {{#if-any NAME1 having="NAME2"}}
- * Applicable when NAME1 is the name of an array
- * The guarded code runs only if at least one element of the NAME1
- * array has a subelement called NAME2.
- */
- Handlebars.registerHelper('if-any', function(items, options) {
- var having = options.hash.having;
- for (var i in items) {
- var item = items[i]
- if (!having || item[having]) {
- return options.fn(this);
- }
- }
- return "";
- });
-
-
- Handlebars.registerHelper('first', function(items, options) {
- var having = options.hash.having;
- for (var i in items) {
- var item = items[i]
- if (!having || item[having]) {
- return options.fn(item);
- }
- }
- return "";
- });
-
-
- Handlebars.registerHelper('commaList', function(items, options) {
- var out = "";
-
- for (var i in items) {
- if (i > 0) out += ", ";
- out += options.fn(items[i])
- }
-
- return out;
- });
-
-
{
/* default mkws config */
dummy: "dummy"
};
- /* set global debug_level flag early */
+ /* Set global debug_level flag early so that debug() works */
if (typeof mkws_config.debug_level !== 'undefined') {
mkws.debug_level = mkws_config.debug_level;
} else if (typeof config_default.debug_level !== 'undefined') {
// create a parameters array and pass it to the pz2's constructor
// then register the form submit event with the pz2.search function
// autoInit is set to true on default
- var m_paz = new pz2( { "onshow": my_onshow,
+ mkws.paz = new pz2( { "onshow": my_onshow,
"showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
"pazpar2path": mkws_config.pazpar2_url,
"oninit": my_oninit,
"showResponseType": '', // or "json" (for debugging?)
"onrecord": my_onrecord } );
- // some state vars
- var curPage = 1;
- var recPerPage = 20;
- var totalRec = 0;
- var curDetRecId = '';
- var curDetRecData = null;
- var submitted = false;
- var SourceMax = 16;
- var SubjectMax = 10;
- var AuthorMax = 10;
- var m_query; // initially undefined
-
if (!isNaN(parseInt(mkws_config.perpage_default))) {
- recPerPage = parseInt(mkws_config.perpage_default);
+ m_recPerPage = parseInt(mkws_config.perpage_default);
}
+
//
// pz2.js event handlers:
//
function my_oninit() {
- m_paz.stat();
- m_paz.bytarget();
+ mkws.paz.stat();
+ mkws.paz.bytarget();
}
+
function my_onshow(data) {
- totalRec = data.merged;
+ m_totalRec = data.merged;
// move it out
var pager = document.getElementById("mkwsPager");
if (pager) {
html.push('<div class="record" id="mkwsRecdiv_' + hit.recid + '" >',
renderSummary(hit),
'</div>');
- if (hit.recid == curDetRecId) {
- html.push(renderDetails(curDetRecData));
+ if (hit.recid == m_curDetRecId) {
+ html.push(renderDetails(m_curDetRecData));
}
}
replaceHtml(results, html.join(''));
'<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>';
}
+
function my_onterm(data) {
// no facets
if (!mkws_config.facets || mkws_config.facets.length == 0) {
for(var i = 0; i < facets.length; i++) {
if (facets[i] == "sources") {
- add_single_facet(acc, "Sources", data.xtargets, SourceMax, null);
+ add_single_facet(acc, "Sources", data.xtargets, 16, null);
} else if (facets[i] == "subjects") {
- add_single_facet(acc, "Subjects", data.subject, SubjectMax, "subject");
+ add_single_facet(acc, "Subjects", data.subject, 10, "subject");
} else if (facets[i] == "authors") {
- add_single_facet(acc, "Authors", data.author, AuthorMax, "author");
+ add_single_facet(acc, "Authors", data.author, 10, "author");
} else {
alert("bad facet configuration: '" + facets[i] + "'");
}
replaceHtml(termlist, acc.join(''));
}
+
function add_single_facet(acc, caption, data, max, pzIndex) {
acc.push('<div class="facet" id="mkwsFacet' + caption + '">');
acc.push('<div class="termtitle">' + M(caption) + '</div>');
acc.push('</div>');
}
+
function my_onrecord(data) {
// FIXME: record is async!!
- clearTimeout(m_paz.recordTimer);
+ clearTimeout(mkws.paz.recordTimer);
// in case on_show was faster to redraw element
var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
if (detRecordDiv) return;
- curDetRecData = data;
- var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid);
- var html = renderDetails(curDetRecData);
+ m_curDetRecData = data;
+ var recordDiv = document.getElementById('mkwsRecdiv_'+m_curDetRecData.recid);
+ var html = renderDetails(m_curDetRecData);
recordDiv.innerHTML += html;
}
+
function my_onbytarget(data) {
var targetDiv = document.getElementById("mkwsBytarget");
if (!targetDiv) {
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
+
// wait until the DOM is ready
function domReady ()
{
}
}
+
// when search button pressed
function onFormSubmitEventHandler()
{
return false;
}
+
function newSearch(query, sort, targets, windowid)
{
debug("newSearch: " + query);
loadSelect(); // ### should use windowid
triggerSearch(query, sort, targets, windowid);
mkws.switchView('records'); // In case it's configured to start off as hidden
- submitted = true;
+ m_submitted = true;
}
+
function onSelectDdChange()
{
- if (!submitted) return false;
+ if (!m_submitted) return false;
resetPage();
loadSelect();
- m_paz.show(0, recPerPage, m_sort);
+ mkws.paz.show(0, m_recPerPage, m_sort);
return false;
}
+
function resetPage()
{
- curPage = 1;
- totalRec = 0;
+ m_curPage = 1;
+ m_totalRec = 0;
}
+
function triggerSearch (query, sort, targets, windowid)
{
var pp2filter = "";
}
debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
- m_paz.search(m_query, recPerPage, m_sort, pp2filter, undefined, params);
+ mkws.paz.search(m_query, m_recPerPage, m_sort, pp2filter, undefined, params);
}
+
function loadSelect ()
{
if (document.mkwsSelect) {
if (document.mkwsSelect.mkwsSort)
m_sort = document.mkwsSelect.mkwsSort.value;
if (document.mkwsSelect.mkwsPerpage)
- recPerPage = document.mkwsSelect.mkwsPerpage.value;
+ m_recPerPage = document.mkwsSelect.mkwsPerpage.value;
}
}
+
// limit the query after clicking the facet
mkws.limitQuery = function (field, value)
{
return false;
}
+
// limit by target functions
mkws.limitTarget = function (id, name)
{
return false;
}
+
mkws.delimitQuery = function (field, value)
{
debug("delimitQuery(field=" + field + ", value=" + value + ")");
{
//client indexes pages from 1 but pz2 from 0
var onsides = 6;
- var pages = Math.ceil(totalRec / recPerPage);
+ var pages = Math.ceil(m_totalRec / m_recPerPage);
- var firstClkbl = ( curPage - onsides > 0 )
- ? curPage - onsides
+ var firstClkbl = ( m_curPage - onsides > 0 )
+ ? m_curPage - onsides
: 1;
var lastClkbl = firstClkbl + 2*onsides < pages
: pages;
var prev = '<span id="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
- if (curPage > 1)
+ if (m_curPage > 1)
prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev();">'
+'<< ' + M('Prev') + '</a><b> | </b>';
var middle = '';
for(var i = firstClkbl; i <= lastClkbl; i++) {
var numLabel = i;
- if(i == curPage)
+ if(i == m_curPage)
numLabel = '<b>' + i + '</b>';
middle += '<a href="#" onclick="mkws.showPage(' + i + ')"> '
}
var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' >></span>';
- if (pages - curPage > 0)
+ if (pages - m_curPage > 0)
next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext()">'
+ M('Next') + ' >></a>';
+ prev + predots + middle + postdots + next + '</div>';
}
+
mkws.showPage = function (pageNum)
{
- curPage = pageNum;
- m_paz.showPage( curPage - 1 );
+ m_curPage = pageNum;
+ mkws.paz.showPage( m_curPage - 1 );
}
- // simple paging functions
+ // simple paging functions
mkws.pagerNext = function () {
- if ( totalRec - recPerPage*curPage > 0) {
- m_paz.showNext();
- curPage++;
+ if ( m_totalRec - m_recPerPage*m_curPage > 0) {
+ mkws.paz.showNext();
+ m_curPage++;
}
}
+
mkws.pagerPrev = function () {
- if ( m_paz.showPrev() != false )
- curPage--;
+ if ( mkws.paz.showPrev() != false )
+ m_curPage--;
}
- // switching view between targets and records
+ // switching view between targets and records
mkws.switchView = function(view) {
debug("switchView: " + view);
}
}
+
// detailed record drawing
mkws.showDetails = function (prefixRecId) {
var recId = prefixRecId.replace('mkwsRec_', '');
- var oldRecId = curDetRecId;
- curDetRecId = recId;
+ var oldRecId = m_curDetRecId;
+ m_curDetRecId = recId;
// remove current detailed view if any
var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
// if the same clicked, just hide
if (recId == oldRecId) {
- curDetRecId = '';
- curDetRecData = null;
+ m_curDetRecId = '';
+ m_curDetRecData = null;
return;
}
// request the record
- m_paz.record(recId);
+ mkws.paz.record(recId);
}
+
function replaceHtml(el, html) {
var oldEl = typeof el === "string" ? document.getElementById(el) : el;
/*@cc_on // Pure innerHTML is slightly faster in IE
return newEl;
};
+
function renderDetails(data, marker)
{
var template = loadTemplate("Record");
return nvpair;
}
+
function mkws_set_lang() {
var lang = parseQuerystring().lang || mkws_config.lang;
if (!lang || !mkws.locale_lang[lang]) {
return mkws_config.lang;
}
+
function mkws_html_switch() {
debug("HTML switch");
$("#mkwsTargets").css("display", "none");
}
+
function mkws_html_sort() {
debug("HTML sort, m_sort = '" + m_sort + "'");
var sort_html = '<select name="mkwsSort" id="mkwsSort">';
return sort_html;
}
+
function mkws_html_perpage() {
debug("HTML perpage");
var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
return perpage_html;
}
+
/*
* Run service-proxy authentication in background (after page load).
* The username/password is configured in the apache config file
});
}
+
/* create locale language menu */
function mkws_html_lang() {
var lang_default = "en";
$("#mkwsLang").html(data);
}
+
function mkws_resize_page () {
var list = ["mkwsSwitch"];
}
};
+
/* locale */
function M(word) {
var lang = mkws_config.lang;
return mkws.locale_lang[lang][word] || word;
}
+ mkws.M = M; // so the Handlebars helper can use it
+
// main
(function() {
}
})();
- // done
- mkws.init = true;
+ // Bizarrely, 'that' is just an empty hash. All its state is in
+ // the closure variables defined earlier in this function.
+ return that;
};
// wrapper to call _make_mkws_team() after page load
(function (j) {
+ function log(s) {
+ if (console && console.log) console.log(s);
+ }
// enable before page load, so we could call it before mkws() runs
_mkws_jquery_plugin(j);
$(document).ready(function() {
- // if (console && console.log) console.log("on load ready");
- _make_mkws_team(j, null);
+ log("on load ready");
+
+ // Backwards compatibility: set new magic class names on any
+ // elements that have the old magic IDs.
+ var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
+ "Results", "Records", "Targets", "Ranking",
+ "Termlists", "Stat" ];
+ for (var i = 0; i < ids.length; i++) {
+ var id = 'mkws' + ids[i];
+ var node = $('#' + id);
+ if (node.attr('id')) {
+ node.addClass(id + " mkwsTeam_AUTO");
+ log("added magic classes to '" + node.attr('id') + "'");
+ }
+ }
+
+ // Backwards compatibility: the special-case undefined team
+ mkws.teams[''] = _make_mkws_team(j, undefined);
+ log("Made the unnamed MKWS team");
+
+ // Find all nodes with class (NOT id) mkwsRecords, and
+ // determine their team from the mkwsTeam_* class. So:
+ // <div class="mkwsRecords mkwsTeam_foo"/>
+ $('.mkwsResults, .mkwsRecords, .mkwsTermlists').each(function () {
+ var node = this;
+ var classes = this.className;
+ var list = classes.split(/\s+/)
+ var tname;
+ for (var i = 0; i < list.length; i++) {
+ var cname = list[i];
+ if (cname.match(/^mkwsTeam_/)) {
+ tname = cname.replace(/^mkwsTeam_/, '');
+ }
+ }
+ if (!tname) {
+ alert("No MKWS team specified for mkwsRecords element with classes '" + classes + "'");
+ } else if (mkws.teams[tname]) {
+ log("MKWS team '" + tname + "' already exists, skipping");
+ } else {
+ mkws.teams[tname] = _make_mkws_team(j, tname);
+ log("Made MKWS team '" + tname + "'");
+ }
+ });
+
});
})(jQuery);