X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fmkws.js;h=cbbceef5401d27e7a57e92ff6ebc7022d182c7b2;hb=9c33dc7f7cdb091ed8a4d3dcc38bb98fa66f9f4c;hp=18ac664b852808ff5600c782b9c82f5d46573da1;hpb=c52fd3b80ba09d9be09ec45a4dc17fe4bd96064b;p=mkws-moved-to-github.git diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js index 18ac664..cbbceef 100644 --- a/tools/htdocs/mkws.js +++ b/tools/htdocs/mkws.js @@ -1,27 +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 = { - sort: 'relevance', authenticated: false, - filters: [], + 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", @@ -43,7 +30,8 @@ mkws.locale_lang = { "Date": "Datum", "Subject": "Schlagwort", "Location": "Ort", - // ### to add: Records, Targets + "Records": "Datensätze", + "Targets": "Datenbanken", "dummy": "dummy" }, @@ -68,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() }; @@ -89,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) { @@ -101,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); }); @@ -157,9 +172,11 @@ Handlebars.registerHelper('commaList', function(items, options) { { + /* 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"]], @@ -185,6 +202,12 @@ Handlebars.registerHelper('commaList', 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') @@ -193,8 +216,9 @@ Handlebars.registerHelper('commaList', function(items, options) { } } -mkws.sort = mkws_config.sort_default; -debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to mkws.sort"); + +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); @@ -212,24 +236,28 @@ 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, +var m_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; @@ -241,12 +269,16 @@ 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: // function my_oninit() { - my_paz.stat(); - my_paz.bytarget(); + m_paz.stat(); + m_paz.bytarget(); } function my_onshow(data) { @@ -357,7 +389,7 @@ function add_single_facet(acc, caption, data, max, pzIndex) { function my_onrecord(data) { // FIXME: record is async!! - clearTimeout(my_paz.recordTimer); + clearTimeout(m_paz.recordTimer); // in case on_show was faster to redraw element var detRecordDiv = document.getElementById('mkwsDet_'+data.recid); if (detRecordDiv) return; @@ -417,18 +449,20 @@ function onFormSubmitEventHandler() return false; } -function newSearch(query, sort, targets) +function newSearch(query, sort, targets, windowid) { - if (!mkws.authenticated) { + debug("newSearch: " + query); + + if (mkws_config.use_service_proxy && !mkws.authenticated) { alert("searching before authentication"); return; } - mkws.filters = [] - redraw_navi(); - resetPage(); - loadSelect(); - triggerSearch(query, sort, targets); + 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; } @@ -438,7 +472,7 @@ function onSelectDdChange() if (!submitted) return false; resetPage(); loadSelect(); - my_paz.show(0, recPerPage, mkws.sort); + m_paz.show(0, recPerPage, m_sort); return false; } @@ -448,7 +482,7 @@ function resetPage() totalRec = 0; } -function triggerSearch (query, sort, targets) +function triggerSearch (query, sort, targets, windowid) { var pp2filter = ""; var pp2limit = ""; @@ -458,20 +492,23 @@ function triggerSearch (query, sort, targets) mkws.query = query; } if (sort) { - mkws.sort = sort; + m_sort = sort; } if (targets) { // ### should support multiple |-separated targets - mkws.filters.push({ id: targets, name: targets }); + m_filters.push({ id: targets, name: targets }); } - 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) { if (pp2filter) - pp2filter += "|"; - if (filter.id.indexOf('pz:id=') != 0) + 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) @@ -480,15 +517,23 @@ function triggerSearch (query, sort, targets) } } - debug("triggerSearch(" + mkws.query + "): filters = " + JSON.stringify(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit); - my_paz.search(mkws.query, recPerPage, mkws.sort, 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)); + + m_paz.search(mkws.query, recPerPage, m_sort, pp2filter, undefined, params); } function loadSelect () { if (document.mkwsSelect) { if (document.mkwsSelect.mkwsSort) - mkws.sort = document.mkwsSelect.mkwsSort.value; + m_sort = document.mkwsSelect.mkwsSort.value; if (document.mkwsSelect.mkwsPerpage) recPerPage = document.mkwsSelect.mkwsPerpage.value; } @@ -498,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(); @@ -510,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(); @@ -520,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(); @@ -545,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(); @@ -572,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 + ''; @@ -586,7 +631,7 @@ function redraw_navi () ');return false;">' + filter.value + ''; } } - + navi.innerHTML = text; } @@ -640,20 +685,20 @@ function drawPager (pagerDiv) mkws.showPage = function (pageNum) { curPage = pageNum; - my_paz.showPage( curPage - 1 ); + m_paz.showPage( curPage - 1 ); } // simple paging functions mkws.pagerNext = function () { if ( totalRec - recPerPage*curPage > 0) { - my_paz.showNext(); + m_paz.showNext(); curPage++; } } mkws.pagerPrev = function () { - if ( my_paz.showPrev() != false ) + if ( m_paz.showPrev() != false ) curPage--; } @@ -711,7 +756,7 @@ mkws.showDetails = function (prefixRecId) { return; } // request the record - my_paz.record(recId); + m_paz.record(recId); } function replaceHtml(el, html) { @@ -759,7 +804,7 @@ function defaultTemplate(name) return '\ \ \ - \ + \ \ {{#if md-date}}\ \ - \ + \ \ \ {{/if}}\ {{#if md-author}}\ \ - \ + \ \ \ {{/if}}\ {{#if md-electronic-url}}\ \ - \ + \ \ - \ + \ \ {{/if-any}}\ \ - \ + \
Title{{translate "Title"}}\ {{md-title}}\ {{#if md-title-remainder}}\ @@ -772,19 +817,19 @@ function defaultTemplate(name)
Date{{translate "Date"}}{{md-date}}
Author{{translate "Author"}}{{md-author}}
URL{{translate "URL"}}\ {{#each md-electronic-url}}\ {{this}}
\ @@ -794,7 +839,7 @@ function defaultTemplate(name) {{/if}}\ {{#if-any location having="md-subject"}}\
Subject{{translate "Subject"}}\ {{#first location having="md-subject"}}\ {{#if md-subject}}\ @@ -805,7 +850,7 @@ function defaultTemplate(name)
Locations{{translate "Locations"}}\ {{#commaList location}}\ {{attr "@name"}}{{/commaList}}\ @@ -898,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 @@ -925,22 +975,46 @@ function mkws_html_all() { function run_auto_searches() { - var node = $('#mkwsRecords'); - if (node.attr('autosearch')) { + debug("running auto searches"); + + $('[id^="mkwsRecords"]').each(function () { + var node = $(this); 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); - } + + 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 { @@ -967,7 +1041,7 @@ function mkws_html_switch() { } function mkws_html_sort() { - debug("HTML sort, mkws.sort = '" + mkws.sort + "'"); + debug("HTML sort, m_sort = '" + m_sort + "'"); var sort_html = '