X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fmkws.js;h=c11738a88f6be33dd25d7bcd3e197c59bda0b0f6;hb=925d2356891199a978c06866733f663af30f335d;hp=aeb3ad399a3184fe8f7074ddf9228ddbbfe83684;hpb=579d6d7627f98a5246d9957926f5546a8b82f819;p=mkws-moved-to-github.git diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js index aeb3ad3..c11738a 100644 --- a/tools/htdocs/mkws.js +++ b/tools/htdocs/mkws.js @@ -1,32 +1,26 @@ /* A very simple client that shows a basic usage of the pz2.js */ -"use strict"; // HTML5: disable for debug >= 2 +"use strict"; // HTML5: disable for debug_level >= 2 + +// Set up namespace and some state. +var mkws = { + filters: [], +}; /* * global config object: mkws_config * - * needs to be defined in the HTML header before - * including this JS file + * Needs to be defined in the HTML header before including this JS file. + * Define empty mkws_config for simple applications that don't define it. */ - 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 : "http://mkws.indexdata.com/service-proxy/"; + var mkws_config = {}; -var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url; -var usesessions = mkws_config.use_service_proxy ? false : true; +// Wrapper for jQuery +(function ($) { - -var mkws_locale_lang = { +mkws.locale_lang = { "de": { "Authors": "Autoren", "Subjects": "Schlagwörter", @@ -47,6 +41,7 @@ var mkws_locale_lang = { "Date": "Datum", "Subject": "Schlagwort", "Location": "Ort", + // ### to add: Records, Targets "dummy": "dummy" }, @@ -71,18 +66,143 @@ var mkws_locale_lang = { "Date": "Dato", "Subject": "Emneord", "Location": "Lokation", + // ### to add: Records, Targets "dummy": "dummy" } }; +// keep time state for debugging +mkws.debug_time = { + "start": $.now(), + "last": $.now() +}; + +mkws.debug_function = function (string) { + if (!mkws.debug_level) + return; + + if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */ + return; + } + + var now = $.now(); + var timestamp = (now - mkws.debug_time.start)/1000 + " (+" + (now - mkws.debug_time.last)/1000 + ") " + mkws.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); +} +var debug = mkws.debug_function; // local alias + + +Handlebars.registerHelper('json', function(obj) { + return JSON.stringify(obj); +}); + + +// We need {{attr '@name'}} because Handlebars can't parse {{@name}} +Handlebars.registerHelper('attr', function(attrName) { + return this[attrName]; +}); + + +/* + * Use as follows: {{#if-any NAME1 having="NAME2"}} + * Applicable when NAME1 is the name of an array + * The guarded code runs only if at least one element of the NAME1 + * array has a subelement called NAME2. + */ +Handlebars.registerHelper('if-any', function(items, options) { + var having = options.hash.having; + for (var i in items) { + var item = items[i] + if (!having || item[having]) { + return options.fn(this); + } + } + return ""; +}); + + +Handlebars.registerHelper('first', function(items, options) { + var having = options.hash.having; + for (var i in items) { + var item = items[i] + if (!having || item[having]) { + return options.fn(item); + } + } + return ""; +}); + + +Handlebars.registerHelper('commaList', function(items, options) { + var out = ""; + + for (var i in items) { + if (i > 0) out += ", "; + out += options.fn(items[i]) + } + + return out; +}); + + +{ + /* default mkws config */ + var config_default = { + use_service_proxy: true, + service_proxy_auth: "http://mkws.indexdata.com/service-proxy-auth", + lang: "", + sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]], + perpage_options: [10, 20, 30, 50], + sort_default: "relevance", + perpage_default: 20, + query_width: 50, + show_lang: true, /* show/hide language menu */ + show_sort: true, /* show/hide sort menu */ + show_perpage: true, /* show/hide perpage menu */ + lang_options: [], /* display languages links for given languages, [] for all */ + facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */ + responsive_design_width: undefined, /* a page with less pixel width considered as narrow */ + debug_level: 1, /* debug level for development: 0..2 */ + + dummy: "dummy" + }; + + /* set global debug_level flag early */ + if (typeof mkws_config.debug_level !== 'undefined') { + mkws.debug_level = mkws_config.debug_level; + } else if (typeof config_default.debug_level !== 'undefined') { + mkws.debug_level = config_default.debug_level; + } + + /* override standard config values by function parameters */ + for (var k in config_default) { + if (typeof mkws_config[k] === 'undefined') + mkws_config[k] = 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; +} 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]; + mkws.locale_lang[lang] = mkws_config[key]; + debug("Added locally configured language '" + lang + "'"); } } } @@ -93,15 +213,18 @@ for (var key in mkws_config) { // 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": pazpar2path, + "pazpar2path": mkws_config.pazpar2_url || "http://mkws.indexdata.com/service-proxy/", "oninit": my_oninit, "onstat": my_onstat, "onterm": my_onterm, "termlist": "xtargets,subject,author", "onbytarget": my_onbytarget, - "usesessions" : usesessions, + "usesessions" : mkws_config.use_service_proxy ? false : true, "showResponseType": '', // or "json" (for debugging?) "onrecord": my_onrecord } ); + +mkws.my_paz = my_paz; // export + // some state vars var curPage = 1; var recPerPage = 20; @@ -109,7 +232,6 @@ var totalRec = 0; var curDetRecId = ''; var curDetRecData = null; var curSort = 'relevance'; -var curFilter = null; var submitted = false; var SourceMax = 16; var SubjectMax = 10; @@ -127,47 +249,68 @@ function my_onshow(data) { totalRec = data.merged; // move it out var pager = document.getElementById("mkwsPager"); - pager.innerHTML = ""; - pager.innerHTML +='
' + M('Displaying') + ': ' - + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) + - ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': ' - + data.total + ')
'; - drawPager(pager); + if (pager) { + pager.innerHTML = ""; + 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("mkwsRecords"); var html = []; for (var i = 0; i < data.hits.length; i++) { var hit = data.hits[i]; - html.push('
' - +''+ (i + 1 + recPerPage * (curPage - 1)) +'. ' - +'' - + hit["md-title"] +' '); - if (hit["md-title-remainder"] !== undefined) { - html.push('' + hit["md-title-remainder"] + ' '); - } - if (hit["md-title-responsibility"] !== undefined) { - html.push(''+hit["md-title-responsibility"]+''); - } - if (hit.recid == curDetRecId) { + html.push('
', + renderSummary(hit), + '
'); + if (hit.recid == curDetRecId) { html.push(renderDetails(curDetRecData)); - } - html.push('
'); + } } replaceHtml(results, html.join('')); } + +function renderSummary(hit) +{ + if (mkws.templateSummary === undefined) { + loadTemplate("Summary"); + } + + if (mkws.templateSummary) { + hit._id = "mkwsRec_" + hit.recid; + hit._onclick = "mkws.showDetails(this.id);return false;" + return mkws.templateSummary(hit); + } else { + var html = []; + html.push('' + + hit["md-title"] +' '); + if (hit["md-title-remainder"] !== undefined) { + html.push('' + hit["md-title-remainder"] + ' '); + } + if (hit["md-title-responsibility"] !== undefined) { + html.push(''+hit["md-title-responsibility"]+''); + } + return html.join(''); + } +} + + function my_onstat(data) { var stat = document.getElementById("mkwsStat"); if (stat == null) return; - stat.innerHTML = 'Status info' + + stat.innerHTML = '' + M('Status info') + '' + ' -- ' + - '' + data.activeclients + '/' + data.clients + '' + + '' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '' + ' -- ' + - '' + data.records + '/' + data.hits + ''; + '' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + ''; } function my_onterm(data) { @@ -188,9 +331,9 @@ function my_onterm(data) { 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"); + add_single_facet(acc, "Subjects", data.subject, SubjectMax, "subject"); } else if (facets[i] == "authors") { - add_single_facet(acc, "Authors", data.author, AuthorMax, "au"); + add_single_facet(acc, "Authors", data.author, AuthorMax, "author"); } else { alert("bad facet configuration: '" + facets[i] + "'"); } @@ -200,19 +343,19 @@ function my_onterm(data) { replaceHtml(termlist, acc.join('')); } -function add_single_facet(acc, caption, data, max, cclIndex) { +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 + ''); @@ -235,8 +378,18 @@ function my_onrecord(data) { function my_onbytarget(data) { var targetDiv = document.getElementById("mkwsBytarget"); - var table ='' - +''; + if (!targetDiv) { + // No mkwsTargets div. + return; + } + + var table ='
Target IDHitsDiagsRecordsState
' + + '' + + '' + + '' + + '' + + '' + + ''; for (var i = 0; i < data.length; i++ ) { table += "'; + var s = "There is no default '" + name +"' template!"; + alert(s); + return s; } @@ -515,49 +808,10 @@ function renderField(caption, data, data2, data3) { * 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: 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 narrow */ - 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 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); +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. @@ -602,23 +856,24 @@ function mkws_html_all(config) { if ($("#mkwsRanking").length) { var ranking_data = ''; ranking_data += ''; - if (config.sort_menu) { - ranking_data += M('Sort by') + ' ' + mkws_html_sort(config) + ' '; + if (mkws_config.show_sort) { + ranking_data += M('Sort by') + ' ' + mkws_html_sort() + ' '; } - if (config.perpage_menu) { - ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.'; + if (mkws_config.show_perpage) { + ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.'; } ranking_data += ''; $("#mkwsRanking").html(ranking_data); } - mkws_html_switch(config); + mkws_html_switch(); if (mkws_config.use_service_proxy) - mkws_service_proxy_auth(config.service_proxy_auth); + mkws_service_proxy_auth(mkws_config.service_proxy_auth, + mkws_config.service_proxy_auth_domain); - if (mkws_config.responsive_design) { + 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() }); @@ -639,9 +894,9 @@ function mkws_html_all(config) { } } -function mkws_set_lang(mkws_config) { - var lang = $.parseQuerystring().lang || mkws_config.lang || ""; - if (!lang || !mkws_locale_lang[lang]) { +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; @@ -651,20 +906,12 @@ function mkws_set_lang(mkws_config) { return mkws_config.lang; } -function mkws_html_switch(config) { +function mkws_html_switch() { debug("HTML switch"); - $("#mkwsSwitch").html($("", { - href: '#', - onclick: "switchView(\'records\')", - text: M("Records") - })); + $("#mkwsSwitch").append($('' + M('Records') + '')); $("#mkwsSwitch").append($("", { text: " | " })); - $("#mkwsSwitch").append($("", { - href: '#', - onclick: "switchView(\'targets\')", - text: M("Targets") - })); + $("#mkwsSwitch").append($('' + M('Targets') + '')); debug("HTML targets"); $("#mkwsTargets").html('\ @@ -672,41 +919,37 @@ function mkws_html_switch(config) { No information available yet.\ '); $("#mkwsTargets").css("display", "none"); - - if (!config.switch_menu) { - debug("disable switch menu"); - $("#mkwsSwitch").css("display", "none"); - } } -function mkws_html_sort(config) { +function mkws_html_sort() { debug("HTML sort"); var sort_html = ''; return sort_html; } -function mkws_html_perpage(config) { +function mkws_html_perpage() { debug("HTML perpage"); var perpage_html = '
' + M('Target ID') + '' + M('Hits') + '' + M('Diags') + '' + M('Records') + '' + M('State') + '
" + data[i].id + @@ -272,7 +425,7 @@ function onFormSubmitEventHandler() resetPage(); loadSelect(); triggerSearch(); - switchView('records'); // In case it's configured to start off as hidden + mkws.switchView('records'); // In case it's configured to start off as hidden submitted = true; return false; } @@ -294,7 +447,24 @@ function resetPage() function triggerSearch () { - my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter); + var pp2filter = ""; + var pp2limit = ""; + + for (var i in mkws.filters) { + var filter = mkws.filters[i]; + if (filter.id) { + if (pp2filter) + pp2filter += ","; + pp2filter += 'pz:id=' + filter.id; + } else { + if (pp2limit) + pp2limit += ","; + pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&'); + } + } + + debug("triggerSearch: filters = " + JSON.stringify(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit); + my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, pp2filter, undefined, { limit: pp2limit }); } function loadSelect () @@ -308,37 +478,102 @@ function loadSelect () } // limit the query after clicking the facet -function limitQuery (field, value) +mkws.limitQuery = function (field, value) { - document.mkwsSearchForm.mkwsQuery.value += ' and ' + field + '="' + value + '"'; - onFormSubmitEventHandler(); + debug("limitQuery(field=" + field + ", value=" + value + ")"); + mkws.filters.push({ field: field, value: value }); + redraw_navi(); + resetPage(); + loadSelect(); + triggerSearch(); + return false; } // limit by target functions -function limitTarget (id, name) +mkws.limitTarget = function (id, name) { - var navi = document.getElementById('mkwsNavi'); - navi.innerHTML = - 'Source: ' - + name + ''; - curFilter = 'pz:id=' + id; + debug("limitTarget(id=" + id + ", name=" + name + ")"); + mkws.filters.push({ id: id, name: name }); + redraw_navi(); resetPage(); loadSelect(); triggerSearch(); return false; } -function delimitTarget () +mkws.delimitQuery = function (field, value) { - var navi = document.getElementById('mkwsNavi'); - navi.innerHTML = ''; - curFilter = null; + debug("delimitQuery(field=" + field + ", value=" + value + ")"); + var newFilters = []; + for (var i in mkws.filters) { + var filter = mkws.filters[i]; + if (filter.field && + field == filter.field && + value == filter.value) { + debug("delimitTarget() removing filter " + JSON.stringify(filter)); + } else { + debug("delimitTarget() keeping filter " + JSON.stringify(filter)); + newFilters.push(filter); + } + } + mkws.filters = newFilters; + + redraw_navi(); + resetPage(); + loadSelect(); + triggerSearch(); + return false; +} + + +mkws.delimitTarget = function (id) +{ + debug("delimitTarget(id=" + id + ")"); + var newFilters = []; + for (var i in mkws.filters) { + var filter = mkws.filters[i]; + if (filter.id) { + debug("delimitTarget() removing filter " + JSON.stringify(filter)); + } else { + debug("delimitTarget() keeping filter " + JSON.stringify(filter)); + newFilters.push(filter); + } + } + mkws.filters = newFilters; + + redraw_navi(); resetPage(); loadSelect(); triggerSearch(); return false; } + +function redraw_navi () +{ + var navi = document.getElementById('mkwsNavi'); + if (!navi) return; + + var text = ""; + for (var i in mkws.filters) { + if (text) { + text += " | "; + } + var filter = mkws.filters[i]; + if (filter.id) { + text += 'Source: ' + filter.name + ''; + } else { + text += filter.field + ': ' + filter.value + ''; + } + } + + navi.innerHTML = text; +} + + function drawPager (pagerDiv) { //client indexes pages from 1 but pz2 from 0 @@ -355,7 +590,7 @@ function drawPager (pagerDiv) var prev = '<< ' + M('Prev') + ' | '; if (curPage > 1) - prev = '' + prev = '' +'<< ' + M('Prev') + ' | '; var middle = ''; @@ -364,13 +599,13 @@ function drawPager (pagerDiv) if(i == curPage) numLabel = '' + i + ''; - middle += ' ' + middle += ' ' + numLabel + ' '; } var next = ' | ' + M('Next') + ' >>'; if (pages - curPage > 0) - next = ' | ' + next = ' | ' + M('Next') + ' >>'; var predots = ''; @@ -385,7 +620,7 @@ function drawPager (pagerDiv) + prev + predots + middle + postdots + next + ''; } -function showPage (pageNum) +mkws.showPage = function (pageNum) { curPage = pageNum; my_paz.showPage( curPage - 1 ); @@ -393,21 +628,23 @@ function showPage (pageNum) // simple paging functions -function pagerNext() { +mkws.pagerNext = function () { if ( totalRec - recPerPage*curPage > 0) { my_paz.showNext(); curPage++; } } -function pagerPrev() { +mkws.pagerPrev = function () { if ( my_paz.showPrev() != false ) curPage--; } // switching view between targets and records -function switchView(view) { +mkws.switchView = function(view) { + debug("switchView: " + view); + var targets = document.getElementById('mkwsTargets'); var results = document.getElementById('mkwsResults') || document.getElementById('mkwsRecords'); @@ -439,7 +676,7 @@ function switchView(view) { } // detailed record drawing -function showDetails (prefixRecId) { +mkws.showDetails = function (prefixRecId) { var recId = prefixRecId.replace('mkwsRec_', ''); var oldRecId = curDetRecId; curDetRecId = recId; @@ -476,38 +713,94 @@ function replaceHtml(el, html) { function renderDetails(data, marker) { - var details = '
'; - if (marker) 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 + '
'; + if (mkws.templateRecord === undefined) { + loadTemplate("Record"); + } - return details; + var template = mkws.templateRecord; + var details = template(data); + return '
' + details + '
'; } -function renderField(caption, data, data2, data3) { - if (data === undefined) { - return ""; - } - if (caption == "URL") { - data = '' + data + ''; +function loadTemplate(name) +{ + var source = $("#mkwsTemplate" + name).html(); + if (!source) { + source = defaultTemplate(name); } - if (data2 != undefined) { - data = data + " (" + data2 + ")"; - } + var template = Handlebars.compile(source); + debug("compiled template '" + name + "'"); + mkws['template' + name] = template; +} + - if (data3 != undefined) { - data = data + " " + data3 + ""; +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}}\ + \ + \ + \ + \ +
Title\ + {{md-title}}\ + {{#if md-title-remainder}}\ + ({{md-title-remainder}})\ + {{/if}}\ + {{#if md-title-responsibility}}\ + {{md-title-responsibility}}\ + {{/if}}\ +
Date{{md-date}}
Author{{md-author}}
URL\ + {{#each md-electronic-url}}\ + {{this}}
\ + {{/each}}\ +
Subject\ + {{#first location having="md-subject"}}\ + {{#if md-subject}}\ + {{md-subject}}\ + {{/if}}\ + {{/first}}\ +
Locations\ + {{#commaList location}}\ + {{attr "@name"}}{{/commaList}}\ +
\ +'; } - return '
' + M(caption) + '' + data + '