X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fmkws.js;h=a886bcf85f3326f0f2b34ee0cd8f29bbe1a1aa32;hb=89522ed15b98ee3d665fef7887b1a9ab87134647;hp=b113625518e61a8566ed784ebf9cf7952cca004d;hpb=84fbbeebeed760bfdd11e2c0ad8fb57b61990fb4;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js
index b113625..a886bcf 100644
--- a/tools/htdocs/mkws.js
+++ b/tools/htdocs/mkws.js
@@ -1,4 +1,7 @@
-/*! 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
@@ -63,19 +66,13 @@ Handlebars.registerHelper('commaList', function(items, options) {
-// 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: {
@@ -83,6 +80,7 @@ var mkws = {
"Authors": "Autoren",
"Subjects": "Schlagwörter",
"Sources": "Daten und Quellen",
+ "source": "datenquelle",
"Termlists": "Termlisten",
"Next": "Weiter",
"Prev": "Zurück",
@@ -96,8 +94,10 @@ var mkws = {
"found": "gefunden",
"Title": "Titel",
"Author": "Autor",
+ "author": "autor",
"Date": "Datum",
"Subject": "Schlagwort",
+ "subject": "schlagwort",
"Location": "Ort",
"Records": "Datensätze",
"Targets": "Datenbanken",
@@ -109,6 +109,7 @@ var mkws = {
"Authors": "Forfattere",
"Subjects": "Emner",
"Sources": "Kilder",
+ "source": "kilder",
"Termlists": "Termlists",
"Next": "Næste",
"Prev": "Forrige",
@@ -122,8 +123,10 @@ var mkws = {
"found": "fandt",
"Title": "Title",
"Author": "Forfatter",
+ "author": "forfatter",
"Date": "Dato",
"Subject": "Emneord",
+ "subject": "emneord",
"Location": "Lokation",
"Records": "Poster",
"Targets": "Baser",
@@ -140,16 +143,23 @@ if (mkws_config == null || typeof mkws_config != 'object') {
}
-// wrapper for jQuery lib
+// 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;
@@ -161,33 +171,14 @@ function team($, teamName) {
var m_paz; // will be initialised below
- // 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;
@@ -225,15 +216,15 @@ function team($, teamName) {
"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);
}
@@ -241,33 +232,29 @@ function team($, teamName) {
// 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 +='
';
- drawPager(pager);
+
+ var pager = $(".mkwsPager.mkwsTeam_" + m_teamName);
+ if (pager.length) {
+ pager.html(drawPager(data))
}
- // navi
var results = $(".mkwsRecords.mkwsTeam_" + m_teamName);
+ if (!results.length)
+ return;
var html = [];
for (var i = 0; i < data.hits.length; i++) {
var hit = data.hits[i];
- html.push('
',
+ html.push('
',
renderSummary(hit),
'
');
if (hit.recid == m_curDetRecId) {
@@ -283,71 +270,75 @@ function team($, teamName) {
{
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 = document.getElementById("mkwsStat");
- if (stat == null)
+ debug("stat");
+ var stat = $('.mkwsStat.mkwsTeam_' + teamName);
+ if (stat.length === 0)
return;
- stat.innerHTML = '' + M('Status info') + '' +
+ stat.html('' + M('Status info') + '' +
' -- ' +
'' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '' +
' -- ' +
- '' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '';
+ '' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '');
}
function my_onterm(data, teamName) {
- debug("term for " + teamName);
- // no facets
+ debug("term");
+ var node = $(".mkwsTermlists.mkwsTeam_" + teamName);
+ 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('
' + M('Termlists') + '
');
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('
');
+ acc.push('
');
acc.push('
' + M(caption) + '
');
for (var i = 0; i < data.length && i < max; i++) {
acc.push('
');
acc.push('' + data[i].name + ''
+ ' ' + data[i].freq + '');
@@ -357,22 +348,33 @@ function team($, teamName) {
}
+ 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);
+ debug("target");
var targetDiv = $('.mkwsBytarget.mkwsTeam_' + teamName);
if (!targetDiv) {
return;
@@ -402,28 +404,6 @@ function team($, teamName) {
////////////////////////////////////////////////////////////////////////////////
- // 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
function onFormSubmitEventHandler()
{
@@ -446,11 +426,11 @@ function team($, teamName) {
}
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;
}
@@ -460,7 +440,7 @@ function team($, teamName) {
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;
}
@@ -516,26 +496,30 @@ function team($, teamName) {
}
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);
+ 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 = $('.mkwsSort.mkwsTeam_' + m_teamName);
+ if (node.length && node.val() != m_sort) {
+ debug("changing m_sort from " + m_sort + " to " + node.val());
+ m_sort = node.val();
+ }
+ node = $('.mkwsPerpage.mkwsTeam_' + m_teamName);
+ 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();
@@ -544,11 +528,11 @@ function team($, teamName) {
}
- // 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();
@@ -557,15 +541,13 @@ function team($, teamName) {
}
- 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));
@@ -582,16 +564,18 @@ function team($, teamName) {
}
- 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);
}
}
@@ -607,7 +591,7 @@ function team($, teamName) {
function redraw_navi ()
{
- var navi = document.getElementById('mkwsNavi');
+ var navi = $('.mkwsNavi.mkwsTeam_' + m_teamName);
if (!navi) return;
var text = "";
@@ -617,24 +601,29 @@ function team($, teamName) {
}
var filter = m_filters[i];
if (filter.id) {
- text += 'Source: ' + filter.name + '';
+ text += M('source') + ': ' + filter.name + '';
} else {
- text += filter.field + ': ' + filter.value + '';
}
}
- navi.innerHTML = text;
+ navi.html(text);
}
- function drawPager (pagerDiv)
+ function drawPager (data)
{
+ var s = '
';
+
//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
@@ -644,9 +633,9 @@ function team($, teamName) {
? firstClkbl + 2*onsides
: pages;
- var prev = '<< ' + M('Prev') + ' | ';
+ var prev = '<< ' + M('Prev') + ' | ';
if (m_curPage > 1)
- prev = ''
+ prev = ''
+'<< ' + M('Prev') + ' | ';
var middle = '';
@@ -655,13 +644,13 @@ function team($, teamName) {
if(i == m_curPage)
numLabel = '' + i + '';
- middle += ' '
+ middle += ' '
+ numLabel + ' ';
}
- var next = ' | ' + M('Next') + ' >>';
+ var next = ' | ' + M('Next') + ' >>';
if (pages - m_curPage > 0)
- next = ' | '
+ next = ' | '
+ M('Next') + ' >>';
var predots = '';
@@ -672,12 +661,14 @@ function team($, teamName) {
if (lastClkbl < pages)
postdots = '...';
- pagerDiv.innerHTML += '
'
+ s += '
'
+ prev + predots + middle + postdots + next + '
';
+
+ return s;
}
- mkws.showPage = function (pageNum)
+ that.showPage = function (pageNum)
{
m_curPage = pageNum;
m_paz.showPage(m_curPage - 1);
@@ -685,28 +676,26 @@ function team($, teamName) {
// 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 = $('.mkwsTargets.mkwsTeam_' + m_teamName);
+ var results = $('.mkwsResults.mkwsTeam_' + m_teamName + ',.mkwsRecords.mkwsTeam_' + m_teamName);
+ var blanket = $('.mkwsBlanket.mkwsTeam_' + m_teamName);
+ var motd = $('.mkwsMOTD.mkwsTeam_' + m_teamName);
switch(view) {
case 'targets':
@@ -722,7 +711,7 @@ function team($, teamName) {
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');
@@ -741,7 +730,7 @@ function team($, teamName) {
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);
@@ -753,6 +742,7 @@ function team($, teamName) {
return;
}
// request the record
+ debug("showDetails() requesting record '" + recId + "'");
m_paz.record(recId);
}
@@ -761,7 +751,7 @@ function team($, teamName) {
{
var template = loadTemplate("Record");
var details = template(data);
- return '
' + details + '
';
+ return '
' + details + '
';
}
@@ -873,8 +863,6 @@ function team($, teamName) {
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) {
@@ -882,8 +870,8 @@ function team($, teamName) {
mkws.handle_node_with_team(node, function(tname) {
$(node).html('\
');
});
});
@@ -902,27 +890,28 @@ function team($, teamName) {
$(".mkwsResults.mkwsTeam_" + m_teamName).html('\
\
\
-
\
- \
+
\
+ \
\
-
\
- \
- \
- \
- \
+
\
+ \
+ \
+ \
+ \
\
\
\
\
- \
+ \
\
\
');
}
- if ($("#mkwsRanking").length) {
+ var node = $(".mkwsRanking.mkwsTeam_" + m_teamName);
+ if (node.length) {
var ranking_data = '';
- ranking_data += '';
- $("#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.
- $(window).resize(function(e) { mkws_resize_page() });
+ $(window).resize(function(e) { mkws.resize_page() });
// initial check after page load
- $(document).ready(function() { mkws_resize_page() });
+ $(document).ready(function() { mkws.resize_page() });
}
- 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);
+ });
+ });
+
+ node = $('.mkwsSort.mkwsTeam_' + m_teamName);
+ if (node.length)
+ node.change(onSelectDdChange);
+ node = $('.mkwsPerpage.mkwsTeam_' + m_teamName);
+ 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() { $(".mkwsTermlists.mkwsTeam_" + m_teamName).hide(); });
+ var motd = $(".mkwsMOTD.mkwsTeam_" + m_teamName);
+ var container = $(".mkwsMOTDContainer.mkwsTeam_" + m_teamName);
+ 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);
}
}
@@ -1004,7 +1007,7 @@ function team($, teamName) {
function mkws_html_sort() {
debug("HTML sort, m_sort = '" + m_sort + "'");
- var sort_html = '