X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=experiments%2Fspclient%2Fmkws.js;h=023247ba57d75129b747b81b78856324aba22185;hp=179e972149f27c9035e4fd440c4b98d66975aefd;hb=1961bd80ed336c551905b49914c91c8e8b62c3a8;hpb=f2c98b0fcf0f1eaff1d0a9e1e29cbf62222ac847 diff --git a/experiments/spclient/mkws.js b/experiments/spclient/mkws.js index 179e972..023247b 100644 --- a/experiments/spclient/mkws.js +++ b/experiments/spclient/mkws.js @@ -1,18 +1,92 @@ /* A very simple client that shows a basic usage of the pz2.js */ +"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; + +var mkws_debug = 1; + +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 : "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", + "Next": "Weiter", + "Prev": "Zurück", + "Search": "Suche", + "Sort by": "Sortieren nach", + "and show": "und zeige", + "per page": "pro Seite", + "Displaying": "Zeige", + "to": "von", + "of": "aus", + "found": "gefunden", + "Title": "Titel", + "Author": "Autor", + "Date": "Datum", + "Subject": "Schlagwort", + "Location": "Ort", + + "dummy": "dummy" + }, + + "da": { + "Authors": "Forfattere", + "Subjects": "Emner", + "Sources": "Kilder", + "Termlists": "Termlists", + "Next": "Næste", + "Prev": "Forrige", + "Search": "Søg", + "Sort by": "Sorter efter", + "and show": "og vis", + "per page": "per side", + "Displaying": "Viser", + "to": "til", + "of": "ud af", + "found": "fandt", + "Title": "Title", + "Author": "Forfatter", + "Date": "Dato", + "Subject": "Emneord", + "Location": "Lokation", + + "dummy": "dummy" + } +}; + // 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 var my_paz = new pz2( { "onshow": my_onshow, "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way - "pazpar2path": '/service-proxy/', + "pazpar2path": pazpar2path, "oninit": my_oninit, "onstat": my_onstat, "onterm": my_onterm, "termlist": "xtargets,subject,author", "onbytarget": my_onbytarget, - "usesessions" : false, + "usesessions" : usesessions, "showResponseType": '', // or "json" (for debugging?) "onrecord": my_onrecord } ); // some state vars @@ -39,11 +113,11 @@ 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 +='
Displaying: ' - + (data.start + 1) + ' to ' + (data.start + data.num) + - ' of ' + data.merged + ' (found: ' + pager.innerHTML +='
' + M('Displaying') + ': ' + + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) + + ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': ' + data.total + ')
'; drawPager(pager); // navi @@ -76,38 +150,60 @@ 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('
TERMLISTS:
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").parent().hide(); + return; } - termlists.push('
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").parent().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('
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('')); +} + +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) { @@ -157,6 +253,7 @@ function onFormSubmitEventHandler() resetPage(); loadSelect(); triggerSearch(); + switchView('records'); // In case it's configured to start off as hidden submitted = true; return false; } @@ -234,10 +331,10 @@ function drawPager (pagerDiv) ? firstClkbl + 2*onsides : pages; - var prev = '<< Prev | '; + var prev = '<< ' + M('Prev') + ' | '; if (curPage > 1) prev = ' | '; + +'<< ' + M('Prev') + ' | '; var middle = ''; for(var i = firstClkbl; i <= lastClkbl; i++) { @@ -249,10 +346,10 @@ function drawPager (pagerDiv) + numLabel + ' '; } - var next = ' | Next >>'; + var next = ' | ' + M('Next') + ' >>'; if (pages - curPage > 0) next = ' | '; + + M('Next') + ' >>'; var predots = ''; if (firstClkbl > 1) @@ -292,15 +389,23 @@ function switchView(view) { var targets = document.getElementById('mkwsTargets'); var records = document.getElementById('mkwsRecords'); + var blanket = document.getElementById('mkwsBlanket'); switch(view) { case 'targets': targets.style.display = "block"; records.style.display = "none"; + if (blanket) { blanket.style.display = "none"; } break; case 'records': targets.style.display = "none"; records.style.display = "block"; + if (blanket) { blanket.style.display = "block"; } + break; + case 'none': + targets.style.display = "none"; + records.style.display = "none"; + if (blanket) { blanket.style.display = "none"; } break; default: alert('Unknown view.'); @@ -347,104 +452,366 @@ function renderDetails(data, marker) { 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 ""; + } -$(document).ready(function() { - $("#mkwsSwitch").html($("", { - href: '#', - onclick: "switchView(\'records\')", - text: "Records", - })); - $("#mkwsSwitch").append($("", { text: " | " })); - $("#mkwsSwitch").append($("", { - href: '#', - onclick: "switchView(\'targets\')", - text: "Targets", - })); + 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(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_menu: true, /* show/hide Records|Targets menu */ + lang_menu: true, /* show/hide language menu */ + lang_display: [], /* display languages links for given languages, [] for all */ + facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */ + + debug: 0, /* debug level for development: 0..2 */ + + dummy: "dummy" + }; + + /* set global debug flag early */ + if (config.debug !== 'undefined') { + mkws_debug = config.debug; + } else if (mkws_config_default.debug !== 'undefined') { + mkws_debug = mkws_config_default.debug; + } + + /* override standard config values by function parameters */ + 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. + debug("HTML search form"); $("#mkwsSearch").html('\ -
\ - \ - \ + \ + \ + \
'); + debug("HTML records"); $("#mkwsRecords").html('\ \ \ \ \ \ -
\ -
\ +
\ 		\
\ -
\ - Sort by\ - \ - and show \ - \ - per page.\ + \ + ' + M('Sort by') + ' ' + mkws_html_sort(config) + '\ + ' + M('and show') + ' ' + mkws_html_perpage(config) + '\ + ' + M('per page') + '.\
\
\ -
\ +
\ \
\
\ -
'); + '); + + 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").parent().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() }, 100); + }); + + // 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\')", + text: "Records" + })); + $("#mkwsSwitch").append($("", { text: " | " })); + $("#mkwsSwitch").append($("", { + href: '#', + onclick: "switchView(\'targets\')", + text: "Targets" + })); + + debug("HTML targets"); $("#mkwsTargets").html('\
\ No information available yet.\
'); $("#mkwsTargets").css("display", "none"); - domReady(); -}); + if (!config.switch_menu) { + debug("disable switch menu"); + $("#mkwsSwitch").css("display", "none"); + } +} + +function mkws_html_sort(config) { + debug("HTML sort"); + var sort_html = ''; + + return sort_html; +} + +function mkws_html_perpage(config) { + debug("HTML perpage"); + var perpage_html = ''; + + return perpage_html; +} + +/* + * Run service-proxy authentication in background (after page load). + * The username/password is configured in the apache config file + * for the site. + */ +function mkws_service_proxy_auth(auth_url) { + if (!auth_url) + 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; + } -function mkws_service_proxy_auth() { - var jqxhr = jQuery.get("/service-proxy-auth") - .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; - } - }); -} - -$(document).ready(function() { - mkws_service_proxy_auth(); + 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()); + + if ($(window).width() <= 980) { + for(var i = 0; i < list.length; i++) { + $("#" + list[i]).hide(); + } + + $("#mkwsTermlists").parent().hide(); + obj = $("#mkwsTermlists").parent().html(); + $("#mkwsShiftedTermlists").html("
" + obj); + } else { + for(var i = 0; i < list.length; i++) { + $("#" + list[i]).show(); + } + $("#mkwsTermlists").parent().show(); + $("#mkwsShiftedTermlists").html(""); + } +}; + +/* locale */ +function M(word) { + var lang = mkws_config.lang; + + if (!lang || !mkws_locale_lang[lang]) + return word; + + return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word; +} + +/* implement jQuery.parseQuerystring() for parsing URL parameters */ +jQuery.extend({ + parseQuerystring: function() { + 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; + }, + pazpar2: function(data) { + document.write('
\ +
\ +
\ +
\ +
\ + '); + + 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) });