X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fmkws.js;h=34ad96d7c281807923590ecff9d5c537c75c39fc;hb=32e61827009be16e05a3bd2973245ab2fdd790bd;hp=2f62b26703633b1ca093719547b6ecb2981927ae;hpb=52262a5dbc558d26d731f7918389d6dd9993549c;p=mkws-moved-to-github.git diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js index 2f62b26..34ad96d 100644 --- a/tools/htdocs/mkws.js +++ b/tools/htdocs/mkws.js @@ -1,22 +1,24 @@ -/* A very simple client that shows a basic usage of the pz2.js -*/ +/*! MKWS, the MasterKey Widget Set. Copyright (C) 2013, Index Data */ "use strict"; // HTML5: disable for debug_level >= 2 // Set up namespace and some state. -var mkws = {}; +var mkws = { + sort: 'relevance', + authenticated: false, + filters: [] +}; -/* - * global config object: mkws_config - * - * 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. - */ +// Define empty mkws_config for simple applications that don't define it. if (!mkws_config) var mkws_config = {}; -// Wrapper for jQuery -(function ($) { +// wrapper for jQuery lib +function _mkws($) { + // if (console && console.log) console.log("run _mkws()"); + + // call this function only once + if (mkws.init) return; mkws.locale_lang = { "de": { @@ -85,7 +87,7 @@ mkws.debug_function = function (string) { } var now = $.now(); - var timestamp = (now - mkws.debug_time.start)/1000 + " (+" + (now - mkws.debug_time.last)/1000 + ") " + var timestamp = ((now - mkws.debug_time.start)/1000).toFixed(3) + " (+" + ((now - mkws.debug_time.last)/1000).toFixed(3) + ") " mkws.debug_time.last = now; // you need to disable use strict at the top of the file!!! @@ -97,11 +99,67 @@ mkws.debug_function = function (string) { console.log(timestamp + string); } var debug = mkws.debug_function; // local alias +debug("start running MKWS"); + + +Handlebars.registerHelper('json', function(obj) { + return $.toJSON(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, + pazpar2_url: "http://mkws.indexdata.com/service-proxy/", service_proxy_auth: "http://mkws.indexdata.com/service-proxy-auth", lang: "", sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]], @@ -135,6 +193,11 @@ var debug = mkws.debug_function; // local alias } } +mkws.sort = mkws_config.sort_default; +debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to mkws.sort"); + +mkws.usesessions = mkws_config.use_service_proxy ? false : true; + if (mkws_config.query_width < 5 || mkws_config.query_width > 150) { debug("Reset query width: " + mkws_config.query_width); mkws_config.query_width = 50; @@ -151,19 +214,19 @@ for (var key in mkws_config) { } } - +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 var my_paz = new pz2( { "onshow": my_onshow, "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way - "pazpar2path": mkws_config.pazpar2_url || "http://mkws.indexdata.com/service-proxy/", + "pazpar2path": mkws_config.pazpar2_url, "oninit": my_oninit, "onstat": my_onstat, "onterm": my_onterm, "termlist": "xtargets,subject,author", "onbytarget": my_onbytarget, - "usesessions" : mkws_config.use_service_proxy ? false : true, + "usesessions" : mkws.usesessions, "showResponseType": '', // or "json" (for debugging?) "onrecord": my_onrecord } ); @@ -175,8 +238,6 @@ var recPerPage = 20; var totalRec = 0; var curDetRecId = ''; var curDetRecData = null; -var curSort = 'relevance'; -var curFilter = null; var submitted = false; var SourceMax = 16; var SubjectMax = 10; @@ -194,46 +255,54 @@ 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('
' - +'' - + 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"); + } + + hit._id = "mkwsRec_" + hit.recid; + hit._onclick = "mkws.showDetails(this.id);return false;" + return mkws.templateSummary(hit); +} + + 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) { @@ -254,31 +323,32 @@ 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] + "'"); } } var termlist = document.getElementById("mkwsTermlists"); - replaceHtml(termlist, acc.join('')); + if (termlist) + 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 + ''); @@ -306,8 +376,13 @@ function my_onbytarget(data) { return; } - var table ='' - +''; + 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; } @@ -649,8 +905,14 @@ function mkws_html_all() { mkws_html_switch(); - if (mkws_config.use_service_proxy) - mkws_service_proxy_auth(mkws_config.service_proxy_auth); + if (mkws_config.use_service_proxy) { + mkws_service_proxy_auth(mkws_config.service_proxy_auth, + mkws_config.service_proxy_auth_domain, + mkws_config.pazpar2_url); + } else { + // raw pp2 + run_auto_searches(); + } if (mkws_config.responsive_design_width) { // Responsive web design - change layout on the fly based on @@ -673,6 +935,24 @@ function mkws_html_all() { } } + +function run_auto_searches() { + debug("run auto searches"); + + var node = $('#mkwsRecords'); + if (node.attr('autosearch')) { + var query = node.attr('autosearch'); + var sort = node.attr('sort'); + var targets = node.attr('targets'); + var s = "running auto search: '" + query + "'"; + if (sort) s += " sorted by '" + sort + "'"; + if (targets) s += " in targets '" + targets + "'"; + debug(s); + newSearch(query, sort, targets); + } +} + + function mkws_set_lang() { var lang = $.parseQuerystring().lang || mkws_config.lang; if (!lang || !mkws.locale_lang[lang]) { @@ -701,7 +981,7 @@ function mkws_html_switch() { } function mkws_html_sort() { - debug("HTML sort"); + debug("HTML sort, mkws.sort = '" + mkws.sort + "'"); var sort_html = '
' + M('Target ID') + '' + M('Hits') + '' + M('Diags') + '' + M('Records') + '' + M('State') + '
" + data[i].id + @@ -340,12 +415,26 @@ function domReady () // when search button pressed function onFormSubmitEventHandler() { + newSearch(document.mkwsSearchForm.mkwsQuery.value); + return false; +} + +function newSearch(query, sort, targets) +{ + debug("newSearch: " + query); + + if (mkws_config.use_service_proxy && !mkws.authenticated) { + alert("searching before authentication"); + return; + } + + mkws.filters = [] + redraw_navi(); resetPage(); loadSelect(); - triggerSearch(); + triggerSearch(query, sort, targets); mkws.switchView('records'); // In case it's configured to start off as hidden submitted = true; - return false; } function onSelectDdChange() @@ -353,7 +442,7 @@ function onSelectDdChange() if (!submitted) return false; resetPage(); loadSelect(); - my_paz.show(0, recPerPage, curSort); + my_paz.show(0, recPerPage, mkws.sort); return false; } @@ -363,16 +452,50 @@ function resetPage() totalRec = 0; } -function triggerSearch () +function triggerSearch (query, sort, targets) { - my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter); + var pp2filter = ""; + var pp2limit = ""; + + // Re-use previous query/sort if new ones are not specified + if (query) { + mkws.query = query; + } + if (sort) { + mkws.sort = sort; + } + if (targets) { + // ### should support multiple |-separated targets + mkws.filters.push({ id: targets, name: targets }); + } + + for (var i in mkws.filters) { + var filter = mkws.filters[i]; + if (filter.id) { + if (pp2filter) + pp2filter += ","; + if (filter.id.match(/^[a-z:]+[=~]/)) { + debug("filter '" + filter.id + "' already begins with SETTING OP"); + } else { + filter.id = 'pz:id=' + filter.id; + } + pp2filter += filter.id; + } else { + if (pp2limit) + pp2limit += ","; + pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&'); + } + } + + debug("triggerSearch(" + mkws.query + "): filters = " + $.toJSON(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit); + my_paz.search(mkws.query, recPerPage, mkws.sort, pp2filter, undefined, { limit: pp2limit }); } function loadSelect () { if (document.mkwsSelect) { if (document.mkwsSelect.mkwsSort) - curSort = document.mkwsSelect.mkwsSort.value; + mkws.sort = document.mkwsSelect.mkwsSort.value; if (document.mkwsSelect.mkwsPerpage) recPerPage = document.mkwsSelect.mkwsPerpage.value; } @@ -381,35 +504,100 @@ function loadSelect () // limit the query after clicking the facet 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 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; } -mkws.delimitTarget = function () +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 " + $.toJSON(filter)); + } else { + debug("delimitTarget() keeping filter " + $.toJSON(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 " + $.toJSON(filter)); + } else { + debug("delimitTarget() keeping filter " + $.toJSON(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 @@ -549,38 +737,106 @@ 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}}\ +
\ +'; + } else if (name === "Summary") { + return '\ + \ + {{md-title}}\ + \ + {{#if md-title-remainder}}\ + {{md-title-remainder}}\ + {{/if}}\ + {{#if md-title-responsibility}}\ + {{md-title-responsibility}}\ + {{/if}}\ +'; } - return '
' + M(caption) + '' + data + '