X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=experiments%2Fspclient%2Fmkws.js;h=4c75a8ced2639765d17ea0f87a266d3a2f347cc2;hp=44770636cfecdc4091ffa42420c2bf741d0b5a92;hb=400f8f4e8a1da22f2796da885a8ac4b891f02b67;hpb=f89db07295189836ab5b176e6d87019468236fbe diff --git a/experiments/spclient/mkws.js b/experiments/spclient/mkws.js index 4477063..4c75a8c 100644 --- a/experiments/spclient/mkws.js +++ b/experiments/spclient/mkws.js @@ -1,23 +1,37 @@ /* A very simple client that shows a basic usage of the pz2.js */ -"use strict"; // HTML5 +"use strict"; // HTML5: disable for debug >= 2 + +/* + * global config object: mkws_config + * + * needs to be defined in the HTML header before + * including this JS file + */ if (!mkws_config) var mkws_config = {}; // for the guys who forgot to define mkws_config... +if (typeof mkws_config.use_service_proxy === 'undefined') + mkws_config.use_service_proxy = true; + +// global debug flag +var mkws_debug; + var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2"; -var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "/service-proxy/"; +var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/"; var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url; var usesessions = mkws_config.use_service_proxy ? false : true; + var mkws_locale_lang = { "de": { "Authors": "Autoren", "Subjects": "Schlagwörter", "Sources": "Daten und Quellen", - "TERMLISTS": "Termlisten", + "Termlists": "Termlisten", "Next": "Weiter", "Prev": "Zurück", "Search": "Suche", @@ -28,6 +42,11 @@ var mkws_locale_lang = { "to": "von", "of": "aus", "found": "gefunden", + "Title": "Titel", + "Author": "Autor", + "Date": "Datum", + "Subject": "Schlagwort", + "Location": "Ort", "dummy": "dummy" }, @@ -36,7 +55,7 @@ var mkws_locale_lang = { "Authors": "Forfattere", "Subjects": "Emner", "Sources": "Kilder", - "TERMLISTS": "TERMLISTS", + "Termlists": "Termlists", "Next": "Næste", "Prev": "Forrige", "Search": "Søg", @@ -47,6 +66,11 @@ var mkws_locale_lang = { "to": "til", "of": "ud af", "found": "fandt", + "Title": "Title", + "Author": "Forfatter", + "Date": "Dato", + "Subject": "Emneord", + "Location": "Lokation", "dummy": "dummy" } @@ -90,22 +114,22 @@ function my_oninit() { function my_onshow(data) { totalRec = data.merged; // move it out - var pager = document.getElementById("pager"); + var pager = document.getElementById("mkwsPager"); pager.innerHTML = ""; - pager.innerHTML +='
' + M('Displaying') + ': ' + pager.innerHTML +='
' + M('Displaying') + ': ' + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) + ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': ' + data.total + ')
'; drawPager(pager); // navi - var results = document.getElementById("results"); + var results = document.getElementById("mkwsRecords"); var html = []; for (var i = 0; i < data.hits.length; i++) { var hit = data.hits[i]; - html.push('
' + html.push('
' +''+ (i + 1 + recPerPage * (curPage - 1)) +'. ' - +'' + hit["md-title"] +' '); if (hit["md-title-remainder"] !== undefined) { @@ -127,54 +151,79 @@ function my_onstat(data) { if (stat == null) return; - stat.innerHTML = 'STATUS INFO -- Active clients: ' - + data.activeclients - + '/' + data.clients + ' -- ' - + 'Retrieved records: ' + data.records - + '/' + data.hits + ' :.'; + stat.innerHTML = 'Status info' + + ' -- ' + + '' + data.activeclients + '/' + data.clients + '' + + ' -- ' + + '' + data.records + '/' + data.hits + ''; } function my_onterm(data) { - var termlists = []; - termlists.push('
' + M('TERMLISTS') + ':
' + M('Sources') + '
'); - for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) { - termlists.push('' + data.xtargets[i].name - + ' (' + data.xtargets[i].freq + ')
'); + // no facets + if (!mkws_config.facets || mkws_config.facets.length == 0) { + $("#mkwsTermlists").hide(); + return; } - termlists.push('
' + M('Subjects') + '
'); - for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) { - termlists.push('' + data.subject[i].name + ' (' - + data.subject[i].freq + ')
'); + // display if we first got results + $("#mkwsTermlists").show(); + + var acc = []; + acc.push('
' + M('Termlists') + '
'); + var facets = mkws_config.facets; + + for(var i = 0; i < facets.length; i++) { + if (facets[i] == "sources") { + add_single_facet(acc, "Sources", data.xtargets, SourceMax, null); + } else if (facets[i] == "subjects") { + add_single_facet(acc, "Subjects", data.subject, SubjectMax, "su"); + } else if (facets[i] == "authors") { + add_single_facet(acc, "Authors", data.author, AuthorMax, "au"); + } else { + alert("bad facet configuration: '" + facets[i] + "'"); + } } - termlists.push('
' + M('Authors') + '
'); - for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) { - termlists.push('' - + data.author[i].name - + ' (' - + data.author[i].freq - + ')
'); + var termlist = document.getElementById("mkwsTermlists"); + replaceHtml(termlist, acc.join('')); + + if (mkws_config.responsive_design) + mkws_mobile_resize(); +} + +function add_single_facet(acc, caption, data, max, cclIndex) { + acc.push('
'); + acc.push('
' + M(caption) + '
'); + for (var i = 0; i < data.length && i < max; i++ ) { + acc.push('' + data[i].name + '' + + ' (' + data[i].freq + ')
'); } - var termlist = document.getElementById("termlist"); - replaceHtml(termlist, termlists.join('')); + acc.push('
'); } function my_onrecord(data) { // FIXME: record is async!! clearTimeout(my_paz.recordTimer); // in case on_show was faster to redraw element - var detRecordDiv = document.getElementById('det_'+data.recid); + var detRecordDiv = document.getElementById('mkwsDet_'+data.recid); if (detRecordDiv) return; curDetRecData = data; - var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid); + var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid); var html = renderDetails(curDetRecData); recordDiv.innerHTML += html; } function my_onbytarget(data) { - var targetDiv = document.getElementById("bytarget"); + var targetDiv = document.getElementById("mkwsBytarget"); var table ='' +''; @@ -196,10 +245,14 @@ function my_onbytarget(data) { // wait until the DOM is ready function domReady () { - document.search.onsubmit = onFormSubmitEventHandler; - document.search.query.value = ''; - document.select.sort.onchange = onSelectDdChange; - document.select.perpage.onchange = onSelectDdChange; + document.mkwsSearchForm.onsubmit = 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 @@ -208,6 +261,7 @@ function onFormSubmitEventHandler() resetPage(); loadSelect(); triggerSearch(); + switchView('records'); // In case it's configured to start off as hidden submitted = true; return false; } @@ -229,30 +283,33 @@ function resetPage() function triggerSearch () { - my_paz.search(document.search.query.value, recPerPage, curSort, curFilter); + my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter); } function loadSelect () { - curSort = document.select.sort.value; - recPerPage = document.select.perpage.value; + if (document.mkwsSelect) { + if (document.mkwsSelect.mkwsSort) + curSort = document.mkwsSelect.mkwsSort.value; + if (document.mkwsSelect.mkwsPerpage) + recPerPage = document.mkwsSelect.mkwsPerpage.value; + } } // limit the query after clicking the facet function limitQuery (field, value) { - document.search.query.value += ' and ' + field + '="' + value + '"'; + document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"'; onFormSubmitEventHandler(); } // limit by target functions function limitTarget (id, name) { - var navi = document.getElementById('navi'); + var navi = document.getElementById('mkwsNavi'); navi.innerHTML = 'Source: ' + name + ''; - navi.innerHTML += '
'; curFilter = 'pz:id=' + id; resetPage(); loadSelect(); @@ -262,7 +319,7 @@ function limitTarget (id, name) function delimitTarget () { - var navi = document.getElementById('navi'); + var navi = document.getElementById('mkwsNavi'); navi.innerHTML = ''; curFilter = null; resetPage(); @@ -285,9 +342,9 @@ function drawPager (pagerDiv) ? firstClkbl + 2*onsides : pages; - var prev = '<< ' + M('Prev') + ' | '; + var prev = '<< ' + M('Prev') + ' | '; if (curPage > 1) - prev = '' +'<< ' + M('Prev') + ' | '; var middle = ''; @@ -300,9 +357,9 @@ function drawPager (pagerDiv) + numLabel + ' '; } - var next = ' | ' + M('Next') + ' >>'; + var next = ' | ' + M('Next') + ' >>'; if (pages - curPage > 0) - next = ' | ' + M('Next') + ' >>'; var predots = ''; @@ -314,7 +371,7 @@ function drawPager (pagerDiv) postdots = '...'; pagerDiv.innerHTML += '
' - + prev + predots + middle + postdots + next + '

'; + + prev + predots + middle + postdots + next + ''; } function showPage (pageNum) @@ -337,35 +394,43 @@ function pagerPrev() { curPage--; } -// swithing view between targets and records +// switching view between targets and records function switchView(view) { - var targets = document.getElementById('mkwsTargets'); - var records = document.getElementById('mkwsRecords'); + var results = document.getElementById('mkwsResults') || + document.getElementById('mkwsRecords'); + var blanket = document.getElementById('mkwsBlanket'); switch(view) { case 'targets': - targets.style.display = "block"; - records.style.display = "none"; + if (targets) targets.style.display = "block"; + if (results) results.style.display = "none"; + if (blanket) blanket.style.display = "none"; break; case 'records': - targets.style.display = "none"; - records.style.display = "block"; + if (targets) targets.style.display = "none"; + if (results) results.style.display = "block"; + if (blanket) blanket.style.display = "block"; + break; + case 'none': + if (targets) targets.style.display = "none"; + if (results) results.style.display = "none"; + if (blanket) blanket.style.display = "none"; break; default: - alert('Unknown view.'); + alert("Unknown view '" + view + "'"); } } // detailed record drawing function showDetails (prefixRecId) { - var recId = prefixRecId.replace('rec_', ''); + var recId = prefixRecId.replace('mkwsRec_', ''); var oldRecId = curDetRecId; curDetRecId = recId; // remove current detailed view if any - var detRecordDiv = document.getElementById('det_'+oldRecId); + var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId); // lovin DOM! if (detRecordDiv) detRecordDiv.parentNode.removeChild(detRecordDiv); @@ -396,93 +461,183 @@ function replaceHtml(el, html) { function renderDetails(data, marker) { - var details = '
Target IDHitsDiagsRecordsState
'; + var details = '
'; if (marker) details += ''; - if (data["md-title"] != undefined) { - details += ''; - } - if (data["md-date"] != undefined) - details += ''; - if (data["md-author"] != undefined) - details += ''; - if (data["md-electronic-url"] != undefined) - details += ''; - if (data["location"][0]["md-subject"] != undefined) - details += ''; - if (data["location"][0]["@name"] != undefined) - details += ''; + + details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]); + details += renderField("Date", data["md-date"]); + details += renderField("Author", data["md-author"]); + details += renderField("URL", data["md-electronic-url"]); + details += renderField("Subject", data["location"][0]["md-subject"]); + details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]); details += '
'+ marker + '
Title: '+data["md-title"]; - if (data["md-title-remainder"] !== undefined) { - details += ' : ' + data["md-title-remainder"] + ' '; - } - if (data["md-title-responsibility"] !== undefined) { - details += ' '+ data["md-title-responsibility"] +''; - } - details += '
Date: ' + data["md-date"] + '
Author: ' + data["md-author"] + '
URL: ' + data["md-electronic-url"] + '' + '
Subject: ' + data["location"][0]["md-subject"] + '
Location: ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '
'; + return details; } +function renderField(caption, data, data2, data3) { + if (data === undefined) { + return ""; + } + + if (caption == "URL") { + data = '' + data + ''; + } + + if (data2 != undefined) { + data = data + " (" + data2 + ")"; + } + + if (data3 != undefined) { + data = data + " " + data3 + ""; + } + + return '' + M(caption) + '' + data + ''; +} + + /* * All the HTML stuff to render the search forms and * result pages. */ -function mkws_html_all(data) { +function mkws_html_all(config) { - /* default config */ - var config = { + /* default mkws config */ + var mkws_config_default = { sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]], perpage: [10, 20, 30, 50], sort_default: "relevance", perpage_default: 20, query_width: 50, - switch: true, /* show/hide Records|Targets menu */ + switch_menu: false, /* show/hide Records|Targets menu */ + lang_menu: true, /* show/hide language menu */ + sort_menu: true, /* show/hide sort menu */ + perpage_menu: true, /* show/hide perpage menu */ + lang_display: [], /* display languages links for given languages, [] for all */ + facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */ + responsive_design_width: 980, /* a page with less pixel width considered as mobile */ + debug: 1, /* debug level for development: 0..2 */ dummy: "dummy" }; + /* set global debug flag early */ + if (typeof config.debug !== 'undefined') { + mkws_debug = config.debug; + } else if (typeof mkws_config_default.debug !== 'undefined') { + mkws_debug = mkws_config_default.debug; + } + /* override standard config values by function parameters */ - for (var k in data) { - config[k] = data[k]; + for (var k in mkws_config_default) { + if (typeof config[k] === 'undefined') + mkws_config[k] = mkws_config_default[k]; + debug("Set config: " + k + ' => ' + mkws_config[k]); } + if (mkws_config.query_width < 5 || mkws_config.query_width > 150) { + debug("Reset query width: " + mkws_config.query_width); + mkws_config.query_width = 50; + } + + mkws_set_lang(mkws_config); + if (mkws_config.lang_menu) + mkws_html_lang(mkws_config); + // For some reason, doing this programmatically results in - // document.search.query being undefined, hence the raw HTML. + // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML. + debug("HTML search form"); $("#mkwsSearch").html('\ -
\ - \ - \ + \ + \ + \
'); - $("#mkwsRecords").html('\ + debug("HTML records"); + // If the application has an #mkwsResults, populate it in the + // usual way. If not, assume that it's a smarter application that + // defines its own subcomponents: + // #mkwsTermlists + // #mkwsRanking + // #mkwsPager + // #mkwsNavi + // #mkwsRecords + if ($("#mkwsResults").length) { + $("#mkwsResults").html('\ \ \ \ \ \ -
\ -
\ +
\
\ -
\ -
\ - ' + M('Sort by') + mkws_html_sort(config) + '\ - ' + M('and show') + ' ' + mkws_html_perpage(config) + '\ - ' + M('per page') + '.\ -
\ -
\ -
\ - \ -
\ +
\ +
\ +
\ +
\
\ -
'); + '); + } + + if ($("#mkwsRanking").length) { + var ranking_data = ''; + ranking_data += '
'; + if (config.sort_menu) { + ranking_data += M('Sort by') + ' ' + mkws_html_sort(config) + ' '; + } + if (config.perpage_menu) { + ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.'; + } + ranking_data += '
'; + + $("#mkwsRanking").html(ranking_data); + } mkws_html_switch(config); + if (mkws_config.use_service_proxy) mkws_service_proxy_auth(config.service_proxy_auth); + if (mkws_config.responsive_design) + mkws_responsive_design(); + domReady(); + + // on first page, hide the termlist + $(document).ready(function() { $("#mkwsTermlists").hide(); } ); +} + +/* Responsive web design - change layout on the fly depending on + * the current screen size width/height. Required for mobile devices. + */ +function mkws_responsive_design () { + var timeout = null; + + $(window).resize( function(e) { + if (timeout) + clearTimeout(timeout); + timeout = setTimeout(function () { mkws_mobile_resize() }, 50); + }); + + // initial check after page load + $(document).ready(function() { mkws_mobile_resize() }); +} + +function mkws_set_lang(mkws_config) { + var lang = jQuery.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(config) { + debug("HTML switch"); + $("#mkwsSwitch").html($("", { href: '#', onclick: "switchView(\'records\')", @@ -495,19 +650,22 @@ function mkws_html_switch(config) { text: "Targets" })); + debug("HTML targets"); $("#mkwsTargets").html('\ -
\ +
\ No information available yet.\
'); $("#mkwsTargets").css("display", "none"); - if (!config.switch) { + if (!config.switch_menu) { + debug("disable switch menu"); $("#mkwsSwitch").css("display", "none"); } } function mkws_html_sort(config) { - var sort_html = ''; for(var i = 0; i < config.sort.length; i++) { var key = config.sort[i][0]; @@ -525,7 +683,8 @@ function mkws_html_sort(config) { } function mkws_html_perpage(config) { - var perpage_html = ''; for(var i = 0; i < config.perpage.length; i++) { var key = config.perpage[i]; @@ -548,28 +707,94 @@ function mkws_html_perpage(config) { */ function mkws_service_proxy_auth(auth_url) { if (!auth_url) - auth_url = "/service-proxy-auth"; - - var jqxhr = jQuery.get(auth_url) - .fail(function() { - alert("service proxy authentication failed, give up!"); - }) - .success(function(data) { - if (!jQuery.isXMLDoc(data)) { - alert("service proxy auth response document is not valid XML document, give up!"); - return; - } - var status = $(data).find("status"); - if (status.text() != "OK") { - alert("service proxy auth repsonse status: " + status.text() + ", give up!"); - return; - } - }); + auth_url = "http://mkws.indexdata.com/service-proxy-auth"; + + debug("Run service proxy auth URL: " + auth_url); + + var request = new pzHttpRequest(auth_url); + request.get(null, function(data) { + if (!jQuery.isXMLDoc(data)) { + alert("service proxy auth response document is not valid XML document, give up!"); + return; + } + var status = $(data).find("status"); + if (status.text() != "OK") { + alert("service proxy auth repsonse status: " + status.text() + ", give up!"); + return; + } + }); +} + +/* create locale language menu */ +function mkws_html_lang(mkws_config) { + var lang_default = "en"; + var lang = mkws_config.lang || lang_default; + var list = []; + + /* display a list of configured languages, or all */ + var lang_display = mkws_config.lang_display || []; + var hash = {}; + for (var i = 0; i < lang_display.length; i++) { + hash[lang_display[i]] = 1; + } + + for (var k in mkws_locale_lang) { + if (hash[k] == 1 || lang_display.length == 0) + list.push(k); + } + + // add english link + if (lang_display.length == 0 || hash[lang_default] == 1) + list.push(lang_default); + + debug("Language menu for: " + list.join(", ")); + + /* the HTML part */ + var data = ""; + for(var i = 0; i < list.length; i++) { + var l = list[i]; + + if (data) + data += ' | '; + + if (lang == l) { + data += ' ' + l + ' '; + } else { + data += '
' + l + ' ' + } + } + + $("#mkwsLang").html(data); } +function mkws_mobile_resize () { + debug("resize width: " + $(window).height() + ", width: " + $(window).width()); + var list = ["mkwsSwitch"]; + var obj; + // alert($(window).width()); + + var width = mkws_config.responsive_design_width || 980; + + if ($(window).width() <= width) { + for(var i = 0; i < list.length; i++) { + $("#" + list[i]).hide(); + } + + $("#mkwsTermlists").hide(); + obj = $("#mkwsTermlists").html(); + $("#mkwsShiftedTermlists").html(obj); + } else { + for(var i = 0; i < list.length; i++) { + $("#" + list[i]).show(); + } + $("#mkwsTermlists").show(); + $("#mkwsShiftedTermlists").html(""); + } +}; + /* locale */ function M(word) { - var lang = jQuery.parseQuerystring().lang || mkws_config.lang; + var lang = mkws_config.lang; if (!lang || !mkws_locale_lang[lang]) return word; @@ -579,7 +804,7 @@ function M(word) { /* implement jQuery.parseQuerystring() for parsing URL parameters */ jQuery.extend({ - parseQuerystring: function() { + parseQuerystring: function() { var nvpair = {}; var qs = window.location.search.replace('?', ''); var pairs = qs.split('&'); @@ -588,7 +813,38 @@ jQuery.extend({ nvpair[pair[0]] = pair[1]; }); return nvpair; -} }); + }, + pazpar2: function(data) { + document.write('
\ +
\ +
\ +
\ +
\ +
\ +
\ + Powered by MKWS © 2013 Index Data\ +
'); + + mkws_html_all(mkws_config); + } +}); + +function debug(string) { + if (!mkws_debug) + return; + + if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */ + return; + } + + // you need to disable use strict at the top of the file!!! + if (mkws_debug >= 3) { + console.log(arguments.callee.caller); + } else if (mkws_debug >= 2) { + console.log(">>> called from function " + arguments.callee.caller.name + ' <<<'); + } + console.log(string); +} /* magic */ $(document).ready(function() { mkws_html_all(mkws_config) });