-/*! MKWS, the MasterKey Widget Set. Copyright (C) 2013-2014, Index Data */
+/*! MKWS, the MasterKey Widget Set.
+ * Copyright (C) 2013-2014 Index Data
+ * See the file LICENSE for details
+ */
"use strict"; // HTML5: disable for debug_level >= 2
});
+Handlebars.registerHelper('index1', function(obj) {
+ return obj.data.index + 1;
+});
-// Some functions are visible to be called from outside code, namely
-// generated HTML: mkws.switchView(), showDetails(), limitTarget(),
-// limitQuery(), delimitTarget(), delimitQuery(), pagerPrev(),
-// pagerNext(), showPage(). Also mkws.M() is made available for the
-// Handlebars helper 'translate'
-// Set up global mkws object. Contains a hash of team objects,
-// indexed by windowid.
+// Set up global mkws object. Contains truly global state such as SP
+// authentication, and a hash of team objects, indexed by windowid.
+//
var mkws = {
authenticated: false,
- debug_function: undefined, // will be set during initialisation
- debug_level: undefined, // will be initialised from mkws_config
+ debug_level: 1, // Will be overridden from mkws_config, but
+ // initial value allows jQuery popup to use logging.
paz: undefined, // will be set up during initialisation
teams: {},
locale_lang: {
"Authors": "Autoren",
"Subjects": "Schlagwörter",
"Sources": "Daten und Quellen",
+ "source": "datenquelle",
"Termlists": "Termlisten",
"Next": "Weiter",
"Prev": "Zurück",
"found": "gefunden",
"Title": "Titel",
"Author": "Autor",
+ "author": "autor",
"Date": "Datum",
"Subject": "Schlagwort",
+ "subject": "schlagwort",
"Location": "Ort",
"Records": "Datensätze",
"Targets": "Datenbanken",
"Authors": "Forfattere",
"Subjects": "Emner",
"Sources": "Kilder",
+ "source": "kilder",
"Termlists": "Termlists",
"Next": "Næste",
"Prev": "Forrige",
"found": "fandt",
"Title": "Title",
"Author": "Forfatter",
+ "author": "forfatter",
"Date": "Dato",
"Subject": "Emneord",
+ "subject": "emneord",
"Location": "Lokation",
"Records": "Poster",
"Targets": "Baser",
};
+// The following PubSub code is modified from the jQuery manual:
+// https://api.jquery.com/jQuery.Callbacks/
+//
+// Use as:
+// mkws.queue("eventName").subscribe(function(param1, param2 ...) { ... });
+// mkws.queue("eventName").publish(arg1, arg2, ...);
+
+(function() {
+ var queues = {};
+ mkws.queue = function(id) {
+ if (!queues[id]) {
+ var callbacks = $.Callbacks();
+ queues[id] = {
+ publish: callbacks.fire,
+ subscribe: callbacks.add,
+ unsubscribe: callbacks.remove
+ };
+ }
+ return queues[id];
+ }
+}());
+
+
// 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
+// Factory function for widget objects.
+function widget($, team, type, node) {
+ var that = {
+ team: team,
+ type: type,
+ node: node
+ };
+
+ // ### More to do here, surely: e.g. wiring into the team
+ mkws.debug("made widget(team=" + team + ", type=" + type + ", node=" + node);
+
+ return that;
+}
+
+
+// Factory function for team objects. As much as possible, this uses
+// only member variables (prefixed "m_") and inner functions with
+// private scope. Some functions are visibl as member-functions to be
+// called from outside code -- specifically, from generated
+// HTML. These functions are that.switchView(), showDetails(),
+// limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
+// pagerPrev(), pagerNext(), showPage().
+//
function team($, teamName) {
var that = {};
var m_teamName = teamName;
var m_submitted = false;
var m_query; // initially undefined
- var m_sort = 'relevance';
+ var m_sort; // will be set below
+ var m_perpage; // will be set below
var m_filters = [];
var m_totalRec = 0;
- var m_recPerPage = 20;
var m_curPage = 1;
var m_curDetRecId = '';
var m_curDetRecData = null;
"last": $.now()
};
var m_paz; // will be initialised below
+ var m_template = {};
- // if (console && console.log) // disabled, will fail in IE8
- // console.log("run team(" + (teamName ? teamName : "") + ")");
-
-
- // Needs to be defined inside team() so it can see m_debug_time
- // ### member access won't work: there is only one instance of this function
- mkws.debug_function = function (string) {
- if (!mkws.debug_level)
- return;
-
- if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
- return;
- }
-
+ var debug = function (s) {
var now = $.now();
var timestamp = ((now - m_debug_time.start)/1000).toFixed(3) + " (+" + ((now - m_debug_time.last)/1000).toFixed(3) + ") "
m_debug_time.last = now;
- // you need to disable use strict at the top of the file!!!
- if (mkws.debug_level >= 3) {
- console.log(timestamp + arguments.callee.caller);
- } else if (mkws.debug_level >= 2) {
- console.log(timestamp + ">>> called from function " + arguments.callee.caller.name + ' <<<');
- }
- console.log(timestamp + string);
+ mkws.debug(m_teamName + ": " + timestamp + s);
}
- var debug = mkws.debug_function; // local alias
+
debug("start running MKWS");
m_sort = mkws_config.sort_default;
debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to m_sort");
- if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
- debug("Reset query width: " + mkws_config.query_width);
- mkws_config.query_width = 50;
- }
-
- for (var key in mkws_config) {
- if (mkws_config.hasOwnProperty(key)) {
- if (key.match(/^language_/)) {
- var lang = key.replace(/^language_/, "");
- // Copy custom languages into list
- mkws.locale_lang[lang] = mkws_config[key];
- debug("Added locally configured language '" + lang + "'");
- }
- }
- }
-
// protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
if (mkws_config.pazpar2_url.match(/^\/\//)) {
mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
"pazpar2path": mkws_config.pazpar2_url,
"oninit": my_oninit,
"onstat": my_onstat,
- "onterm": my_onterm,
- "termlist": "xtargets,subject,author",
+ "onterm": (mkws_config.facets.length ? my_onterm : undefined),
+ "termlist": mkws_config.facets.join(','),
"onbytarget": my_onbytarget,
"usesessions" : mkws_config.use_service_proxy ? false : true,
"showResponseType": '', // or "json" (for debugging?)
"onrecord": my_onrecord });
if (!isNaN(parseInt(mkws_config.perpage_default))) {
- m_recPerPage = parseInt(mkws_config.perpage_default);
+ m_perpage = parseInt(mkws_config.perpage_default);
+ }
+
+
+ // Finds the node of the specified class within the current team
+ // Multiple OR-clauses separated by commas are handled
+ // More complex cases may not work
+ //
+ function findnode(selector, teamName) {
+ teamName = teamName || m_teamName;
+
+ selector = selector.split(',').map(function(s) {
+ return s + '.mkwsTeam_' + teamName;
+ }).join(',');
+
+ return $(selector);
}
// pz2.js event handlers:
//
function my_oninit(teamName) {
- debug("init for " + teamName);
+ debug("init");
m_paz.stat();
m_paz.bytarget();
}
function my_onshow(data, teamName) {
- debug("show for " + teamName);
+ debug("show");
m_totalRec = data.merged;
- // move it out
- var pager = document.getElementById("mkwsPager");
- if (pager) {
- pager.innerHTML = "";
- pager.innerHTML +='<div style="float: right">' + M('Displaying') + ': '
- + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
- ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
- + data.total + ')</div>';
- drawPager(pager);
+
+ var pager = findnode(".mkwsPager");
+ if (pager.length) {
+ pager.html(drawPager(data))
}
- // navi
- var results = $(".mkwsRecords.mkwsTeam_" + m_teamName);
+ var results = findnode(".mkwsRecords");
+ if (!results.length)
+ return;
var html = [];
for (var i = 0; i < data.hits.length; i++) {
var hit = data.hits[i];
- html.push('<div class="record" id="mkwsRecdiv_' + hit.recid + '" >',
+ html.push('<div class="record" id="mkwsRecdiv_' + teamName + '_' + hit.recid + '" >',
renderSummary(hit),
'</div>');
if (hit.recid == m_curDetRecId) {
{
var template = loadTemplate("Summary");
hit._id = "mkwsRec_" + hit.recid;
- hit._onclick = "mkws.showDetails(this.id, '" + m_teamName + "');return false;"
+ hit._onclick = "mkws.showDetails('" + m_teamName + "', this.id);return false;"
return template(hit);
}
function my_onstat(data, teamName) {
- debug("stat for " + teamName);
- var stat = $('.mkwsStat.mkwsTeam_' + teamName);
+ debug("stat");
+ var stat = findnode('.mkwsStat');
if (stat.length === 0)
return;
function my_onterm(data, teamName) {
- debug("term for " + teamName);
- // no facets
+ debug("term");
+ var node = findnode(".mkwsTermlists");
+ if (node.length == 0) return;
+
+ // no facets: this should never happen
if (!mkws_config.facets || mkws_config.facets.length == 0) {
- $("#mkwsTermlists").hide();
+ alert("my_onterm called even though we have no facets: " + $.toJSON(data));
+ node.hide();
return;
}
// display if we first got results
- $("#mkwsTermlists").show();
+ node.show();
var acc = [];
acc.push('<div class="title">' + M('Termlists') + '</div>');
var facets = mkws_config.facets;
for(var i = 0; i < facets.length; i++) {
- if (facets[i] == "sources") {
+ if (facets[i] == "xtargets") {
add_single_facet(acc, "Sources", data.xtargets, 16, null);
- } else if (facets[i] == "subjects") {
+ } else if (facets[i] == "subject") {
add_single_facet(acc, "Subjects", data.subject, 10, "subject");
- } else if (facets[i] == "authors") {
+ } else if (facets[i] == "author") {
add_single_facet(acc, "Authors", data.author, 10, "author");
} else {
alert("bad facet configuration: '" + facets[i] + "'");
}
}
- var termlist = $("#mkwsTermlists");
- if (termlist)
- termlist.html(acc.join(''));
+ node.html(acc.join(''));
}
function add_single_facet(acc, caption, data, max, pzIndex) {
- acc.push('<div class="facet" id="mkwsFacet' + caption + '">');
+ acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + m_teamName + '">');
acc.push('<div class="termtitle">' + M(caption) + '</div>');
for (var i = 0; i < data.length && i < max; i++) {
acc.push('<div class="term">');
acc.push('<a href="#" ');
- var action;
+ var action = '';
if (!pzIndex) {
// Special case: target selection
acc.push('target_id='+data[i].id+' ');
- action = 'mkws.limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
+ if (!target_filtered(data[i].id)) {
+ action = 'mkws.limitTarget(\'' + m_teamName + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
+ }
} else {
- action = 'mkws.limitQuery(\'' + pzIndex + '\', this.firstChild.nodeValue)';
+ action = 'mkws.limitQuery(\'' + m_teamName + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
}
acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
+ ' <span>' + data[i].freq + '</span>');
}
+ function target_filtered(id) {
+ for (var i = 0; i < m_filters.length; i++) {
+ if (m_filters[i].id === id ||
+ m_filters[i].id === 'pz:id=' + id) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+
function my_onrecord(data, args, teamName) {
- debug("record for " + teamName);
+ debug("record: teamName=" + teamName + ", m_teamName=" + m_teamName);
// FIXME: record is async!!
clearTimeout(m_paz.recordTimer);
// in case on_show was faster to redraw element
- var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
+ var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
if (detRecordDiv) return;
m_curDetRecData = data;
- var recordDiv = document.getElementById('mkwsRecdiv_'+m_curDetRecData.recid);
+ var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_curDetRecData.recid);
var html = renderDetails(m_curDetRecData);
recordDiv.innerHTML += html;
}
function my_onbytarget(data, teamName) {
- debug("target for " + teamName);
- var targetDiv = $('.mkwsBytarget.mkwsTeam_' + teamName);
+ debug("target");
+ var targetDiv = findnode('.mkwsBytarget');
if (!targetDiv) {
return;
}
////////////////////////////////////////////////////////////////////////////////
- // wait until the DOM is ready
- function domReady ()
- {
- $('.mkwsSearchForm.mkwsTeam_' + m_teamName).each(function (i, obj) {
- debug("adding search-forms for team '" + m_teamName + "'");
- var node = this;
- mkws.handle_node_with_team(node, function(tname) {
- debug("adding search-form '" + tname + "' for team '" + m_teamName + "'");
- $(node).submit(onFormSubmitEventHandler);
- });
- });
-
- document.mkwsSearchForm.mkwsQuery.value = '';
- if (document.mkwsSelect) {
- if (document.mkwsSelect.mkwsSort)
- document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
- if (document.mkwsSelect.mkwsPerpage)
- document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
- }
- }
-
-
// when search button pressed
+ // ### This is closure, so can always just operate on its own team
function onFormSubmitEventHandler()
{
mkws.handle_node_with_team(this, function (tname) {
- var val = $('.mkwsQuery.mkwsTeam_' + tname).val();
+ var val = findnode('.mkwsQuery').val();
mkws.teams[tname].newSearch(val);
});
}
+ // ### won't need to be externally visible once onFormSubmitEventHandler() is fixed.
+ // ### doesn't need windowid
that.newSearch = function(query, sort, targets, windowid)
{
debug("newSearch: " + query);
}
m_filters = []
- redraw_navi(); // ### should use windowid
- resetPage(); // ### the globals it resents should be indexed by windowid
- loadSelect(); // ### should use windowid
+ redraw_navi();
+ resetPage();
+ loadSelect();
triggerSearch(query, sort, targets, windowid);
- mkws.switchView(m_teamName, 'records'); // In case it's configured to start off as hidden
+ that.switchView('records'); // In case it's configured to start off as hidden
m_submitted = true;
}
if (!m_submitted) return false;
resetPage();
loadSelect();
- m_paz.show(0, m_recPerPage, m_sort);
+ m_paz.show(0, m_perpage, m_sort);
return false;
}
}
+ // ### doesn't need windowid
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, m_recPerPage, m_sort, pp2filter, undefined, params);
+ // We can use: params.torusquery = "udb=NAME"
+ // Note: that won't work when running against raw pazpar2
+ m_paz.search(m_query, m_perpage, m_sort, pp2filter, undefined, params);
}
function loadSelect ()
{
- if (document.mkwsSelect) {
- if (document.mkwsSelect.mkwsSort)
- m_sort = document.mkwsSelect.mkwsSort.value;
- if (document.mkwsSelect.mkwsPerpage)
- m_recPerPage = document.mkwsSelect.mkwsPerpage.value;
+ var node = findnode('.mkwsSort');
+ if (node.length && node.val() != m_sort) {
+ debug("changing m_sort from " + m_sort + " to " + node.val());
+ m_sort = node.val();
+ }
+ node = findnode('.mkwsPerpage');
+ if (node.length && node.val() != m_perpage) {
+ debug("changing m_perpage from " + m_perpage + " to " + node.val());
+ m_perpage = node.val();
}
}
- // limit the query after clicking the facet
- mkws.limitQuery = function (field, value)
+ // limit by target functions
+ that.limitTarget = function (id, name)
{
- debug("limitQuery(field=" + field + ", value=" + value + ")");
- m_filters.push({ field: field, value: value });
+ debug("limitTarget(id=" + id + ", name=" + name + ")");
+ m_filters.push({ id: id, name: name });
redraw_navi();
resetPage();
loadSelect();
}
- // limit by target functions
- mkws.limitTarget = function (id, name)
+ // limit the query after clicking the facet
+ that.limitQuery = function (field, value)
{
- debug("limitTarget(id=" + id + ", name=" + name + ")");
- m_filters.push({ id: id, name: name });
+ debug("limitQuery(field=" + field + ", value=" + value + ")");
+ m_filters.push({ field: field, value: value });
redraw_navi();
resetPage();
loadSelect();
}
- mkws.delimitQuery = function (field, value)
+ that.delimitTarget = function (id)
{
- debug("delimitQuery(field=" + field + ", value=" + value + ")");
+ debug("delimitTarget(id=" + id + ")");
var newFilters = [];
for (var i in m_filters) {
var filter = m_filters[i];
- if (filter.field &&
- field == filter.field &&
- value == filter.value) {
+ if (filter.id) {
debug("delimitTarget() removing filter " + $.toJSON(filter));
} else {
debug("delimitTarget() keeping filter " + $.toJSON(filter));
}
- mkws.delimitTarget = function (id)
+ that.delimitQuery = function (field, value)
{
- debug("delimitTarget(id=" + id + ")");
+ debug("delimitQuery(field=" + field + ", value=" + value + ")");
var newFilters = [];
for (var i in m_filters) {
var filter = m_filters[i];
- if (filter.id) {
- debug("delimitTarget() removing filter " + $.toJSON(filter));
+ if (filter.field &&
+ field == filter.field &&
+ value == filter.value) {
+ debug("delimitQuery() removing filter " + $.toJSON(filter));
} else {
- debug("delimitTarget() keeping filter " + $.toJSON(filter));
+ debug("delimitQuery() keeping filter " + $.toJSON(filter));
newFilters.push(filter);
}
}
function redraw_navi ()
{
- var navi = document.getElementById('mkwsNavi');
+ var navi = findnode('.mkwsNavi');
if (!navi) return;
var text = "";
}
var filter = m_filters[i];
if (filter.id) {
- text += 'Source: <a class="crossout" href="#" onclick="mkws.delimitTarget(' +
- "'" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
+ text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
+ "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
} else {
- text += filter.field + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(' +
- "'" + filter.field + "', '" + filter.value + "'" +
+ text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
+ "', '" + filter.field + "', '" + filter.value + "'" +
');return false;">' + filter.value + '</a>';
}
}
- navi.innerHTML = text;
+ navi.html(text);
}
- function drawPager (pagerDiv)
+ function drawPager (data)
{
+ var s = '<div style="float: right">' + M('Displaying') + ': '
+ + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
+ ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
+ + data.total + ')</div>';
+
//client indexes pages from 1 but pz2 from 0
var onsides = 6;
- var pages = Math.ceil(m_totalRec / m_recPerPage);
+ var pages = Math.ceil(m_totalRec / m_perpage);
var firstClkbl = (m_curPage - onsides > 0)
? m_curPage - onsides
? firstClkbl + 2*onsides
: pages;
- var prev = '<span id="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
+ var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
if (m_curPage > 1)
- prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev();">'
+ prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + m_teamName + '\');">'
+'<< ' + M('Prev') + '</a><b> | </b>';
var middle = '';
if(i == m_curPage)
numLabel = '<b>' + i + '</b>';
- middle += '<a href="#" onclick="mkws.showPage(' + i + ')"> '
+ middle += '<a href="#" onclick="mkws.showPage(\'' + m_teamName + '\', ' + i + ')"> '
+ numLabel + ' </a>';
}
- var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' >></span>';
+ var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
if (pages - m_curPage > 0)
- next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext()">'
+ next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + m_teamName + '\')">'
+ M('Next') + ' >></a>';
var predots = '';
if (lastClkbl < pages)
postdots = '...';
- pagerDiv.innerHTML += '<div style="float: clear">'
+ s += '<div style="float: clear">'
+ prev + predots + middle + postdots + next + '</div>';
+
+ return s;
}
- mkws.showPage = function (pageNum)
+ that.showPage = function (pageNum)
{
m_curPage = pageNum;
m_paz.showPage(m_curPage - 1);
// simple paging functions
- mkws.pagerNext = function () {
- if (m_totalRec - m_recPerPage*m_curPage > 0) {
+ that.pagerNext = function () {
+ if (m_totalRec - m_perpage*m_curPage > 0) {
m_paz.showNext();
m_curPage++;
}
}
- mkws.pagerPrev = function () {
+ that.pagerPrev = function () {
if (m_paz.showPrev() != false)
m_curPage--;
}
// switching view between targets and records
- mkws.switchView = function(tname, view) {
- debug("switchView(" + tname + ", " + view + ")");
-
- var targets = $('.mkwsTargets.mkwsTeam_' + tname);
- var results = $('.mkwsResults.mkwsTeam_' + tname + ',.mkwsRecords.mkwsTeam_' + tname);
- var blanket = $('#mkwsBlanket');
- var motd = $('#mkwsMOTD');
+ that.switchView = function(view) {
+ var targets = findnode('.mkwsTargets');
+ var results = findnode('.mkwsResults,.mkwsRecords');
+ var blanket = findnode('.mkwsBlanket');
+ var motd = findnode('.mkwsMOTD');
switch(view) {
case 'targets':
if (motd) motd.css('display', 'none');
break;
case 'none':
- alert("mkws.switchView(" + tname + ", 'none') shouldn't happen");
+ alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
if (targets) targets.css('display', 'none');
if (results) results.css('display', 'none');
if (blanket) blanket.css('display', 'none');
m_curDetRecId = recId;
// remove current detailed view if any
- var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
+ var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecId);
// lovin DOM!
if (detRecordDiv)
detRecordDiv.parentNode.removeChild(detRecordDiv);
return;
}
// request the record
+ debug("showDetails() requesting record '" + recId + "'");
m_paz.record(recId);
}
{
var template = loadTemplate("Record");
var details = template(data);
- return '<div class="details" id="mkwsDet_' + data.recid + '">' + details + '</div>';
+ return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
}
function loadTemplate(name)
{
- var template = mkws['template' + name];
+ var template = m_template[name];
if (template === undefined) {
- var source = $("#mkwsTemplate" + name).html();
+ // Fall back to generic template if there is no team-specific one
+ var node = findnode(".mkwsTemplate_" + name);
+ if (!node.length) {
+ node = findnode(".mkwsTemplate_" + name, "ALL");
+ }
+
+ var source = node.html();
if (!source) {
source = defaultTemplate(name);
}
template = Handlebars.compile(source);
debug("compiled template '" + name + "'");
- mkws['template' + name] = template;
+ m_template[name] = template;
}
return template;
{{/if}}\
{{#if md-electronic-url}}\
<tr>\
- <th>{{translate "URL"}}</th>\
+ <th>{{translate "Links"}}</th>\
<td>\
{{#each md-electronic-url}}\
- <a href="{{this}}">{{this}}</a><br/>\
+ <a href="{{this}}">Link{{index1}}</a>\
{{/each}}\
</td>\
</tr>\
<td>\
{{#first location having="md-subject"}}\
{{#if md-subject}}\
- {{md-subject}}\
+ {{#commaList md-subject}}\
+ {{this}}{{/commaList}}\
{{/if}}\
{{/first}}\
</td>\
* All the HTML stuff to render the search forms and
* result pages.
*/
+ // ### This and other multi-word identifiers should be camelCase
function mkws_html_all() {
mkws_set_lang();
if (mkws_config.show_lang)
mkws_html_lang();
- // For some reason, doing this programmatically results in
- // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
debug("HTML search form");
- // ### There is only one match here by design: fix not to bother looping
- $('.mkwsSearch.mkwsTeam_' + m_teamName).each(function (i, obj) {
- var node = this;
- mkws.handle_node_with_team(node, function(tname) {
- $(node).html('\
+ mkws.handle_node_with_team(findnode('.mkwsSearch'), function(tname) {
+ this.html('\
<form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
- <input id="mkwsQuery" class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
- <input id="mkwsButton" class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
+ <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
+ <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
</form>');
- });
});
debug("HTML records");
// .mkwsPager
// .mkwsNavi
// .mkwsRecords
- if ($(".mkwsResults.mkwsTeam_" + m_teamName).length) {
- $(".mkwsResults.mkwsTeam_" + m_teamName).html('\
+ if (findnode(".mkwsResults").length) {
+ findnode(".mkwsResults").html('\
<table width="100%" border="0" cellpadding="6" cellspacing="0">\
<tr>\
<td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
- <div id="mkwsTermlists" class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
+ <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
</td>\
- <td id="mkwsMOTDContainer" valign="top">\
- <div id="mkwsRanking" class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
- <div id="mkwsPager" class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
- <div id="mkwsNavi" class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
- <div id="mkwsRecords" class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
+ <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
+ <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
+ <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
+ <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
+ <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
</td>\
</tr>\
<tr>\
</table>');
}
- if ($("#mkwsRanking").length) {
+ var node = findnode(".mkwsRanking");
+ if (node.length) {
var ranking_data = '';
- ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
+ ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
if (mkws_config.show_sort) {
ranking_data += M('Sort by') + ' ' + mkws_html_sort() + ' ';
}
}
ranking_data += '</form>';
- $("#mkwsRanking").html(ranking_data);
+ node.html(ranking_data);
}
mkws_html_switch();
+ // ### Should not be in the team code, since window size is global
if (mkws_config.responsive_design_width) {
// Responsive web design - change layout on the fly based on
// current screen width. Required for mobile devices.
$(document).ready(function() { mkws.resize_page() });
}
- domReady();
+ var node;
+ node = findnode('.mkwsSearchForm');
+ if (node.length)
+ node.submit(onFormSubmitEventHandler);
+ node = findnode('.mkwsSort');
+ if (node.length)
+ node.change(onSelectDdChange);
+ node = findnode('.mkwsPerpage');
+ if (node.length)
+ node.change(onSelectDdChange);
// on first page, hide the termlist
- $(document).ready(function() { $("#mkwsTermlists").hide(); });
- var motd = document.getElementById("mkwsMOTD");
- var container = document.getElementById("mkwsMOTDContainer");
- if (motd && container) {
+ $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
+ var motd = findnode(".mkwsMOTD");
+ var container = findnode(".mkwsMOTDContainer");
+ if (motd.length && container.length) {
// Move the MOTD from the provided element down into the container
- motd.parentNode.removeChild(motd);
- container.appendChild(motd);
+ motd.appendTo(container);
}
}
function mkws_html_switch() {
debug("HTML switch for team " + m_teamName);
- var node = $(".mkwsSwitch.mkwsTeam_" + m_teamName);
+ var node = findnode(".mkwsSwitch");
node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
node.append($("<span/>", { text: " | " }));
node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
debug("HTML targets");
- var node = $(".mkwsTargets.mkwsTeam_" + m_teamName);
+ var node = findnode(".mkwsTargets");
node.html('\
<div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
No information available yet.\
function mkws_html_sort() {
debug("HTML sort, m_sort = '" + m_sort + "'");
- var sort_html = '<select name="mkwsSort" id="mkwsSort">';
+ var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
for(var i = 0; i < mkws_config.sort_options.length; i++) {
var opt = mkws_config.sort_options[i];
function mkws_html_perpage() {
- debug("HTML perpage");
- var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
+ debug("HTML perpage, m_perpage = " + m_perpage);
+ var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
for(var i = 0; i < mkws_config.perpage_options.length; i++) {
var key = mkws_config.perpage_options[i];
perpage_html += '<option value="' + key + '"';
- if (key == mkws_config.perpage_default) {
+ if (key == m_perpage) {
perpage_html += ' selected="selected"';
}
perpage_html += '>' + key + '</option>';
}
}
- $(".mkwsLang.mkwsTeam_" + m_teamName).html(data);
+ findnode(".mkwsLang").html(data);
+ }
+
+
+ that.run_auto_search = function() {
+ // ### should check mkwsTermlist as well, for facet-only teams
+ var node = findnode('.mkwsRecords');
+ var query = node.attr('autosearch');
+ if (!query)
+ return;
+
+ if (query.match(/^!param!/)) {
+ var param = query.replace(/^!param!/, '');
+ query = getParameterByName(param);
+ debug("obtained query '" + query + "' from param '" + param + "'");
+ if (!query) {
+ alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
+ }
+ } else if (query.match(/^!path!/)) {
+ var index = query.replace(/^!path!/, '');
+ var path = window.location.pathname.split('/');
+ query = path[path.length - index];
+ debug("obtained query '" + query + "' from path-component '" + index + "'");
+ if (!query) {
+ alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
+ }
+ }
+
+ debug("node=" + node + ", class='" + node.className + "', query=" + query);
+
+ var sort = node.attr('sort');
+ var targets = node.attr('targets');
+ var s = "running auto search: '" + query + "'";
+ if (sort) s += " sorted by '" + sort + "'";
+ if (targets) s += " in targets '" + targets + "'";
+ debug(s);
+
+ this.newSearch(query, sort, targets, m_teamName);
+ }
+
+
+ // This function is taken from a StackOverflow answer
+ // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
+ // ### should we unify this and parseQuerystring()?
+ function getParameterByName(name) {
+ name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
+ var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
+ results = regex.exec(location.search);
+ return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
}
};
-/*
- * implement jQuery plugin $.pazpar2({})
- */
-function _mkws_jquery_plugin ($) {
- var debug_level = 1;
-
- function debug (string) {
- if (!debug_level)
- return;
-
- if (typeof console === "undefined" || typeof console.log === "undefined")
+// wrapper to call team() after page load
+(function (j) {
+ mkws.debug = function (string) {
+ if (!mkws.debug_level)
return;
- console.log("jquery.pazpar2: " + string);
- }
-
- function init_popup(obj) {
- var config = obj ? obj : {};
-
- var height = config.height || 760;
- var width = config.width || 880;
- var id_button = config.id_button || "input#mkwsButton";
- var id_popup = config.id_popup || "#mkwsPopup";
-
- debug("popup height: " + height + ", width: " + width);
-
- // make sure that jquery-ui was loaded afte jQuery core lib, e.g.:
- // <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
- if (!$.ui) {
- debug("Error: jquery-ui.js is missing, did you include it after jQuery core in the HTML file?");
+ if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
return;
}
- $(id_popup).dialog({
- closeOnEscape: true,
- autoOpen: false,
- height: height,
- width: width,
- modal: true,
- resizable: true,
- buttons: {
- Cancel: function() {
- $(this).dialog("close");
- }
- },
- close: function() { }
- });
-
- $(id_button)
- .button()
- .click(function() {
- $(id_popup).dialog("open");
- });
- };
-
- $.extend({
-
- // service-proxy or pazpar2
- pazpar2: function(config) {
- var id_popup = config.id_popup || "#mkwsPopup";
- id_popup = id_popup.replace(/^#/, "");
-
- // simple layout
- var div = '\
-<div id="mkwsSwitch"></div>\
-<div id="mkwsLang"></div>\
-<div id="mkwsSearch"></div>\
-<div id="mkwsResults"></div>\
-<div id="mkwsTargets"></div>\
-<div id="mkwsStat"></div>';
-
- // new table layout
- var table = '\
-<style type="text/css">\
- #mkwsTermlists div.facet {\
- float:left;\
- width: 30%;\
- margin: 0.3em;\
- }\
- #mkwsStat {\
- text-align: right;\
- }\
-</style>\
- \
-<table width="100%" border="0">\
- <tr>\
- <td>\
- <div id="mkwsSwitch"></div>\
- <div id="mkwsLang"></div>\
- <div id="mkwsSearch"></div>\
- </td>\
- </tr>\
- <tr>\
- <td>\
- <div style="height:500px; overflow: auto">\
- <div id="mkwsPager"></div>\
- <div id="mkwsNavi"></div>\
- <div id="mkwsRecords"></div>\
- <div id="mkwsTargets"></div>\
- <div id="mkwsRanking"></div>\
- </div>\
- </td>\
- </tr>\
- <tr>\
- <td>\
- <div style="height:300px; overflow: hidden">\
- <div id="mkwsTermlists"></div>\
- </div>\
- </td>\
- </tr>\
- <tr>\
- <td>\
- <div id="mkwsStat"></div>\
- </td>\
- </tr>\
-</table>';
-
- var popup = '\
-<div id="mkwsSearch"></div>\
-<div id="' + id_popup + '">\
- <div id="mkwsSwitch"></div>\
- <div id="mkwsLang"></div>\
- <div id="mkwsResults"></div>\
- <div id="mkwsTargets"></div>\
- <div id="mkwsStat"></div>\
-</div>'
-
- if (config && config.layout == 'div') {
- debug("jquery plugin layout: div");
- document.write(div);
- } else if (config && config.layout == 'popup') {
- debug("jquery plugin layout: popup with id: " + id_popup);
- document.write(popup);
- $(document).ready(function() { init_popup(config); });
- } else {
- debug("jquery plugin layout: table");
- document.write(table);
- }
+ // you need to disable use strict at the top of the file!!!
+ if (mkws.debug_level >= 3) {
+ console.log(arguments.callee.caller);
+ } else if (mkws.debug_level >= 2) {
+ console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
}
- });
-};
-
-
-// wrapper to call team() after page load
-(function (j) {
- function log(s) {
- if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
- return;
- }
- console.log(s);
+ console.log(string);
}
-
- // enable before page load, so we could call it before mkws() runs
- _mkws_jquery_plugin(j);
-
- $(document).ready(function() {
- log("on load ready");
- default_mkws_config();
-
- // 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);
- log("added magic class to '" + node.attr('id') + "'");
- }
- }
-
- // For all MKWS-classed nodes that don't have a team
- // specified, set the team to AUTO.
- $('div[class^="mkws"],div[class*=" mkws"]').each(function () {
- if (!this.className.match(/mkwsTeam_/)) {
- log("adding AUTO team to node with class '" + this.className + "'");
- $(this).addClass('mkwsTeam_AUTO');
- }
- });
-
- // Find all nodes with class (NOT id) mkwsRecords, and
- // determine their team from the mkwsTeam_* class. So:
- // <div class="mkwsRecords mkwsTeam_foo"/>
- $('.mkwsSearch, .mkwsResults, .mkwsRecords, .mkwsTermlists').each(function () {
- var node = this;
- mkws.handle_node_with_team(node, function(tname) {
- if (mkws.teams[tname]) {
- log("MKWS team '" + tname + "' already exists, skipping");
- } else {
- mkws.teams[tname] = team(j, tname);
- log("Made MKWS team '" + tname + "'");
- }
- });
- });
-
- if (mkws_config.use_service_proxy) {
- authenticate_session(mkws_config.service_proxy_auth,
- mkws_config.service_proxy_auth_domain,
- mkws_config.pazpar2_url);
- } else {
- // raw pp2
- run_auto_searches();
- }
- });
+ var debug = mkws.debug;
mkws.handle_node_with_team = function(node, callback) {
- var classes = node.className;
+ // First branch for DOM objects; second branch for jQuery objects
+ var classes = node.className || node.attr('class');
+ if (!classes) {
+ // For some reason, if we try to proceed when classes is
+ // undefined, we don't get an error message, but this
+ // function and its callers, up several stack level,
+ // silently return. What a crock.
+ mkws.debug("handle_node_with_team() called on node with no classes");
+ return;
+ }
var list = classes.split(/\s+/)
- var tname;
+ var teamName, type;
+
for (var i = 0; i < list.length; i++) {
var cname = list[i];
if (cname.match(/^mkwsTeam_/)) {
- tname = cname.replace(/^mkwsTeam_/, '');
+ teamName = cname.replace(/^mkwsTeam_/, '');
+ } else if (cname.match(/^mkws/)) {
+ type = cname.replace(/^mkws/, '');
}
}
- callback(tname);
+ callback.call(node, teamName, type);
}
mkws.resize_page = function () {
- var list = ["mkwsSwitch"];
+ var list = ["mkwsSwitch", "mkwsLang"];
var width = mkws_config.responsive_design_width;
var parent = $(".mkwsTermlists").parent();
- log("parent = " + parent + ", length = " + parent.length);
if ($(window).width() <= width &&
parent.hasClass("mkwsTermlistContainer1")) {
- log("changing from wide to narrow: " + $(window).width());
+ debug("changing from wide to narrow: " + $(window).width());
$(".mkwsTermlistContainer1").hide();
$(".mkwsTermlistContainer2").show();
for (var tname in mkws.teams) {
}
} else if ($(window).width() > width &&
parent.hasClass("mkwsTermlistContainer2")) {
- log("changing from narrow to wide: " + $(window).width());
+ debug("changing from narrow to wide: " + $(window).width());
$(".mkwsTermlistContainer1").show();
$(".mkwsTermlistContainer2").hide();
for (var tname in mkws.teams) {
};
- mkws.showDetails = function (prefixRecId, tname) {
+ mkws.switchView = function(tname, view) {
+ mkws.teams[tname].switchView(view);
+ }
+
+ mkws.showDetails = function (tname, prefixRecId) {
mkws.teams[tname].showDetails(prefixRecId);
}
+ mkws.limitTarget = function (tname, id, name) {
+ mkws.teams[tname].limitTarget(id, name);
+ }
+
+ mkws.limitQuery = function (tname, field, value) {
+ mkws.teams[tname].limitQuery(field, value);
+ }
+
+ mkws.delimitTarget = function (tname, id) {
+ mkws.teams[tname].delimitTarget(id);
+ }
+
+ mkws.delimitQuery = function (tname, field, value) {
+ mkws.teams[tname].delimitQuery(field, value);
+ }
+
+ mkws.showPage = function (tname, pageNum) {
+ mkws.teams[tname].showPage(pageNum);
+ }
+
+ mkws.pagerPrev = function (tname) {
+ mkws.teams[tname].pagerPrev();
+ }
+
+ mkws.pagerNext = function (tname) {
+ mkws.teams[tname].pagerNext();
+ }
+
function default_mkws_config() {
/* default mkws config */
show_sort: true, /* show/hide sort menu */
show_perpage: true, /* show/hide perpage menu */
lang_options: [], /* display languages links for given languages, [] for all */
- facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
+ facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
debug_level: 1, /* debug level for development: 0..2 */
* for the site.
*/
function authenticate_session(auth_url, auth_domain, pp2_url) {
- log("Run service proxy auth URL: " + auth_url);
+ debug("Run service proxy auth URL: " + auth_url);
if (!auth_domain) {
auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
- log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
+ debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
}
var request = new pzHttpRequest(auth_url, function(err) {
return;
}
- log("Service proxy auth successfully done");
+ debug("Service proxy auth successfully done");
mkws.authenticated = true;
run_auto_searches();
});
function run_auto_searches() {
- log("running auto searches");
+ debug("running auto searches");
for (var teamName in mkws.teams) {
- // ### should check mkwsTermlist as well, for facet-only teams
- var node = $('.mkwsRecords.mkwsTeam_' + teamName);
- var query = node.attr('autosearch');
- log("teamName '" + teamName + "', node=" + node + ", class='" + node.className + "', query=" + query);
-
- if (query) {
- var sort = node.attr('sort');
- var targets = node.attr('targets');
- var s = "running auto search: '" + query + "'";
- if (teamName) s += " [teamName '" + teamName + "']";
- if (sort) s += " sorted by '" + sort + "'";
- if (targets) s += " in targets '" + targets + "'";
- log(s);
- var team = mkws.teams[teamName];
- log($.toJSON(team));
- team.newSearch(query, sort, targets, teamName);
- }
+ mkws.teams[teamName].run_auto_search();
}
}
+
+
+ $(document).ready(function() {
+ debug("on load ready");
+ default_mkws_config();
+
+ if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
+ debug("Reset query width: " + mkws_config.query_width);
+ mkws_config.query_width = 50;
+ }
+
+ for (var key in mkws_config) {
+ if (mkws_config.hasOwnProperty(key)) {
+ if (key.match(/^language_/)) {
+ var lang = key.replace(/^language_/, "");
+ // Copy custom languages into list
+ mkws.locale_lang[lang] = mkws_config[key];
+ debug("Added locally configured language '" + lang + "'");
+ }
+ }
+ }
+
+ // 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", "MOTD" ];
+ for (var i = 0; i < ids.length; i++) {
+ var id = 'mkws' + ids[i];
+ var node = $('#' + id);
+ if (node.attr('id')) {
+ node.addClass(id);
+ debug("added magic class to '" + node.attr('id') + "'");
+ }
+ }
+
+ // For all MKWS-classed nodes that don't have a team
+ // specified, set the team to AUTO.
+ $('[class^="mkws"],[class*=" mkws"]').each(function () {
+ if (!this.className.match(/mkwsTeam_/)) {
+ debug("adding AUTO team to node with class '" + this.className + "'");
+ $(this).addClass('mkwsTeam_AUTO');
+ }
+ });
+
+ // Find all nodes with an class, and determine their team from
+ // the mkwsTeam_* class. Make all team objects.
+ var then = $.now();
+ $('[class^="mkws"],[class*=" mkws"]').each(function () {
+ mkws.handle_node_with_team(this, function(tname, type) {
+ if (!mkws.teams[tname]) {
+ mkws.teams[tname] = team(j, tname);
+ debug("Made MKWS team '" + tname + "'");
+ }
+ var myTeam = mkws.teams[tname];
+ var myWidget = widget(j, myTeam, type, this);
+ });
+ });
+ var now = $.now();
+ debug("Walking MKWS nodes took " + (now-then) + " ms");
+
+ if (mkws_config.use_service_proxy) {
+ authenticate_session(mkws_config.service_proxy_auth,
+ mkws_config.service_proxy_auth_domain,
+ mkws_config.pazpar2_url);
+ } else {
+ // raw pp2
+ run_auto_searches();
+ }
+ });
})(jQuery);