X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fmkws.js;h=3860b042526b67f8b4c00d920ddd655503dee2cb;hb=aa699b2f3c0fac6b719db6974eb462cb0d817855;hp=20ca0454492b95c24a42278ba5211e2905b1ca2b;hpb=4af42409cbfccf1527f7d4db4fd557cd1fff177c;p=mkws-moved-to-github.git diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js index 20ca045..3860b04 100644 --- a/tools/htdocs/mkws.js +++ b/tools/htdocs/mkws.js @@ -1,25 +1,14 @@ -/* A very simple client that shows a basic usage of the pz2.js -*/ +/*! MKWS, the MasterKey Widget Set. Copyright (C) 2013-2014, Index Data */ "use strict"; // HTML5: disable for debug_level >= 2 -// Set up namespace and some state. +// Set up global mkws object. Contains a hash of session objects, +// indexed by windowid. var mkws = { - filters: [], + authenticated: false, + sessions: {} }; -/* - * 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. - */ -if (!mkws_config) - var mkws_config = {}; - -// Wrapper for jQuery -(function ($) { - mkws.locale_lang = { "de": { "Authors": "Autoren", @@ -41,7 +30,8 @@ mkws.locale_lang = { "Date": "Datum", "Subject": "Schlagwort", "Location": "Ort", - // ### to add: Records, Targets + "Records": "Datensätze", + "Targets": "Datenbanken", "dummy": "dummy" }, @@ -66,14 +56,34 @@ mkws.locale_lang = { "Date": "Dato", "Subject": "Emneord", "Location": "Lokation", - // ### to add: Records, Targets + "Records": "Poster", + "Targets": "Baser", "dummy": "dummy" } }; +// Define empty mkws_config for simple applications that don't define it. +if (mkws_config == null || typeof mkws_config != 'object') { + var mkws_config = {}; +} + +// wrapper for jQuery lib +function _make_mkws_team($, teamName) { + if (console && console.log) + console.log("run _make_mkws_team(" + (teamName ? teamName : "") + ")"); + + // call this function only once + if (mkws.init) { + alert("_make_mkws_team() called twice: how did that happen?!"); + return; + } + +var m_sort = 'relevance'; +var m_filters = []; + // keep time state for debugging -mkws.debug_time = { +var m_debug_time = { "start": $.now(), "last": $.now() }; @@ -87,8 +97,8 @@ mkws.debug_function = function (string) { } var now = $.now(); - var timestamp = (now - mkws.debug_time.start)/1000 + " (+" + (now - mkws.debug_time.last)/1000 + ") " - mkws.debug_time.last = now; + var timestamp = ((now - m_debug_time.start)/1000).toFixed(3) + " (+" + ((now - m_debug_time.last)/1000).toFixed(3) + ") " + m_debug_time.last = now; // you need to disable use strict at the top of the file!!! if (mkws.debug_level >= 3) { @@ -99,10 +109,17 @@ 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 JSON.stringify(obj); + return $.toJSON(obj); +}); + + +Handlebars.registerHelper('translate', function(s) { + debug("translating '" + s + "'"); + return M(s); }); @@ -142,10 +159,24 @@ Handlebars.registerHelper('first', function(items, options) { }); +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"]], @@ -171,6 +202,12 @@ Handlebars.registerHelper('first', function(items, options) { mkws.debug_level = config_default.debug_level; } + // make sure the mkws_config is a valid hash + if (!$.isPlainObject(mkws_config)) { + debug("ERROR: mkws_config is not an JS object, ignore it...."); + mkws_config = {}; + } + /* override standard config values by function parameters */ for (var k in config_default) { if (typeof mkws_config[k] === 'undefined') @@ -179,6 +216,10 @@ Handlebars.registerHelper('first', function(items, options) { } } + +m_sort = mkws_config.sort_default; +debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to m_sort"); + if (mkws_config.query_width < 5 || mkws_config.query_width > 150) { debug("Reset query width: " + mkws_config.query_width); mkws_config.query_width = 50; @@ -195,36 +236,43 @@ for (var key in mkws_config) { } } +// protocol independend 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 independend links: " + mkws_config.pazpar2_url); +} +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_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; var totalRec = 0; var curDetRecId = ''; var curDetRecData = null; -var curSort = 'relevance'; var submitted = false; var SourceMax = 16; var SubjectMax = 10; var AuthorMax = 10; +if (!isNaN(parseInt(mkws_config.perpage_default))) { + recPerPage = parseInt(mkws_config.perpage_default); +} + // // pz2.js event handlers: // @@ -252,24 +300,29 @@ function my_onshow(data) { 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) @@ -309,7 +362,8 @@ function my_onterm(data) { } var termlist = document.getElementById("mkwsTermlists"); - replaceHtml(termlist, acc.join('')); + if (termlist) + replaceHtml(termlist, acc.join('')); } function add_single_facet(acc, caption, data, max, pzIndex) { @@ -391,12 +445,26 @@ function domReady () // when search button pressed function onFormSubmitEventHandler() { - resetPage(); - loadSelect(); - triggerSearch(); + newSearch(document.mkwsSearchForm.mkwsQuery.value); + return false; +} + +function newSearch(query, sort, targets, windowid) +{ + debug("newSearch: " + query); + + if (mkws_config.use_service_proxy && !mkws.authenticated) { + alert("searching before authentication"); + return; + } + + m_filters = [] + redraw_navi(); // ### should use windowid + resetPage(); // ### the globals it resents should be indexed by windowid + loadSelect(); // ### should use windowid + triggerSearch(query, sort, targets, windowid); mkws.switchView('records'); // In case it's configured to start off as hidden submitted = true; - return false; } function onSelectDdChange() @@ -404,7 +472,7 @@ function onSelectDdChange() if (!submitted) return false; resetPage(); loadSelect(); - my_paz.show(0, recPerPage, curSort); + my_paz.show(0, recPerPage, m_sort); return false; } @@ -414,17 +482,34 @@ function resetPage() totalRec = 0; } -function triggerSearch () +function triggerSearch (query, sort, targets, windowid) { var pp2filter = ""; var pp2limit = ""; - for (var i in mkws.filters) { - var filter = mkws.filters[i]; + // Re-use previous query/sort if new ones are not specified + if (query) { + mkws.query = query; + } + if (sort) { + m_sort = sort; + } + if (targets) { + // ### should support multiple |-separated targets + m_filters.push({ id: targets, name: targets }); + } + + for (var i in m_filters) { + var filter = m_filters[i]; if (filter.id) { if (pp2filter) pp2filter += ","; - pp2filter += 'pz:id=' + filter.id; + 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 += ","; @@ -432,15 +517,23 @@ function triggerSearch () } } - debug("triggerSearch: filters = " + JSON.stringify(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit); - my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, pp2filter, undefined, { limit: pp2limit }); + var params = {}; + if (pp2limit) { + params.limit = pp2limit; + } + if (windowid) { + params.windowid = windowid; + } + debug("triggerSearch(" + mkws.query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params)); + + my_paz.search(mkws.query, recPerPage, m_sort, pp2filter, undefined, params); } function loadSelect () { if (document.mkwsSelect) { if (document.mkwsSelect.mkwsSort) - curSort = document.mkwsSelect.mkwsSort.value; + m_sort = document.mkwsSelect.mkwsSort.value; if (document.mkwsSelect.mkwsPerpage) recPerPage = document.mkwsSelect.mkwsPerpage.value; } @@ -450,7 +543,7 @@ function loadSelect () mkws.limitQuery = function (field, value) { debug("limitQuery(field=" + field + ", value=" + value + ")"); - mkws.filters.push({ field: field, value: value }); + m_filters.push({ field: field, value: value }); redraw_navi(); resetPage(); loadSelect(); @@ -462,7 +555,7 @@ mkws.limitQuery = function (field, value) mkws.limitTarget = function (id, name) { debug("limitTarget(id=" + id + ", name=" + name + ")"); - mkws.filters.push({ id: id, name: name }); + m_filters.push({ id: id, name: name }); redraw_navi(); resetPage(); loadSelect(); @@ -472,20 +565,20 @@ mkws.limitTarget = function (id, name) mkws.delimitQuery = function (field, value) { - debug("delimitQuery(field=" + field + ", value=" + value + ")"); + debug("delimitQuery(field=" + field + ", value=" + value + ")"); var newFilters = []; - for (var i in mkws.filters) { - var filter = mkws.filters[i]; + for (var i in m_filters) { + var filter = m_filters[i]; if (filter.field && field == filter.field && value == filter.value) { - debug("delimitTarget() removing filter " + JSON.stringify(filter)); + debug("delimitTarget() removing filter " + $.toJSON(filter)); } else { - debug("delimitTarget() keeping filter " + JSON.stringify(filter)); + debug("delimitTarget() keeping filter " + $.toJSON(filter)); newFilters.push(filter); } } - mkws.filters = newFilters; + m_filters = newFilters; redraw_navi(); resetPage(); @@ -497,18 +590,18 @@ mkws.delimitQuery = function (field, value) mkws.delimitTarget = function (id) { - debug("delimitTarget(id=" + id + ")"); + debug("delimitTarget(id=" + id + ")"); var newFilters = []; - for (var i in mkws.filters) { - var filter = mkws.filters[i]; + for (var i in m_filters) { + var filter = m_filters[i]; if (filter.id) { - debug("delimitTarget() removing filter " + JSON.stringify(filter)); + debug("delimitTarget() removing filter " + $.toJSON(filter)); } else { - debug("delimitTarget() keeping filter " + JSON.stringify(filter)); + debug("delimitTarget() keeping filter " + $.toJSON(filter)); newFilters.push(filter); } } - mkws.filters = newFilters; + m_filters = newFilters; redraw_navi(); resetPage(); @@ -524,11 +617,11 @@ function redraw_navi () if (!navi) return; var text = ""; - for (var i in mkws.filters) { + for (var i in m_filters) { if (text) { text += " | "; } - var filter = mkws.filters[i]; + var filter = m_filters[i]; if (filter.id) { text += 'Source: ' + filter.name + ''; @@ -538,7 +631,7 @@ function redraw_navi () ');return false;">' + filter.value + ''; } } - + navi.innerHTML = text; } @@ -683,29 +776,20 @@ function replaceHtml(el, html) { function renderDetails(data, marker) { if (mkws.templateRecord === undefined) { - maybeLoadTemplate("Record"); - } - - var details; - if (mkws.templateRecord) { - var template = mkws.templateRecord; - details = template(data); - } else { - details = defaultRenderDetails(data, marker); + loadTemplate("Record"); } + var template = mkws.templateRecord; + var details = template(data); return '
' + details + '
'; } -function maybeLoadTemplate(name) +function loadTemplate(name) { var source = $("#mkwsTemplate" + name).html(); if (!source) { - debug("no template '" + name + "': falling back to default behaviour"); - // Mark template as not provided - mkws['template' + name] = 0; - return; + source = defaultTemplate(name); } var template = Handlebars.compile(source); @@ -714,57 +798,83 @@ function maybeLoadTemplate(name) } -function defaultRenderDetails(data, marker) +function defaultTemplate(name) { - var details = ''; - if (marker) details += ''; - - var locations = []; - for (var i in data.location) { - locations.push(data.location[i]['@name']); + if (name === 'Record') { + return '\ +
'+ marker + '
\ + \ + \ + \ + \ + {{#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 "URL"}}\ + {{#each md-electronic-url}}\ + {{this}}
\ + {{/each}}\ +
{{translate "Subject"}}\ + {{#first location having="md-subject"}}\ + {{#if md-subject}}\ + {{md-subject}}\ + {{/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}}\ +'; } - 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"]); - if (locations.length == 0) { - details += 'No locations for record!'; - } else { - details += renderField("Location" + (locations.length == 1 ? "" : "s"), locations); - } - details += ''; - return details; -} - - -function renderField(caption, data, data2, data3) { - if (data === undefined) { - return ""; - } - - var res = ""; - for (var i = 0; i < data.length; i++) { - var s = data[i]; - if (i > 0) - res += ", "; - - if (caption == "URL") - s = '' + s + ''; - - res += s - } - - if (data2 != undefined) { - res = res + " (" + data2 + ")"; - } - - if (data3 != undefined) { - res = res + " " + data3 + ""; - } - - return '' + M(caption) + '' + res + ''; + var s = "There is no default '" + name +"' template!"; + alert(s); + return s; } @@ -833,9 +943,14 @@ function mkws_html_all() { mkws_html_switch(); - if (mkws_config.use_service_proxy) - mkws_service_proxy_auth(mkws_config.service_proxy_auth, - mkws_config.service_proxy_auth_domain); + 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 @@ -858,8 +973,48 @@ function mkws_html_all() { } } + +function run_auto_searches() { + debug("running auto searches"); + + $('[id^="mkwsRecords"]').each(function () { + var node = $(this); + var query = node.attr('autosearch'); + + if (query) { + var windowid = undefined; + var id = node.attr('id'); + if (id.match(/^mkwsRecords_/, '')) { + windowid = id.replace(/^mkwsRecords_/, ''); + } + + var sort = node.attr('sort'); + var targets = node.attr('targets'); + var s = "running auto search: '" + query + "'"; + if (windowid) s += " [windowid '" + windowid + "']"; + if (sort) s += " sorted by '" + sort + "'"; + if (targets) s += " in targets '" + targets + "'"; + debug(s); + newSearch(query, sort, targets, windowid); + } + }); +} + + +// 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; + var lang = parseQuerystring().lang || mkws_config.lang; if (!lang || !mkws.locale_lang[lang]) { mkws_config.lang = "" } else { @@ -886,7 +1041,7 @@ function mkws_html_switch() { } function mkws_html_sort() { - debug("HTML sort"); + debug("HTML sort, m_sort = '" + m_sort + "'"); var sort_html = '