X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=tools%2Fhtdocs%2Fmkws.js;h=6d03d07296f656ed3a390e2e91f2f047b7b18536;hp=a1f6f70ad699f4beb5da1fc2958e3bdf91a98027;hb=2681321da7a6c02655b92fc46832c5d80f90e6c1;hpb=3bbd3c45974c67fff9075cfe3b3372864f57a5f5 diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js index a1f6f70..6d03d07 100644 --- a/tools/htdocs/mkws.js +++ b/tools/htdocs/mkws.js @@ -72,7 +72,7 @@ Handlebars.registerHelper('index1', function(obj) { // Set up global mkws object. Contains truly global state such as SP -// authentication, and a hash of team objects, indexed by windowid. +// authentication, and a hash of team objects, indexed by team-name. // var mkws = { authenticated: false, @@ -142,29 +142,6 @@ 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 = {}; @@ -179,10 +156,244 @@ function widget($, team, type, node) { node: node }; - // ### More to do here, surely: e.g. wiring into the team - mkws.debug("made widget(team=" + team + ", type=" + type + ", node=" + node); + var M = mkws.M; + + var type2fn = { + Targets: promoteTargets, + Stat: promoteStat, + Termlists: promoteTermlists, + Pager: promotePager, + Records: promoteRecords, + Navi: promoteNavi + }; + + var promote = type2fn[type]; + if (promote) { + promote(); + team.debug("made " + type + " widget(node=" + node + ")"); + } else { + team.debug("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")"); + } return that; + + + // Functions follow for promoting the regular widget object into + // widgets of specific types. These could be moved outside of the + // widget object, or even into their own source files. + + function promoteTargets() { + team.queue("targets").subscribe(function(data) { + var table ='' + + '' + + '' + + '' + + '' + + '' + + ''; + + for (var i = 0; i < data.length; i++) { + table += ""; + } + + table += '
' + M('Target ID') + '' + M('Hits') + '' + M('Diags') + '' + M('Records') + '' + M('State') + '
" + data[i].id + + "" + data[i].hits + + "" + data[i].diagnostic + + "" + data[i].records + + "" + data[i].state + "
'; + var subnode = $(node).children('.mkwsBytarget'); + subnode.html(table); + }); + } + + + function promoteStat() { + team.queue("stat").subscribe(function(data) { + if (node.length === 0) alert("huh?!"); + + $(node).html('' + M('Status info') + '' + + ' -- ' + + '' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '' + + ' -- ' + + '' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + ''); + }); + } + + + function promoteTermlists() { + team.queue("termlists").subscribe(function(data) { + mkws.debug("in termlist consumer"); + if (!node) { + alert("termlists event when there are no termlists"); + return; + } + + // no facets: this should never happen + if (!mkws_config.facets || mkws_config.facets.length == 0) { + alert("onTerm called even though we have no facets: " + $.toJSON(data)); + $(node).hide(); + return; + } + + // display if we first got results + $(node).show(); + + var acc = []; + acc.push('
' + M('Termlists') + '
'); + var facets = mkws_config.facets; + + for (var i = 0; i < facets.length; i++) { + if (facets[i] == "xtargets") { + addSingleFacet(acc, "Sources", data.xtargets, 16, null); + } else if (facets[i] == "subject") { + addSingleFacet(acc, "Subjects", data.subject, 10, "subject"); + } else if (facets[i] == "author") { + addSingleFacet(acc, "Authors", data.author, 10, "author"); + } else { + alert("bad facet configuration: '" + facets[i] + "'"); + } + } + + $(node).html(acc.join('')); + + function addSingleFacet(acc, caption, data, max, pzIndex) { + 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 + ''); + acc.push('
'); + } + acc.push('
'); + } + }); + } + + + function promotePager() { + team.queue("pager").subscribe(function(data) { + $(node).html(drawPager(data)) + + function drawPager(data) { + var s = '
' + M('Displaying') + ': ' + + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) + + ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': ' + + data.total + ')
'; + + //client indexes pages from 1 but pz2 from 0 + var onsides = 6; + var pages = Math.ceil(team.totalRecordCount() / team.perpage()); + var currentPage = team.currentPage(); + + var firstClkbl = (currentPage - onsides > 0) + ? currentPage - onsides + : 1; + + var lastClkbl = firstClkbl + 2*onsides < pages + ? firstClkbl + 2*onsides + : pages; + + var prev = '<< ' + M('Prev') + ' | '; + if (currentPage > 1) + prev = '' + +'<< ' + M('Prev') + ' | '; + + var middle = ''; + for(var i = firstClkbl; i <= lastClkbl; i++) { + var numLabel = i; + if(i == currentPage) + numLabel = '' + i + ''; + + middle += ' ' + + numLabel + ' '; + } + + var next = ' | ' + M('Next') + ' >>'; + if (pages - currentPage > 0) + next = ' | ' + + M('Next') + ' >>'; + + var predots = ''; + if (firstClkbl > 1) + predots = '...'; + + var postdots = ''; + if (lastClkbl < pages) + postdots = '...'; + + s += '
' + + prev + predots + middle + postdots + next + '
'; + + return s; + } + }); + } + + + function promoteRecords() { + team.queue("records").subscribe(function(data) { + var html = []; + for (var i = 0; i < data.hits.length; i++) { + var hit = data.hits[i]; + html.push('
', + renderSummary(hit), + '
'); + // ### At some point, we may be able to move the + // m_currentRecordId and m_currentRecordData members + // from the team object into this widget. + if (hit.recid == team.currentRecordId()) { + if (team.currentRecordData()) + html.push(team.renderDetails(team.currentRecordData())); + } + } + $(node).html(html.join('')); + + function renderSummary(hit) + { + var template = team.loadTemplate("Summary"); + hit._id = "mkwsRec_" + hit.recid; + hit._onclick = "mkws.showDetails('" + team.name() + "', this.id);return false;" + return template(hit); + } + }); + } + + + function promoteNavi() { + team.queue("navi").subscribe(function() { + var filters = team.filters(); + var text = ""; + + for (var i in filters) { + if (text) { + text += " | "; + } + var filter = filters[i]; + if (filter.id) { + text += M('source') + ': ' + filter.name + ''; + } else { + text += M(filter.field) + ': ' + filter.value + ''; + } + } + + $(node).html(text); + }); + } } @@ -199,14 +410,14 @@ function team($, teamName) { var m_teamName = teamName; var m_submitted = false; var m_query; // initially undefined - var m_sort; // will be set below + var m_sortOrder; // will be set below var m_perpage; // will be set below var m_filters = []; - var m_totalRec = 0; - var m_curPage = 1; - var m_curDetRecId = ''; - var m_curDetRecData = null; - var m_debug_time = { + var m_totalRecordCount = 0; + var m_currentPage = 1; + var m_currentRecordId = ''; + var m_currentRecordData = null; + var m_debugTime = { // Timestamps for logging "start": $.now(), "last": $.now() @@ -214,202 +425,98 @@ function team($, teamName) { var m_paz; // will be initialised below var m_template = {}; + that.name = function() { return m_teamName; } + that.perpage = function() { return m_perpage; } + that.totalRecordCount = function() { return m_totalRecordCount; } + that.currentPage = function() { return m_currentPage; } + that.currentRecordId = function() { return m_currentRecordId; } + that.currentRecordData = function() { return m_currentRecordData; } + that.filters = function() { return m_filters; } 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; + var timestamp = ((now - m_debugTime.start)/1000).toFixed(3) + " (+" + ((now - m_debugTime.last)/1000).toFixed(3) + ") " + m_debugTime.last = now; mkws.debug(m_teamName + ": " + timestamp + s); } + that.debug = debug; debug("start running MKWS"); - m_sort = mkws_config.sort_default; - debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to m_sort"); - - // ### should be in global code - if (mkws_config.query_width < 5 || mkws_config.query_width > 150) { - debug("Reset query width: " + mkws_config.query_width); - mkws_config.query_width = 50; - } - - // ### should be in global code - 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_sortOrder = mkws_config.sort_default; + 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": (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_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); - } + "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) { + function onInit() { debug("init"); m_paz.stat(); m_paz.bytarget(); } - function my_onshow(data, teamName) { - debug("show"); - m_totalRec = data.merged; - - var pager = findnode(".mkwsPager"); - if (pager.length) { - pager.html(drawPager(data)) - } - - 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('
', - renderSummary(hit), - '
'); - if (hit.recid == m_curDetRecId) { - if (m_curDetRecData) - html.push(renderDetails(m_curDetRecData)); - } - } - results.html(html.join('')); - } - - - function renderSummary(hit) - { - var template = loadTemplate("Summary"); - hit._id = "mkwsRec_" + hit.recid; - hit._onclick = "mkws.showDetails('" + m_teamName + "', this.id);return false;" - return template(hit); + function onBytarget(data) { + debug("target"); + queue("targets").publish(data); } - function my_onstat(data, teamName) { + function onStat(data) { debug("stat"); - var stat = findnode('.mkwsStat'); - if (stat.length === 0) - return; - - stat.html('' + M('Status info') + '' + - ' -- ' + - '' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '' + - ' -- ' + - '' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + ''); + queue("stat").publish(data); } - function my_onterm(data, teamName) { + function onTerm(data) { 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) { - alert("my_onterm called even though we have no facets: " + $.toJSON(data)); - node.hide(); - return; - } - - // display if we first got results - node.show(); - - var acc = []; - acc.push('
' + M('Termlists') + '
'); - var facets = mkws_config.facets; + queue("termlists").publish(data); + } - for(var i = 0; i < facets.length; i++) { - if (facets[i] == "xtargets") { - add_single_facet(acc, "Sources", data.xtargets, 16, null); - } else if (facets[i] == "subject") { - add_single_facet(acc, "Subjects", data.subject, 10, "subject"); - } else if (facets[i] == "author") { - add_single_facet(acc, "Authors", data.author, 10, "author"); - } else { - alert("bad facet configuration: '" + facets[i] + "'"); - } - } - node.html(acc.join('')); + function onShow(data, teamName) { + debug("show"); + m_totalRecordCount = data.merged; + queue("pager").publish(data); + queue("records").publish(data); } - function add_single_facet(acc, caption, data, max, pzIndex) { - 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 + ''); - acc.push('
'); - } - acc.push('
'); + function onRecord(data, args, teamName) { + debug("record"); + // FIXME: record is async!! + clearTimeout(m_paz.recordTimer); + // in case on_show was faster to redraw element + var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid); + if (detRecordDiv) return; + m_currentRecordData = data; + // Can't use jQuery's $('#x') syntax to find this ID, because it contains spaces. + var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_currentRecordData.recid); + var html = renderDetails(m_currentRecordData); + $(recordDiv).append(html); } - function target_filtered(id) { + that.targetFiltered = function(id) { for (var i = 0; i < m_filters.length; i++) { if (m_filters[i].id === id || m_filters[i].id === 'pz:id=' + id) { @@ -420,67 +527,20 @@ function team($, teamName) { } - function my_onrecord(data, args, 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_' + teamName + '_' + data.recid); - if (detRecordDiv) return; - m_curDetRecData = data; - var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_curDetRecData.recid); - var html = renderDetails(m_curDetRecData); - recordDiv.innerHTML += html; - } - - - function my_onbytarget(data, teamName) { - debug("target"); - var targetDiv = findnode('.mkwsBytarget'); - if (!targetDiv) { - return; - } - - var table ='' + - '' + - '' + - '' + - '' + - '' + - ''; - - for (var i = 0; i < data.length; i++) { - table += ""; - } - - table += '
' + M('Target ID') + '' + M('Hits') + '' + M('Diags') + '' + M('Records') + '' + M('State') + '
" + data[i].id + - "" + data[i].hits + - "" + data[i].diagnostic + - "" + data[i].records + - "" + data[i].state + "
'; - targetDiv.html(table); - } - //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// // 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 = findnode('.mkwsQuery').val(); - mkws.teams[tname].newSearch(val); - }); - + var val = findnode('.mkwsQuery').val(); + newSearch(val); return false; } - // ### won't need to be externally visible once onFormSubmitEventHandler() is fixed. - // ### doesn't need windowid - that.newSearch = function(query, sort, targets, windowid) + function newSearch(query, sortOrder, targets) { debug("newSearch: " + query); @@ -490,47 +550,55 @@ function team($, teamName) { } m_filters = [] - redraw_navi(); - resetPage(); - loadSelect(); - triggerSearch(query, sort, targets, windowid); - that.switchView('records'); // In case it's configured to start off as hidden + triggerSearch(query, sortOrder, targets); + switchView('records'); // In case it's configured to start off as hidden m_submitted = true; } - function onSelectDdChange() + function onSortChange() { + m_sortOrder = findnode('.mkwsSort').val(); if (!m_submitted) return false; resetPage(); - loadSelect(); - m_paz.show(0, m_perpage, m_sort); + m_paz.show(0, m_perpage, m_sortOrder); + return false; + } + + + function onPerpageChange() + { + m_perpage = findnode('.mkwsPerpage').val(); + if (!m_submitted) return false; + resetPage(); + m_paz.show(0, m_perpage, m_sortOrder); return false; } function resetPage() { - m_curPage = 1; - m_totalRec = 0; + m_currentPage = 1; + m_totalRecordCount = 0; } - // ### doesn't need windowid - function triggerSearch (query, sort, targets, windowid) + function triggerSearch (query, sortOrder, targets) { + resetPage(); + queue("navi").publish(); + var pp2filter = ""; var pp2limit = ""; - // Re-use previous query/sort if new ones are not specified + // Continue to use previous query/sort-order unless new ones are specified if (query) { m_query = query; } - if (sort) { - m_sort = sort; + if (sortOrder) { + m_sortOrder = sortOrder; } if (targets) { - // ### should support multiple |-separated targets m_filters.push({ id: targets, name: targets }); } @@ -556,29 +624,12 @@ function team($, teamName) { if (pp2limit) { params.limit = pp2limit; } - if (windowid) { - params.windowid = windowid; - } + debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(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 () - { - 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(); - } + m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params); } @@ -587,9 +638,6 @@ function team($, teamName) { { debug("limitTarget(id=" + id + ", name=" + name + ")"); m_filters.push({ id: id, name: name }); - redraw_navi(); - resetPage(); - loadSelect(); triggerSearch(); return false; } @@ -600,9 +648,6 @@ function team($, teamName) { { debug("limitQuery(field=" + field + ", value=" + value + ")"); m_filters.push({ field: field, value: value }); - redraw_navi(); - resetPage(); - loadSelect(); triggerSearch(); return false; } @@ -623,9 +668,6 @@ function team($, teamName) { } m_filters = newFilters; - redraw_navi(); - resetPage(); - loadSelect(); triggerSearch(); return false; } @@ -648,117 +690,35 @@ function team($, teamName) { } m_filters = newFilters; - redraw_navi(); - resetPage(); - loadSelect(); triggerSearch(); return false; } - function redraw_navi () - { - var navi = findnode('.mkwsNavi'); - if (!navi) return; - - var text = ""; - for (var i in m_filters) { - if (text) { - text += " | "; - } - var filter = m_filters[i]; - if (filter.id) { - text += M('source') + ': ' + filter.name + ''; - } else { - text += M(filter.field) + ': ' + filter.value + ''; - } - } - - navi.html(text); - } - - - function drawPager (data) - { - var s = '
' + M('Displaying') + ': ' - + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) + - ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': ' - + data.total + ')
'; - - //client indexes pages from 1 but pz2 from 0 - var onsides = 6; - var pages = Math.ceil(m_totalRec / m_perpage); - - var firstClkbl = (m_curPage - onsides > 0) - ? m_curPage - onsides - : 1; - - var lastClkbl = firstClkbl + 2*onsides < pages - ? firstClkbl + 2*onsides - : pages; - - var prev = '<< ' + M('Prev') + ' | '; - if (m_curPage > 1) - prev = '' - +'<< ' + M('Prev') + ' | '; - - var middle = ''; - for(var i = firstClkbl; i <= lastClkbl; i++) { - var numLabel = i; - if(i == m_curPage) - numLabel = '' + i + ''; - - middle += ' ' - + numLabel + ' '; - } - - var next = ' | ' + M('Next') + ' >>'; - if (pages - m_curPage > 0) - next = ' | ' - + M('Next') + ' >>'; - - var predots = ''; - if (firstClkbl > 1) - predots = '...'; - - var postdots = ''; - if (lastClkbl < pages) - postdots = '...'; - - s += '
' - + prev + predots + middle + postdots + next + '
'; - - return s; - } - - that.showPage = function (pageNum) { - m_curPage = pageNum; - m_paz.showPage(m_curPage - 1); + m_currentPage = pageNum; + m_paz.showPage(m_currentPage - 1); } // simple paging functions that.pagerNext = function () { - if (m_totalRec - m_perpage*m_curPage > 0) { + if (m_totalRecordCount - m_perpage*m_currentPage > 0) { m_paz.showNext(); - m_curPage++; + m_currentPage++; } } that.pagerPrev = function () { if (m_paz.showPrev() != false) - m_curPage--; + m_currentPage--; } // switching view between targets and records - that.switchView = function(view) { + function switchView(view) { var targets = findnode('.mkwsTargets'); var results = findnode('.mkwsResults,.mkwsRecords'); var blanket = findnode('.mkwsBlanket'); @@ -790,22 +750,25 @@ function team($, teamName) { } + that.switchView = switchView; + + // detailed record drawing that.showDetails = function (prefixRecId) { var recId = prefixRecId.replace('mkwsRec_', ''); - var oldRecId = m_curDetRecId; - m_curDetRecId = recId; + var oldRecordId = m_currentRecordId; + m_currentRecordId = recId; // remove current detailed view if any - var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecId); + var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecordId); // lovin DOM! if (detRecordDiv) detRecordDiv.parentNode.removeChild(detRecordDiv); // if the same clicked, just hide - if (recId == oldRecId) { - m_curDetRecId = ''; - m_curDetRecData = null; + if (recId == oldRecordId) { + m_currentRecordId = ''; + m_currentRecordData = null; return; } // request the record @@ -814,132 +777,17 @@ function team($, teamName) { } - function renderDetails(data, marker) - { - var template = loadTemplate("Record"); - var details = template(data); - return '
' + details + '
'; - } - - - function loadTemplate(name) - { - var template = m_template[name]; - - if (template === undefined) { - // 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 + "'"); - m_template[name] = template; - } - - return template; - } - - - function defaultTemplate(name) - { - if (name === 'Record') { - return '\ -\ - \ - \ - \ - \ - {{#if md-date}}\ - \ - \ - \ - \ - {{/if}}\ - {{#if md-author}}\ - \ - \ - \ - \ - {{/if}}\ - {{#if md-electronic-url}}\ - \ - \ - \ - \ - {{/if}}\ - {{#if-any location having="md-subject"}}\ - \ - \ - \ - \ - {{/if-any}}\ - \ - \ - \ - \ -
{{translate "Title"}}\ - {{md-title}}\ - {{#if md-title-remainder}}\ - ({{md-title-remainder}})\ - {{/if}}\ - {{#if md-title-responsibility}}\ - {{md-title-responsibility}}\ - {{/if}}\ -
{{translate "Date"}}{{md-date}}
{{translate "Author"}}{{md-author}}
{{translate "Links"}}\ - {{#each md-electronic-url}}\ - Link{{index1}}\ - {{/each}}\ -
{{translate "Subject"}}\ - {{#first location having="md-subject"}}\ - {{#if md-subject}}\ - {{#commaList md-subject}}\ - {{this}}{{/commaList}}\ - {{/if}}\ - {{/first}}\ -
{{translate "Locations"}}\ - {{#commaList location}}\ - {{attr "@name"}}{{/commaList}}\ -
\ -'; - } 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. */ - // ### This and other multi-word identifiers should be camelCase - function mkws_html_all() { - mkws_set_lang(); + function mkwsHtmlAll() { + mkwsSetLang(); if (mkws_config.show_lang) - mkws_html_lang(); + mkwsHtmlLang(); debug("HTML search form"); - mkws.handle_node_with_team(findnode('.mkwsSearch'), function(tname) { + mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) { this.html('\
\ \ @@ -981,29 +829,19 @@ function team($, teamName) { var node = findnode(".mkwsRanking"); if (node.length) { - var ranking_data = ''; - ranking_data += ''; + var ranking_data = ''; if (mkws_config.show_sort) { - ranking_data += M('Sort by') + ' ' + mkws_html_sort() + ' '; + ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' '; } if (mkws_config.show_perpage) { - ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.'; + ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.'; } 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() }); - // initial check after page load - $(document).ready(function() { mkws.resize_page() }); - } + mkwsHtmlSwitch(); var node; node = findnode('.mkwsSearchForm'); @@ -1011,108 +849,37 @@ function team($, teamName) { 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); - } - } - - - // 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() { - var lang = parseQuerystring().lang || mkws_config.lang; - if (!lang || !mkws.locale_lang[lang]) { - mkws_config.lang = "" - } else { - mkws_config.lang = lang; - } - - debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none")); - return mkws_config.lang; - } - - - function mkws_html_switch() { - debug("HTML switch for team " + m_teamName); - - var node = findnode(".mkwsSwitch"); - node.append($('' + M('Records') + '')); - node.append($("", { text: " | " })); - node.append($('' + M('Targets') + '')); - - debug("HTML targets"); - var node = findnode(".mkwsTargets"); - node.html('\ -
\ - No information available yet.\ -
'); - node.css("display", "none"); - } - - - function mkws_html_sort() { - debug("HTML sort, m_sort = '" + m_sort + "'"); - var sort_html = ''; - - return sort_html; } - function mkws_html_perpage() { - debug("HTML perpage, m_perpage = " + m_perpage); - var perpage_html = ''; - return perpage_html; + debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none")); + return mkws_config.lang; } /* create locale language menu */ - function mkws_html_lang() { + function mkwsHtmlLang() { var lang_default = "en"; var lang = mkws_config.lang || lang_default; var list = []; @@ -1154,16 +921,73 @@ function team($, teamName) { } - that.run_auto_search = function() { - // ### should check mkwsTermlist as well, for facet-only teams - var node = findnode('.mkwsRecords'); + function mkwsHtmlSort() { + debug("HTML sort, m_sortOrder = '" + m_sortOrder + "'"); + var sort_html = ''; + + return sort_html; + } + + + function mkwsHtmlPerpage() { + debug("HTML perpage, m_perpage = " + m_perpage); + var perpage_html = ''; + + return perpage_html; + } + + + function mkwsHtmlSwitch() { + debug("HTML switch for team " + m_teamName); + + var node = findnode(".mkwsSwitch"); + node.append($('' + M('Records') + '')); + node.append($("", { text: " | " })); + node.append($('' + M('Targets') + '')); + + debug("HTML targets"); + var node = findnode(".mkwsTargets"); + node.html('\ +
\ + No information available yet.\ +
'); + node.css("display", "none"); + } + + + that.runAutoSearch = function() { + var node = findnode('.mkwsRecords,.mkwsTermlists'); var query = node.attr('autosearch'); if (!query) return; if (query.match(/^!param!/)) { var param = query.replace(/^!param!/, ''); - query = getParameterByName(param); + query = mkws.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"); @@ -1180,29 +1004,22 @@ function team($, teamName) { debug("node=" + node + ", class='" + node.className + "', query=" + query); - var sort = node.attr('sort'); + var sortOrder = node.attr('sort'); var targets = node.attr('targets'); var s = "running auto search: '" + query + "'"; - if (sort) s += " sorted by '" + sort + "'"; + if (sortOrder) s += " sorted by '" + sortOrder + "'"; 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, " ")); + newSearch(query, sortOrder, targets); } - /* locale */ + // Translation function. At present, this is properly a + // global-level function (hence the assignment to mkws.M) but we + // want to make it per-team so different teams can operate in + // different languages. + // function M(word) { var lang = mkws_config.lang; @@ -1214,10 +1031,83 @@ function team($, teamName) { mkws.M = M; // so the Handlebars helper can use it + // 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 = $.map(selector.split(','), function(s, i) { + return s + '.mkwsTeam_' + teamName; + }).join(','); + + return $(selector); + } + + + function renderDetails(data, marker) + { + var template = loadTemplate("Record"); + var details = template(data); + return '
' + details + '
'; + } + that.renderDetails = renderDetails; + + + function loadTemplate(name) + { + var template = m_template[name]; + + if (template === undefined) { + // 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 = mkws.defaultTemplate(name); + } + + template = Handlebars.compile(source); + debug("compiled template '" + name + "'"); + m_template[name] = template; + } + + return template; + } + that.loadTemplate = loadTemplate; + + + // The following PubSub code is modified from the jQuery manual: + // https://api.jquery.com/jQuery.Callbacks/ + // + // Use as: + // team.queue("eventName").subscribe(function(param1, param2 ...) { ... }); + // team.queue("eventName").publish(arg1, arg2, ...); + + var queues = {}; + var queue = function(id) { + if (!queues[id]) { + var callbacks = $.Callbacks(); + queues[id] = { + publish: callbacks.fire, + subscribe: callbacks.add, + unsubscribe: callbacks.remove + }; + } + return queues[id]; + } + + that.queue = queue; + + // main (function() { try { - mkws_html_all() + mkwsHtmlAll() } catch (e) { @@ -1253,7 +1143,7 @@ function team($, teamName) { var debug = mkws.debug; - mkws.handle_node_with_team = function(node, callback) { + mkws.handleNodeWithTeam = function(node, callback) { // First branch for DOM objects; second branch for jQuery objects var classes = node.className || node.attr('class'); if (!classes) { @@ -1261,7 +1151,7 @@ function team($, teamName) { // 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"); + mkws.debug("handleNodeWithTeam() called on node with no classes"); return; } var list = classes.split(/\s+/) @@ -1279,7 +1169,7 @@ function team($, teamName) { } - mkws.resize_page = function () { + mkws.resizePage = function () { var list = ["mkwsSwitch", "mkwsLang"]; var width = mkws_config.responsive_design_width; @@ -1348,7 +1238,98 @@ function team($, teamName) { } - function default_mkws_config() { + // This function is taken from a StackOverflow answer + // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144 + mkws.getParameterByName = function(name) { + name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]"); + var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"), + results = regex.exec(location.search); + return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " ")); + } + + + mkws.defaultTemplate = function(name) + { + if (name === 'Record') { + return '\ +\ + \ + \ + \ + \ + {{#if md-date}}\ + \ + \ + \ + \ + {{/if}}\ + {{#if md-author}}\ + \ + \ + \ + \ + {{/if}}\ + {{#if md-electronic-url}}\ + \ + \ + \ + \ + {{/if}}\ + {{#if-any location having="md-subject"}}\ + \ + \ + \ + \ + {{/if-any}}\ + \ + \ + \ + \ +
{{translate "Title"}}\ + {{md-title}}\ + {{#if md-title-remainder}}\ + ({{md-title-remainder}})\ + {{/if}}\ + {{#if md-title-responsibility}}\ + {{md-title-responsibility}}\ + {{/if}}\ +
{{translate "Date"}}{{md-date}}
{{translate "Author"}}{{md-author}}
{{translate "Links"}}\ + {{#each md-electronic-url}}\ + Link{{index1}}\ + {{/each}}\ +
{{translate "Subject"}}\ + {{#first location having="md-subject"}}\ + {{#if md-subject}}\ + {{#commaList md-subject}}\ + {{this}}{{/commaList}}\ + {{/if}}\ + {{/first}}\ +
{{translate "Locations"}}\ + {{#commaList location}}\ + {{attr "@name"}}{{/commaList}}\ +
\ +'; + } 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; + } + + + function defaultMkwsConfig() { /* default mkws config */ var config_default = { use_service_proxy: true, @@ -1398,7 +1379,7 @@ function team($, teamName) { * The username/password is configured in the apache config file * for the site. */ - function authenticate_session(auth_url, auth_domain, pp2_url) { + function authenticateSession(auth_url, auth_domain, pp2_url) { debug("Run service proxy auth URL: " + auth_url); if (!auth_domain) { @@ -1424,23 +1405,53 @@ function team($, teamName) { debug("Service proxy auth successfully done"); mkws.authenticated = true; - run_auto_searches(); + runAutoSearches(); }); } - function run_auto_searches() { + function runAutoSearches() { debug("running auto searches"); for (var teamName in mkws.teams) { - mkws.teams[teamName].run_auto_search(); + mkws.teams[teamName].runAutoSearch(); } } $(document).ready(function() { debug("on load ready"); - default_mkws_config(); + defaultMkwsConfig(); + + 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 + "'"); + } + } + } + + 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.resizePage() }); + // initial check after page load + $(document).ready(function() { mkws.resizePage() }); + } + + // 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); + } // Backwards compatibility: set new magic class names on any // elements that have the old magic IDs. @@ -1465,15 +1476,23 @@ function team($, teamName) { } }); - // Find all nodes with an class, and determine their team from + // Find all nodes with an MKWS 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) { + mkws.handleNodeWithTeam(this, function(tname, type) { if (!mkws.teams[tname]) { mkws.teams[tname] = team(j, tname); debug("Made MKWS team '" + tname + "'"); } + }); + }); + // Second pass: make the individual widget objects. This has + // to be done separately, and after the team-creation, since + // that sometimes makes new widget nodes (e.g. creating + // mkwsTermlists inside mkwsResults. + $('[class^="mkws"],[class*=" mkws"]').each(function () { + mkws.handleNodeWithTeam(this, function(tname, type) { var myTeam = mkws.teams[tname]; var myWidget = widget(j, myTeam, type, this); }); @@ -1482,12 +1501,12 @@ function team($, teamName) { 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); + authenticateSession(mkws_config.service_proxy_auth, + mkws_config.service_proxy_auth_domain, + mkws_config.pazpar2_url); } else { // raw pp2 - run_auto_searches(); + runAutoSearches(); } }); })(jQuery);