X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fmkws.js;h=adf6f6efe0aa1d167486f3219e31624a09d56f2a;hb=a69a66b88e3317022c375792df0b1c3689431496;hp=dbbc2c598f0fdba3a99a358b829a4a7e3f95dac5;hpb=c5097d60efca95cf757b497eba28171dad109e41;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js
index dbbc2c5..fe29a5e 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
@@ -62,20 +65,19 @@ Handlebars.registerHelper('commaList', function(items, options) {
});
+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 team-name.
+//
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 +85,7 @@ var mkws = {
"Authors": "Autoren",
"Subjects": "Schlagwörter",
"Sources": "Daten und Quellen",
+ "source": "datenquelle",
"Termlists": "Termlisten",
"Next": "Weiter",
"Prev": "Zurück",
@@ -96,8 +99,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 +114,7 @@ var mkws = {
"Authors": "Forfattere",
"Subjects": "Emner",
"Sources": "Kilder",
+ "source": "kilder",
"Termlists": "Termlists",
"Next": "Næste",
"Prev": "Forrige",
@@ -122,8 +128,10 @@ var mkws = {
"found": "fandt",
"Title": "Title",
"Author": "Forfatter",
+ "author": "forfatter",
"Date": "Dato",
"Subject": "Emneord",
+ "subject": "emneord",
"Location": "Lokation",
"Records": "Poster",
"Targets": "Baser",
@@ -134,22 +142,67 @@ var mkws = {
};
+// 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;
@@ -159,284 +212,215 @@ function team($, teamName) {
"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;
- debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
- }
+ m_perpage = mkws_config.perpage_default;
debug("Create main pz2 object");
// 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
- m_paz = new pz2({ "onshow": my_onshow,
- "windowid": teamName,
- "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
+ m_paz = new pz2({ "windowid": teamName,
"pazpar2path": mkws_config.pazpar2_url,
- "oninit": my_oninit,
- "onstat": my_onstat,
- "onterm": my_onterm,
- "termlist": "xtargets,subject,author",
- "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);
- }
+ "oninit": onInit,
+ "onbytarget": onBytarget,
+ "onstat": onStat,
+ "onterm": (mkws_config.facets.length ? onTerm : undefined),
+ "onshow": onShow,
+ "onrecord": onRecord,
+ "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
+ "termlist": mkws_config.facets.join(',')
+ });
//
// pz2.js event handlers:
//
- function my_oninit(teamName) {
- debug("init for " + teamName);
+ function onInit(teamName) {
+ debug("init");
m_paz.stat();
m_paz.bytarget();
}
- function my_onshow(data, teamName) {
- debug("show for " + teamName);
- m_totalRec = data.merged;
- // move it out
- var pager = document.getElementById("mkwsPager");
- if (pager) {
- pager.innerHTML = "";
- pager.innerHTML +='
';
+
//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 +636,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 +647,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 +664,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 +679,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');
+ function switchView(view) {
+ var targets = findnode('.mkwsTargets');
+ var results = findnode('.mkwsResults,.mkwsRecords');
+ var blanket = findnode('.mkwsBlanket');
+ var motd = findnode('.mkwsMOTD');
switch(view) {
case 'targets':
@@ -722,7 +714,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');
@@ -734,6 +726,9 @@ function team($, teamName) {
}
+ that.switchView = switchView;
+
+
// detailed record drawing
that.showDetails = function (prefixRecId) {
var recId = prefixRecId.replace('mkwsRec_', '');
@@ -741,7 +736,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,225 +748,101 @@ function team($, teamName) {
return;
}
// request the record
+ debug("showDetails() requesting record '" + recId + "'");
m_paz.record(recId);
}
- function renderDetails(data, marker)
- {
- var template = loadTemplate("Record");
- var details = template(data);
- return '
' + details + '
';
- }
+ /*
+ * All the HTML stuff to render the search forms and
+ * result pages.
+ */
+ function mkwsHtmlAll() {
+ mkwsSetLang();
+ if (mkws_config.show_lang)
+ mkwsHtmlLang();
+ debug("HTML search form");
+ mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
+ this.html('\
+');
+ });
- function loadTemplate(name)
- {
- var template = mkws['template' + name];
+ debug("HTML records");
+ // If the team has a .mkwsResults, populate it in the usual
+ // way. If not, assume that it's a smarter application that
+ // defines its own subcomponents, some or all of the
+ // following:
+ // .mkwsTermlists
+ // .mkwsRanking
+ // .mkwsPager
+ // .mkwsNavi
+ // .mkwsRecords
+ if (findnode(".mkwsResults").length) {
+ findnode(".mkwsResults").html('\
+
\
+
\
+
\
+ \
+
\
+
\
+ \
+ \
+ \
+ \
+
\
+
\
+
\
+
\
+ \
+
\
+
\
+
');
+ }
- if (template === undefined) {
- var source = $("#mkwsTemplate" + name).html();
- if (!source) {
- source = defaultTemplate(name);
+ var node = findnode(".mkwsRanking");
+ if (node.length) {
+ var ranking_data = '';
+ ranking_data += '';
- template = Handlebars.compile(source);
- debug("compiled template '" + name + "'");
- mkws['template' + name] = template;
+ node.html(ranking_data);
}
- return template;
+ mkwsHtmlSwitch();
+
+ 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() { 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.appendTo(container);
+ }
}
- function defaultTemplate(name)
- {
- if (name === 'Record') {
- return '\
-
\
-';
- } else if (name === "Summary") {
- return '\
-\
- {{md-title}}\
-\
-{{#if md-title-remainder}}\
- {{md-title-remainder}}\
-{{/if}}\
-{{#if md-title-responsibility}}\
- {{md-title-responsibility}}\
-{{/if}}\
-';
- }
-
- var s = "There is no default '" + name +"' template!";
- alert(s);
- return s;
- }
-
-
- /*
- * All the HTML stuff to render the search forms and
- * result pages.
- */
- 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('\
-');
- });
- });
-
- debug("HTML records");
- // If the team has a .mkwsResults, populate it in the usual
- // way. If not, assume that it's a smarter application that
- // defines its own subcomponents, some or all of the
- // following:
- // .mkwsTermlists
- // .mkwsRanking
- // .mkwsPager
- // .mkwsNavi
- // .mkwsRecords
- if ($(".mkwsResults.mkwsTeam_" + m_teamName).length) {
- $(".mkwsResults.mkwsTeam_" + m_teamName).html('\
-
\
-
\
-
\
- \
-
\
-
\
- \
- \
- \
- \
-
\
-
\
-
\
-
\
- \
-
\
-
\
-
');
- }
-
- if ($("#mkwsRanking").length) {
- var ranking_data = '';
- ranking_data += '';
-
- $("#mkwsRanking").html(ranking_data);
- }
-
- mkws_html_switch();
-
- 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() });
- // initial check after page load
- $(document).ready(function() { mkws_resize_page() });
- }
-
- domReady();
-
- // on first page, hide the termlist
- $(document).ready(function() { $("#mkwsTermlists").hide(); });
- var motd = document.getElementById("mkwsMOTD");
- var container = document.getElementById("mkwsMOTDContainer");
- if (motd && container) {
- // Move the MOTD from the provided element down into the container
- motd.parentNode.removeChild(motd);
- container.appendChild(motd);
- }
- }
-
-
- // implement $.parseQuerystring() for parsing URL parameters
- function parseQuerystring() {
- var nvpair = {};
- var qs = window.location.search.replace('?', '');
- var pairs = qs.split('&');
- $.each(pairs, function(i, v){
- var pair = v.split('=');
- nvpair[pair[0]] = pair[1];
- });
- return nvpair;
- }
-
-
- function mkws_set_lang() {
+ function mkwsSetLang() {
var lang = parseQuerystring().lang || mkws_config.lang;
if (!lang || !mkws.locale_lang[lang]) {
mkws_config.lang = ""
@@ -984,16 +855,16 @@ function team($, teamName) {
}
- function mkws_html_switch() {
+ function mkwsHtmlSwitch() {
debug("HTML switch for team " + m_teamName);
- var node = $(".mkwsSwitch.mkwsTeam_" + m_teamName);
+ var node = findnode(".mkwsSwitch");
node.append($('' + M('Records') + ''));
node.append($("", { text: " | " }));
node.append($('' + M('Targets') + ''));
debug("HTML targets");
- var node = $(".mkwsTargets.mkwsTeam_" + m_teamName);
+ var node = findnode(".mkwsTargets");
node.html('\
\
No information available yet.\
@@ -1002,9 +873,9 @@ function team($, teamName) {
}
- function mkws_html_sort() {
+ function mkwsHtmlSort() {
debug("HTML sort, m_sort = '" + m_sort + "'");
- var sort_html = '