s can be added (with no content), and -will be filled in by MKWS: -

-- switch between record and target views -

-- switch between English, Danish and German -

-- search box and button -

-- result list, including pager/sorting -

-- target list, including status -

-- summary statistics - -At present, MKWS will not work correctly if any of these is -missing. One of the TODOs is to fix it so that it doesn't try to use -whatever is not there, and just uses what is. - - -You can configure and control the client with the JavaScript mkws_config object. - -Here is an example of all possible options - - -Note: the mkws_config object which must be loaded before the mkws.js and pz2api.js files. - -Supported Browsers ------------------- - -Any modern HTML5 browser will work fine. JavaScript must be enabled. - -* IE8 or later -* Firefox 17 or later -* Google Chrome 27 or later -* Safari 6 or later -* Opera 12 or later -* iOS 6.x (iPhone, iPad) -* Android 4.x - -Not supported: IE6, IE7 - -New Features since jsdemo --------------------------- -- multilinguality: English (default), Danish, German -- depends on the new pazpar2 JS library libjs-pz2/pz2api.1.js - which will make the development of pazpar2 plugins faster and - easier to share code between projects -- supports basic pazpar2 and service-proxy requests -- simplified HTML -- the search page is fully configurable by a JSON object - - -What next? ----------- - -Main areas of work: -* Make MKWS robust to missing widgets -* Clean up the code diff --git a/experiments/spclient/favicon.ico b/experiments/spclient/favicon.ico deleted file mode 100644 index 35c4899..0000000 Binary files a/experiments/spclient/favicon.ico and /dev/null differ diff --git a/experiments/spclient/html-structure.txt b/experiments/spclient/html-structure.txt deleted file mode 100644 index c6d0da8..0000000 --- a/experiments/spclient/html-structure.txt +++ /dev/null @@ -1,62 +0,0 @@ -The HTML structure of the MKWS

s is as follows. This is useful to -know when working on stylesheets. As in CSS, #ID indicates a unique -identifier and .CLASS indicates an instance of a class. - - -#mkwsSwitch - a* - -#mkwsLang - ( a | span )* - -#mkwsSearch - form - input#mkwsQuery type=text - input#mkwsButton type=submit - -#mkwsBlanket - (no contents -- used only for masking) - -#mkwsResults - table - tbody - tr - td - #mkwsTermlists - div.title - div.facet* - div.termtitle - ( a span br )* - td - div#mkwsRanking - form#mkwsSelect - select#mkwsSort - select#mkwsPerpage - #mkwsPager - #mkwsNavi - #mkwsRecords - div.record* - span (for sequence number) - a (for title) - span (for other information such as author) - div.details (sometimes) - table - tbody - tr* - th - td -#mkwsTargets - #mkwsBytarget - table - thead - tr* - td* - tbody - tr* - td* - -#mkwsStat - span.head - span.clients - span.records - diff --git a/experiments/spclient/index-full.html b/experiments/spclient/index-full.html deleted file mode 100644 index f82d261..0000000 --- a/experiments/spclient/index-full.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - MKWS demo: full configuration - - - - - -

- Welcome to the MasterKey Widget Set demo. -

- Enter a search above to begin, or - Visit the MKWS home page to find out more. -

- - - diff --git a/experiments/spclient/index-jquery.html b/experiments/spclient/index-jquery.html deleted file mode 100644 index e2d3e19..0000000 --- a/experiments/spclient/index-jquery.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - MKWS demo: jQuery plugin - - - - - - - diff --git a/experiments/spclient/index-lowlevel.html b/experiments/spclient/index-lowlevel.html deleted file mode 100644 index f04060d..0000000 --- a/experiments/spclient/index-lowlevel.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - MKWS demo: low-level subcomponents - - - - - - - - - - - - - - - - - - - -

- - diff --git a/experiments/spclient/index-mike.html b/experiments/spclient/index-mike.html deleted file mode 100644 index 69cbc96..0000000 --- a/experiments/spclient/index-mike.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - MKWS demo: Mike's playground - - - - - - -

- Welcome to the MasterKey Widget Set demo. -

- Enter a search above to begin, or - Visit the MKWS home page to find out more. -

- - - diff --git a/experiments/spclient/index-mkws.html b/experiments/spclient/index-mkws.html deleted file mode 100644 index 570f42e..0000000 --- a/experiments/spclient/index-mkws.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - MKWS: the MasterKey Widget Set - - - -

MKWS: the MasterKey Widget Set

- This site contains tools, not content: -

- mkws.js - -- - JavaScript code that powers the MasterKey Widget Set -
- /libjs-pz2/pz2api.1.js - -- - Low-level JavaScript library for access to the MasterKey web - service. -
- mkws-complete.js - -- - A single large JavaScript file containing everything needed for - MKWS to work: the widget-set itself, the API library, and any - additional prerequisites such as jQuery. -
- mkwsStyle.css - -- - A stylesheet which styles only MasterKey widgets, and does not - otherwise interfere with application-site's styles. - -

- For examples of how to use the widget-set, see: -

- A very simple application at - http://somesite.indexdata.com/. - It's worth viewing the source to see how small it is. -
- A more detailed version - that contains a configuration structure instead of accepting - the defaults. Includes a custom translation option to present - the application in Arabic. -
- The - jQuery plugin - version, consisting of a single line of JavaScript code. -
- An application that - uses lower-level MKWS components - rather than the all-in-one #mkwsResults division, - allowing it to use a rather different layout. -
- A version suitable for mobile devices, - with a responsive design that moves components around - depending on the screen size. -
- A version that uses a jQuery popup. -
- An existing web-site, - The Self-Appointed Grammar Police, - which has been fitted with an MKWS searching widget. - (See also the MKWS-widget customisations in - that site's stylesheet.) -
- Another existing web-site, - The Zthes specifications, - which has been fitted with a popup MKWS search-box. -

- The set of targets can be maintained: -

- Use the main - MasterKey Admin Console, - and act as the "MK Demo" library administrator. -

- Documentation is as yet in short supply: -

- The README (which may not be fully up to - date). -
- The structure of the HTML generated by the MKWS widgets, - which can be used to guide the customisation of its CSS styles. -

- - diff --git a/experiments/spclient/index-mobile.html b/experiments/spclient/index-mobile.html deleted file mode 100644 index decaf1c..0000000 --- a/experiments/spclient/index-mobile.html +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - MKWS demo: mobile-screen resizing - - - - - - - -

- -

- - - - diff --git a/experiments/spclient/index-popup.html b/experiments/spclient/index-popup.html deleted file mode 100644 index 01d3218..0000000 --- a/experiments/spclient/index-popup.html +++ /dev/null @@ -1,72 +0,0 @@ - - - - MKWS demo: popup search box - - - - - - - - - - - - - - - - - -

- -

- - - - - - diff --git a/experiments/spclient/index.html b/experiments/spclient/index.html deleted file mode 100644 index 687aec5..0000000 --- a/experiments/spclient/index.html +++ /dev/null @@ -1,16 +0,0 @@ - - - - MKWS demo client - - - - -

- - diff --git a/experiments/spclient/mkws.js b/experiments/spclient/mkws.js deleted file mode 100644 index 98ac5ee..0000000 --- a/experiments/spclient/mkws.js +++ /dev/null @@ -1,873 +0,0 @@ -/* 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; - -// 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 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" - } -}; - - -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]; - } - } -} - - -// 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": pazpar2path, - "oninit": my_oninit, - "onstat": my_onstat, - "onterm": my_onterm, - "termlist": "xtargets,subject,author", - "onbytarget": my_onbytarget, - "usesessions" : usesessions, - "showResponseType": '', // or "json" (for debugging?) - "onrecord": my_onrecord } ); -// some state vars -var curPage = 1; -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; -var AuthorMax = 10; - -// -// pz2.js event handlers: -// -function my_oninit() { - my_paz.stat(); - my_paz.bytarget(); -} - -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); - // 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(renderDetails(curDetRecData)); - } - html.push('

'); - } - replaceHtml(results, html.join('')); -} - -function my_onstat(data) { - var stat = document.getElementById("mkwsStat"); - if (stat == null) - return; - - stat.innerHTML = 'Status info' + - ' -- ' + - '' + data.activeclients + '/' + data.clients + '' + - ' -- ' + - '' + data.records + '/' + data.hits + ''; -} - -function my_onterm(data) { - // no facets - if (!mkws_config.facets || mkws_config.facets.length == 0) { - $("#mkwsTermlists").hide(); - return; - } - - // display if we first got results - $("#mkwsTermlists").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] + "'"); - } - } - - var termlist = document.getElementById("mkwsTermlists"); - replaceHtml(termlist, acc.join('')); - - if (mkws_config.responsive_design) - mkws_mobile_resize(); -} - -function add_single_facet(acc, caption, data, max, cclIndex) { - acc.push(''); -} - -function my_onrecord(data) { - // FIXME: record is async!! - clearTimeout(my_paz.recordTimer); - // in case on_show was faster to redraw element - var detRecordDiv = document.getElementById('mkwsDet_'+data.recid); - if (detRecordDiv) return; - curDetRecData = data; - var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid); - var html = renderDetails(curDetRecData); - recordDiv.innerHTML += html; -} - -function my_onbytarget(data) { - var targetDiv = document.getElementById("mkwsBytarget"); - var table ='' - +''; - - for (var i = 0; i < data.length; i++ ) { - table += ""; - } - - table += '

Target ID	Hits	Diags	Records	State
" + data[i].id + - "	" + data[i].hits + - "	" + data[i].diagnostic + - "	" + data[i].records + - "	" + data[i].state + "

'; - targetDiv.innerHTML = table; -} - -//////////////////////////////////////////////////////////////////////////////// -//////////////////////////////////////////////////////////////////////////////// - -// wait until the DOM is ready -function domReady () -{ - document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler; - document.mkwsSearchForm.mkwsQuery.value = ''; - if (document.mkwsSelect) { - if (document.mkwsSelect.mkwsSort) - document.mkwsSelect.mkwsSort.onchange = onSelectDdChange; - if (document.mkwsSelect.mkwsPerpage) - document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange; - } -} - -// when search button pressed -function onFormSubmitEventHandler() -{ - resetPage(); - loadSelect(); - triggerSearch(); - switchView('records'); // In case it's configured to start off as hidden - submitted = true; - return false; -} - -function onSelectDdChange() -{ - if (!submitted) return false; - resetPage(); - loadSelect(); - my_paz.show(0, recPerPage, curSort); - return false; -} - -function resetPage() -{ - curPage = 1; - totalRec = 0; -} - -function triggerSearch () -{ - my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter); -} - -function loadSelect () -{ - if (document.mkwsSelect) { - if (document.mkwsSelect.mkwsSort) - curSort = document.mkwsSelect.mkwsSort.value; - if (document.mkwsSelect.mkwsPerpage) - recPerPage = document.mkwsSelect.mkwsPerpage.value; - } -} - -// limit the query after clicking the facet -function limitQuery (field, value) -{ - document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"'; - onFormSubmitEventHandler(); -} - -// limit by target functions -function limitTarget (id, name) -{ - var navi = document.getElementById('mkwsNavi'); - navi.innerHTML = - 'Source: ' - + name + ''; - curFilter = 'pz:id=' + id; - resetPage(); - loadSelect(); - triggerSearch(); - return false; -} - -function delimitTarget () -{ - var navi = document.getElementById('mkwsNavi'); - navi.innerHTML = ''; - curFilter = null; - resetPage(); - loadSelect(); - triggerSearch(); - return false; -} - -function drawPager (pagerDiv) -{ - //client indexes pages from 1 but pz2 from 0 - var onsides = 6; - var pages = Math.ceil(totalRec / recPerPage); - - var firstClkbl = ( curPage - onsides > 0 ) - ? curPage - onsides - : 1; - - var lastClkbl = firstClkbl + 2*onsides < pages - ? firstClkbl + 2*onsides - : pages; - - var prev = '<< ' + M('Prev') + ' | '; - if (curPage > 1) - prev = '' - +'<< ' + M('Prev') + ' | '; - - var middle = ''; - for(var i = firstClkbl; i <= lastClkbl; i++) { - var numLabel = i; - if(i == curPage) - numLabel = '' + i + ''; - - middle += ' ' - + numLabel + ' '; - } - - var next = ' | ' + M('Next') + ' >>'; - if (pages - curPage > 0) - next = ' | ' - + M('Next') + ' >>'; - - var predots = ''; - if (firstClkbl > 1) - predots = '...'; - - var postdots = ''; - if (lastClkbl < pages) - postdots = '...'; - - pagerDiv.innerHTML += '

' - + prev + predots + middle + postdots + next + '

'; -} - -function showPage (pageNum) -{ - curPage = pageNum; - my_paz.showPage( curPage - 1 ); -} - -// simple paging functions - -function pagerNext() { - if ( totalRec - recPerPage*curPage > 0) { - my_paz.showNext(); - curPage++; - } -} - -function pagerPrev() { - if ( my_paz.showPrev() != false ) - curPage--; -} - -// switching view between targets and records - -function switchView(view) { - var targets = document.getElementById('mkwsTargets'); - var results = document.getElementById('mkwsResults') || - document.getElementById('mkwsRecords'); - var blanket = document.getElementById('mkwsBlanket'); - var motd = document.getElementById('mkwsEmbeddedMOTD'); - - switch(view) { - case 'targets': - if (targets) targets.style.display = "block"; - if (results) results.style.display = "none"; - if (blanket) blanket.style.display = "none"; - if (motd) motd.style.display = "none"; - break; - case 'records': - if (targets) targets.style.display = "none"; - if (results) results.style.display = "block"; - if (blanket) blanket.style.display = "block"; - if (motd) motd.style.display = "none"; - break; - case 'none': - if (targets) targets.style.display = "none"; - if (results) results.style.display = "none"; - if (blanket) blanket.style.display = "none"; - if (motd) motd.style.display = "none"; - break; - default: - alert("Unknown view '" + view + "'"); - } -} - -// detailed record drawing -function showDetails (prefixRecId) { - var recId = prefixRecId.replace('mkwsRec_', ''); - var oldRecId = curDetRecId; - curDetRecId = recId; - - // remove current detailed view if any - var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId); - // lovin DOM! - if (detRecordDiv) - detRecordDiv.parentNode.removeChild(detRecordDiv); - - // if the same clicked, just hide - if (recId == oldRecId) { - curDetRecId = ''; - curDetRecData = null; - return; - } - // request the record - my_paz.record(recId); -} - -function replaceHtml(el, html) { - var oldEl = typeof el === "string" ? document.getElementById(el) : el; - /*@cc_on // Pure innerHTML is slightly faster in IE - oldEl.innerHTML = html; - return oldEl; - @*/ - var newEl = oldEl.cloneNode(false); - newEl.innerHTML = html; - oldEl.parentNode.replaceChild(newEl, oldEl); - /* Since we just removed the old element from the DOM, return a reference - to the new element, which can be used to restore variable references. */ - return newEl; -}; - -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 + '

'; - - return details; -} - -function renderField(caption, data, data2, data3) { - if (data === undefined) { - return ""; - } - - 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: 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 mobile */ - 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); - - // For some reason, doing this programmatically results in - // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML. - debug("HTML search form"); - $("#mkwsSearch").html('\ - '); - - debug("HTML records"); - // If the application has an #mkwsResults, populate it in the - // usual way. If not, assume that it's a smarter application that - // defines its own subcomponents: - // #mkwsTermlists - // #mkwsRanking - // #mkwsPager - // #mkwsNavi - // #mkwsRecords - if ($("#mkwsResults").length) { - $("#mkwsResults").html('\ - \ - \ - \ - \ - \ -

\ -

'); - } - - if ($("#mkwsRanking").length) { - var ranking_data = ''; - ranking_data += ''; - - $("#mkwsRanking").html(ranking_data); - } - - 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").hide(); } ); - var elem = document.getElementById("mkwsMOTD"); - if (elem) { - // Move the MOTD from the provided element down into the embedded one - document.getElementById("mkwsEmbeddedMOTD").innerHTML = elem.innerHTML; - elem.style.display = "none"; - } -} - -/* 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() }, 50); - }); - - // 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: M("Records") - })); - $("#mkwsSwitch").append($("", { text: " | " })); - $("#mkwsSwitch").append($("", { - href: '#', - onclick: "switchView(\'targets\')", - text: M("Targets") - })); - - debug("HTML targets"); - $("#mkwsTargets").html('\ -

\ - 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) { - 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; - } - - 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()); - - var width = mkws_config.responsive_design_width || 980; - - if ($(window).width() <= width) { - for(var i = 0; i < list.length; i++) { - $("#" + list[i]).hide(); - } - - $("#mkwsTermlists").hide(); - obj = $("#mkwsTermlists").html(); - $("#mkwsShiftedTermlists").html(obj); - } else { - for(var i = 0; i < list.length; i++) { - $("#" + list[i]).show(); - } - $("#mkwsTermlists").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) }); diff --git a/experiments/spclient/mkwsStyle.css b/experiments/spclient/mkwsStyle.css deleted file mode 100644 index 08e2fbf..0000000 --- a/experiments/spclient/mkwsStyle.css +++ /dev/null @@ -1,196 +0,0 @@ -#mkwsLang, -#mkwsSwitch, -#mkwsSearch, -#mkwsTermlists, -#mkwsRanking, -#mkwsPager, -#mkwsNavi, -#mkwsRecords, -#mkwsTargets, -#mkwsStat, -#mkwsShiftedTermlists, -#mkwsEmbeddedMOTD { - font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Verdana, Sans-Serif; -} - -#mkwsLang { - float: left; - padding-left: 1em; - padding-top: 0.4em; -} - -#mkwsLang a { - background: #d0e0ff; - padding: 1px 4px; -} - -#mkwsLang span { - border: solid 1px #d0e0ff; - padding: 0px 3px; -} - -#mkwsSearch { - float: right; -} - -#mkwsSwitch { - float: right; - padding-left: 1em; - padding-top: 0.4em; -} - -#mkwsTargets { - background-color: #fafafa; -} - -#mkwsStat { - margin-top: 10px; - border-top: 1px solid #156a16; - padding-top: 5px; - font-size: small; -} - -#mkwsStat span.head { - font-weight: bold; -} - -#mkwsStat span.clients:before { - content: "Active clients: "; -} - -#mkwsStat span.records:before { - content: "Retrieved records: "; -} - -#mkwsSwitch a, -#mkwsLang a, -#mkwsTermlists a, -#mkwsRanking a, -#mkwsPager a, -#mkwsNavi a, -#mkwsRecords a, -#mkwsShiftedTermlists a { - color: #005701; - text-decoration: none; -} - -#mkwsSwitch a:hover, -#mkwsLang a:hover, -#mkwsTermlists a:hover, -#mkwsPager a:hover, -#mkwsRecords a:hover, -#mkwsShiftedTermlists a:hover { - text-decoration: underline; -} - -#mkwsNavi a.crossout:hover { - text-decoration: line-through; -} - -#mkwsSearch input#mkwsButton { - border: 3px outset #132194; - background-color: #132194; - padding: 2px; - width: 6em; - color: #FFFFFF; - font-weight: bold; - text-transform: uppercase; - font-size: 10px; - margin-left: 8px; - cursor: pointer; -} - -#mkwsSearch input#mkwsQuery { - border: 2px inset #e0f0ff; - padding: 3px; - font-size: 12px; - background: #f0f8ff; -} - -#mkwsTermlists .title, -#mkwsShiftedTermlists .title { - font-size: large; - font-weight: bold; - text-transform: uppercase; -} - -#mkwsTermlists, -#mkwsShiftedTermlists div#termlist { - background: #d0e0ff; - padding: 0.7em; - font-size: small; - - border-top-right-radius: 10px; - -moz-border-top-right-radius: 10px; - -webkit-border-top-right-radius: 10px; -} - -#mkwsTermlists div.facet, -#mkwsShiftedTermlists div.facet { - background: #e0f0ff; - padding: 0.7em; - margin-top: 0.7em; - - border-top-right-radius: 10px; - -moz-border-top-right-radius: 10px; - -webkit-border-top-right-radius: 10px; -} - -#mkwsTermlists div.termtitle, -#mkwsShiftedTermlists div.termtitle { - font-weight: bold; -} - -#mkwsRecords div.record, -#mkwsShiftedTermlists div.record { - padding: 5px; -} - -#mkwsRecords div.details { - border: 1px solid #404040; - background: #e8e8e8; - color: darkgray; - padding: 5px 10px; - margin: 10px 0px; - box-shadow: 10px 10px 5px #808080; - - border-top-right-radius: 10px; - -moz-border-top-right-radius: 10px; - -webkit-border-top-right-radius: 10px; -} - -#mkwsRecords div.details th, -#mkwsShiftedTermlists div.details th { - text-align: right; - vertical-align: top; - padding-right: 0.6em; -} - -#mkwsRecords div.details th:after, -#mkwsShiftedTermlists div.details th:after { - content: ":"; -} - -#mkwsPager { - background: #e0e0e0; - padding: 0.3em; -} - -#mkwsBytarget table thead tr td { - background-color: #132194; - color: white; - font-weight: bold; - padding: 0.2em 0.5em; -} - -#mkwsBytarget table tbody tr:nth-child(odd) { - background-color: #e0f0ff; -} - -#mkwsBytarget table tbody tr:nth-child(even) { - background-color: #d0e0ff; -} - -#mkwsBytarget table tbody tr td { - padding: 0.2em 0.5em; -} diff --git a/experiments/spclient/robots.txt b/experiments/spclient/robots.txt deleted file mode 100644 index 1f53798..0000000 --- a/experiments/spclient/robots.txt +++ /dev/null @@ -1,2 +0,0 @@ -User-agent: * -Disallow: / diff --git a/tools/apache2/README b/tools/apache2/README new file mode 100644 index 0000000..351fc7f --- /dev/null +++ b/tools/apache2/README @@ -0,0 +1,5 @@ +You will need to enable the Rewrite module for this to work: + +$ sudo a2enmod rewrite +$ sudo service apache2 reload + diff --git a/tools/apache2/mkws-dev b/tools/apache2/mkws-dev new file mode 100644 index 0000000..b4a7e8a --- /dev/null +++ b/tools/apache2/mkws-dev @@ -0,0 +1,26 @@ +# Configuration for the apache web server -*- apache -*- + +# pazpar2 / service proxy config + + ServerName spclient.example.com + ServerAlias spclient-dev.indexdata.com + ServerAdmin webmaster@example.com + ErrorLog /var/log/apache2/spdemo-error.log + CustomLog /var/log/apache2/spdemo-access.log combined + + RewriteEngine on + RewriteLogLevel 1 + RewriteLog /var/log/apache2/spdemo-rewrite.log + + DocumentRoot /home/indexdata/mkws/experiments/spclient + + RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=guest&password=guest [P] # [NE,P] + + ProxyPass /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ + ProxyPassReverse /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ + + ProxyPass /pazpar2/ http://localhost:8004/pazpar2/ + ProxyPassReverse /pazpar2/ http://localhost:8004/pazpar2/ + + + diff --git a/tools/apache2/mkws-live b/tools/apache2/mkws-live new file mode 100644 index 0000000..dfa7ed4 --- /dev/null +++ b/tools/apache2/mkws-live @@ -0,0 +1,39 @@ +# Configuration for the apache web server +# Running on caliban + + + + ServerName somesite.indexdata.com + DocumentRoot /home/indexdata/mkws/experiments/spclient/ + ErrorLog /var/log/apache2/somesite-error.log + CustomLog /var/log/apache2/somesite-access.log combined + + + + + ServerName mkws.indexdata.com + + ErrorLog /var/log/apache2/mkws-error.log + CustomLog /var/log/apache2/mkws-access.log combined + + DocumentRoot /home/indexdata/mkws/experiments/spclient/ + Alias /libjs-pz2/ /home/indexdata/libjs-pz2/ + Alias /index.html /home/indexdata/mkws/experiments/spclient/index-mkws.html + + RewriteEngine on + RewriteLogLevel 1 + RewriteLog /var/log/apache2/mkws-rewrite.log + RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=demo&password=demo [P] # [NE,P] + + Header set Access-Control-Allow-Credentials true + + # For MKC Service Proxy + ProxyPass /service-proxy/ http://mk2-test.indexdata.com/service-proxy/ + ProxyPassReverse /service-proxy/ http://mk2-test.indexdata.com/service-proxy/ + + PerlOptions +Parent + PerlSwitches -I/home/indexdata/mkws/etc/mod_perl + + PerlOutputFilterHandler MyApache2::SetACAO + + diff --git a/tools/apache2/mkws-mike b/tools/apache2/mkws-mike new file mode 100644 index 0000000..44efb2b --- /dev/null +++ b/tools/apache2/mkws-mike @@ -0,0 +1,29 @@ +# Configuration for the apache web server +# Running on Mike's local development box + + + ServerName x.spclient.indexdata.com + ErrorLog /var/log/apache2/spclient-error.log + CustomLog /var/log/apache2/spclient-access.log combined + + DocumentRoot /usr/local/src/git/mkws/experiments/spclient/ + Alias /libjs-pz2/ /usr/local/src/git/libjs-pz2/ + + RewriteEngine on + RewriteLogLevel 1 + RewriteLog /var/log/apache2/spclient-rewrite.log + RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=guest&password=guest [P] # [NE,P] + + # For MKC Service Proxy + ProxyPass /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ + ProxyPassReverse /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ + + # For local Service Proxy running as mvn jetty:run + #ProxyPass /service-proxy/ http://localhost:8585/service-proxy/ + #ProxyPassReverse /service-proxy/ http://localhost:8585/service-proxy/ + + # Needed on Mac, which locks Apache down hard by default. + + Allow from all + + diff --git a/tools/apache2/mkws-proxy b/tools/apache2/mkws-proxy new file mode 100644 index 0000000..4e16c51 --- /dev/null +++ b/tools/apache2/mkws-proxy @@ -0,0 +1,19 @@ + + ServerName mkws.indexdata.com + ServerAlias somesite.indexdata.com + + ProxyRequests off + ProxyVia On + ProxyPreserveHost On + + Order deny,allow + Allow from all + + + ProxyPass / http://caliban:80/ + ProxyPassReverse / http://caliban:80/ + + # These are the logs for the proxying operation + ErrorLog /var/log/apache2/mkws-proxy-error.log + CustomLog /var/log/apache2/mkws-proxy-access.log combined + diff --git a/tools/htdocs/.gitignore b/tools/htdocs/.gitignore new file mode 100644 index 0000000..a7392c7 --- /dev/null +++ b/tools/htdocs/.gitignore @@ -0,0 +1 @@ +mkws-complete.js diff --git a/tools/htdocs/Makefile b/tools/htdocs/Makefile new file mode 100644 index 0000000..38d83f4 --- /dev/null +++ b/tools/htdocs/Makefile @@ -0,0 +1,23 @@ +###################################################################### +# Copyright (c) 2013 IndexData ApS. http://indexdata.com +# + +MKWS_JS= mkws-complete.js +all: ${MKWS_JS} + +mkws-js ${MKWS_JS}: ../../../libjs-pz2/pz2api.1.js mkws.js + ( echo "/* created at: $$(date)"; \ + echo " mkws.js GIT id: $$(git log mkws.js | head -n 1 | perl -npe 's,\S+\s+,,') */"; \ + curl -sSf http://code.jquery.com/jquery-1.10.0.min.js; \ + cat ../../../libjs-pz2/pz2api.1.js mkws.js ) > ${MKWS_JS}.new + mv -f ${MKWS_JS}.new ${MKWS_JS} + +distclean: clean +clean: + rm -f ${MKWS_JS} + +help: + @echo "make [ help | mkws-js | clean ]" + @echo "" + @echo "Please check ./README file too!" + diff --git a/tools/htdocs/README b/tools/htdocs/README new file mode 100644 index 0000000..bcd492c --- /dev/null +++ b/tools/htdocs/README @@ -0,0 +1,128 @@ +An embryonic MasterKey Widget Set +================================= + +This directory contains an embryonic MasterKey Widget Set, based +initially on "jsdemo" though now far removed from those beginnnings. + + +How this works +-------------- + +The goal is to make it that as much of the searching functionality as +possible is hosted on + http://mkws.indexdata.com/ +so that very simple websites such as + http://somesite.indexdata.com/ +can have MasterKey searching with minimal effort. + +The following files must be hosted on mkws.indexdata.com: + mkws.js + mkwsStyle.css + /libjs-pz2/pz2api.1.js (*) + +The following files make up the application: + index.html + favicon.ico [optional] + robots.txt [optional] + +(At present, the client application's configuruation also needs an +Alias for /service-proxy/, to avoid cross-site scripting issues. We +will fix this.) + +(*) if you don't have already installed libjs-pz2 on the machine, you can +do it by installing a debian package or check it out from GIT: +$ git clone ssh://git.indexdata.com:222/home/git/pub/libjs-pz2 + +Configuring a client +-------------------- + +The application's HTML must contains the following elements as well as +whatever makes up the application itself: + +Prerequisites: + + + + + +(Yes, we're using JQuery. We use it only in the most trivial ways, and +could probably get rid of it without too much pain. I'd like to have +mkws.js automatically pull in pz2api.1.js, too, so you don't need to +do so many things, but that's not quite trivial.) + +Then the following special

s can be added (with no content), and +will be filled in by MKWS: +

-- switch between record and target views +

-- switch between English, Danish and German +

-- search box and button +

-- result list, including pager/sorting +

-- target list, including status +

-- summary statistics + +At present, MKWS will not work correctly if any of these is +missing. One of the TODOs is to fix it so that it doesn't try to use +whatever is not there, and just uses what is. + + +You can configure and control the client with the JavaScript mkws_config object. + +Here is an example of all possible options + + +Note: the mkws_config object which must be loaded before the mkws.js and pz2api.js files. + +Supported Browsers +------------------ + +Any modern HTML5 browser will work fine. JavaScript must be enabled. + +* IE8 or later +* Firefox 17 or later +* Google Chrome 27 or later +* Safari 6 or later +* Opera 12 or later +* iOS 6.x (iPhone, iPad) +* Android 4.x + +Not supported: IE6, IE7 + +New Features since jsdemo +-------------------------- +- multilinguality: English (default), Danish, German +- depends on the new pazpar2 JS library libjs-pz2/pz2api.1.js + which will make the development of pazpar2 plugins faster and + easier to share code between projects +- supports basic pazpar2 and service-proxy requests +- simplified HTML +- the search page is fully configurable by a JSON object + + +What next? +---------- + +Main areas of work: +* Make MKWS robust to missing widgets +* Clean up the code diff --git a/tools/htdocs/html-structure.txt b/tools/htdocs/html-structure.txt new file mode 100644 index 0000000..c6d0da8 --- /dev/null +++ b/tools/htdocs/html-structure.txt @@ -0,0 +1,62 @@ +The HTML structure of the MKWS

s is as follows. This is useful to +know when working on stylesheets. As in CSS, #ID indicates a unique +identifier and .CLASS indicates an instance of a class. + + +#mkwsSwitch + a* + +#mkwsLang + ( a | span )* + +#mkwsSearch + form + input#mkwsQuery type=text + input#mkwsButton type=submit + +#mkwsBlanket + (no contents -- used only for masking) + +#mkwsResults + table + tbody + tr + td + #mkwsTermlists + div.title + div.facet* + div.termtitle + ( a span br )* + td + div#mkwsRanking + form#mkwsSelect + select#mkwsSort + select#mkwsPerpage + #mkwsPager + #mkwsNavi + #mkwsRecords + div.record* + span (for sequence number) + a (for title) + span (for other information such as author) + div.details (sometimes) + table + tbody + tr* + th + td +#mkwsTargets + #mkwsBytarget + table + thead + tr* + td* + tbody + tr* + td* + +#mkwsStat + span.head + span.clients + span.records + diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js new file mode 100644 index 0000000..98ac5ee --- /dev/null +++ b/tools/htdocs/mkws.js @@ -0,0 +1,873 @@ +/* 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; + +// 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 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" + } +}; + + +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]; + } + } +} + + +// 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": pazpar2path, + "oninit": my_oninit, + "onstat": my_onstat, + "onterm": my_onterm, + "termlist": "xtargets,subject,author", + "onbytarget": my_onbytarget, + "usesessions" : usesessions, + "showResponseType": '', // or "json" (for debugging?) + "onrecord": my_onrecord } ); +// some state vars +var curPage = 1; +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; +var AuthorMax = 10; + +// +// pz2.js event handlers: +// +function my_oninit() { + my_paz.stat(); + my_paz.bytarget(); +} + +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); + // 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(renderDetails(curDetRecData)); + } + html.push('

'); + } + replaceHtml(results, html.join('')); +} + +function my_onstat(data) { + var stat = document.getElementById("mkwsStat"); + if (stat == null) + return; + + stat.innerHTML = 'Status info' + + ' -- ' + + '' + data.activeclients + '/' + data.clients + '' + + ' -- ' + + '' + data.records + '/' + data.hits + ''; +} + +function my_onterm(data) { + // no facets + if (!mkws_config.facets || mkws_config.facets.length == 0) { + $("#mkwsTermlists").hide(); + return; + } + + // display if we first got results + $("#mkwsTermlists").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] + "'"); + } + } + + var termlist = document.getElementById("mkwsTermlists"); + replaceHtml(termlist, acc.join('')); + + if (mkws_config.responsive_design) + mkws_mobile_resize(); +} + +function add_single_facet(acc, caption, data, max, cclIndex) { + acc.push(''); +} + +function my_onrecord(data) { + // FIXME: record is async!! + clearTimeout(my_paz.recordTimer); + // in case on_show was faster to redraw element + var detRecordDiv = document.getElementById('mkwsDet_'+data.recid); + if (detRecordDiv) return; + curDetRecData = data; + var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid); + var html = renderDetails(curDetRecData); + recordDiv.innerHTML += html; +} + +function my_onbytarget(data) { + var targetDiv = document.getElementById("mkwsBytarget"); + var table ='' + +''; + + for (var i = 0; i < data.length; i++ ) { + table += ""; + } + + table += '

Target ID	Hits	Diags	Records	State
" + data[i].id + + "	" + data[i].hits + + "	" + data[i].diagnostic + + "	" + data[i].records + + "	" + data[i].state + "

'; + targetDiv.innerHTML = table; +} + +//////////////////////////////////////////////////////////////////////////////// +//////////////////////////////////////////////////////////////////////////////// + +// wait until the DOM is ready +function domReady () +{ + document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler; + document.mkwsSearchForm.mkwsQuery.value = ''; + if (document.mkwsSelect) { + if (document.mkwsSelect.mkwsSort) + document.mkwsSelect.mkwsSort.onchange = onSelectDdChange; + if (document.mkwsSelect.mkwsPerpage) + document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange; + } +} + +// when search button pressed +function onFormSubmitEventHandler() +{ + resetPage(); + loadSelect(); + triggerSearch(); + switchView('records'); // In case it's configured to start off as hidden + submitted = true; + return false; +} + +function onSelectDdChange() +{ + if (!submitted) return false; + resetPage(); + loadSelect(); + my_paz.show(0, recPerPage, curSort); + return false; +} + +function resetPage() +{ + curPage = 1; + totalRec = 0; +} + +function triggerSearch () +{ + my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter); +} + +function loadSelect () +{ + if (document.mkwsSelect) { + if (document.mkwsSelect.mkwsSort) + curSort = document.mkwsSelect.mkwsSort.value; + if (document.mkwsSelect.mkwsPerpage) + recPerPage = document.mkwsSelect.mkwsPerpage.value; + } +} + +// limit the query after clicking the facet +function limitQuery (field, value) +{ + document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"'; + onFormSubmitEventHandler(); +} + +// limit by target functions +function limitTarget (id, name) +{ + var navi = document.getElementById('mkwsNavi'); + navi.innerHTML = + 'Source: ' + + name + ''; + curFilter = 'pz:id=' + id; + resetPage(); + loadSelect(); + triggerSearch(); + return false; +} + +function delimitTarget () +{ + var navi = document.getElementById('mkwsNavi'); + navi.innerHTML = ''; + curFilter = null; + resetPage(); + loadSelect(); + triggerSearch(); + return false; +} + +function drawPager (pagerDiv) +{ + //client indexes pages from 1 but pz2 from 0 + var onsides = 6; + var pages = Math.ceil(totalRec / recPerPage); + + var firstClkbl = ( curPage - onsides > 0 ) + ? curPage - onsides + : 1; + + var lastClkbl = firstClkbl + 2*onsides < pages + ? firstClkbl + 2*onsides + : pages; + + var prev = '<< ' + M('Prev') + ' | '; + if (curPage > 1) + prev = '' + +'<< ' + M('Prev') + ' | '; + + var middle = ''; + for(var i = firstClkbl; i <= lastClkbl; i++) { + var numLabel = i; + if(i == curPage) + numLabel = '' + i + ''; + + middle += ' ' + + numLabel + ' '; + } + + var next = ' | ' + M('Next') + ' >>'; + if (pages - curPage > 0) + next = ' | ' + + M('Next') + ' >>'; + + var predots = ''; + if (firstClkbl > 1) + predots = '...'; + + var postdots = ''; + if (lastClkbl < pages) + postdots = '...'; + + pagerDiv.innerHTML += '

' + + prev + predots + middle + postdots + next + '

'; +} + +function showPage (pageNum) +{ + curPage = pageNum; + my_paz.showPage( curPage - 1 ); +} + +// simple paging functions + +function pagerNext() { + if ( totalRec - recPerPage*curPage > 0) { + my_paz.showNext(); + curPage++; + } +} + +function pagerPrev() { + if ( my_paz.showPrev() != false ) + curPage--; +} + +// switching view between targets and records + +function switchView(view) { + var targets = document.getElementById('mkwsTargets'); + var results = document.getElementById('mkwsResults') || + document.getElementById('mkwsRecords'); + var blanket = document.getElementById('mkwsBlanket'); + var motd = document.getElementById('mkwsEmbeddedMOTD'); + + switch(view) { + case 'targets': + if (targets) targets.style.display = "block"; + if (results) results.style.display = "none"; + if (blanket) blanket.style.display = "none"; + if (motd) motd.style.display = "none"; + break; + case 'records': + if (targets) targets.style.display = "none"; + if (results) results.style.display = "block"; + if (blanket) blanket.style.display = "block"; + if (motd) motd.style.display = "none"; + break; + case 'none': + if (targets) targets.style.display = "none"; + if (results) results.style.display = "none"; + if (blanket) blanket.style.display = "none"; + if (motd) motd.style.display = "none"; + break; + default: + alert("Unknown view '" + view + "'"); + } +} + +// detailed record drawing +function showDetails (prefixRecId) { + var recId = prefixRecId.replace('mkwsRec_', ''); + var oldRecId = curDetRecId; + curDetRecId = recId; + + // remove current detailed view if any + var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId); + // lovin DOM! + if (detRecordDiv) + detRecordDiv.parentNode.removeChild(detRecordDiv); + + // if the same clicked, just hide + if (recId == oldRecId) { + curDetRecId = ''; + curDetRecData = null; + return; + } + // request the record + my_paz.record(recId); +} + +function replaceHtml(el, html) { + var oldEl = typeof el === "string" ? document.getElementById(el) : el; + /*@cc_on // Pure innerHTML is slightly faster in IE + oldEl.innerHTML = html; + return oldEl; + @*/ + var newEl = oldEl.cloneNode(false); + newEl.innerHTML = html; + oldEl.parentNode.replaceChild(newEl, oldEl); + /* Since we just removed the old element from the DOM, return a reference + to the new element, which can be used to restore variable references. */ + return newEl; +}; + +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 + '

'; + + return details; +} + +function renderField(caption, data, data2, data3) { + if (data === undefined) { + return ""; + } + + 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: 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 mobile */ + 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); + + // For some reason, doing this programmatically results in + // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML. + debug("HTML search form"); + $("#mkwsSearch").html('\ + '); + + debug("HTML records"); + // If the application has an #mkwsResults, populate it in the + // usual way. If not, assume that it's a smarter application that + // defines its own subcomponents: + // #mkwsTermlists + // #mkwsRanking + // #mkwsPager + // #mkwsNavi + // #mkwsRecords + if ($("#mkwsResults").length) { + $("#mkwsResults").html('\ + \ + \ + \ + \ + \ +

\ +

'); + } + + if ($("#mkwsRanking").length) { + var ranking_data = ''; + ranking_data += ''; + + $("#mkwsRanking").html(ranking_data); + } + + 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").hide(); } ); + var elem = document.getElementById("mkwsMOTD"); + if (elem) { + // Move the MOTD from the provided element down into the embedded one + document.getElementById("mkwsEmbeddedMOTD").innerHTML = elem.innerHTML; + elem.style.display = "none"; + } +} + +/* 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() }, 50); + }); + + // 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: M("Records") + })); + $("#mkwsSwitch").append($("", { text: " | " })); + $("#mkwsSwitch").append($("", { + href: '#', + onclick: "switchView(\'targets\')", + text: M("Targets") + })); + + debug("HTML targets"); + $("#mkwsTargets").html('\ +

\ + 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) { + 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; + } + + 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()); + + var width = mkws_config.responsive_design_width || 980; + + if ($(window).width() <= width) { + for(var i = 0; i < list.length; i++) { + $("#" + list[i]).hide(); + } + + $("#mkwsTermlists").hide(); + obj = $("#mkwsTermlists").html(); + $("#mkwsShiftedTermlists").html(obj); + } else { + for(var i = 0; i < list.length; i++) { + $("#" + list[i]).show(); + } + $("#mkwsTermlists").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) }); diff --git a/tools/htdocs/mkwsStyle.css b/tools/htdocs/mkwsStyle.css new file mode 100644 index 0000000..08e2fbf --- /dev/null +++ b/tools/htdocs/mkwsStyle.css @@ -0,0 +1,196 @@ +#mkwsLang, +#mkwsSwitch, +#mkwsSearch, +#mkwsTermlists, +#mkwsRanking, +#mkwsPager, +#mkwsNavi, +#mkwsRecords, +#mkwsTargets, +#mkwsStat, +#mkwsShiftedTermlists, +#mkwsEmbeddedMOTD { + font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Verdana, Sans-Serif; +} + +#mkwsLang { + float: left; + padding-left: 1em; + padding-top: 0.4em; +} + +#mkwsLang a { + background: #d0e0ff; + padding: 1px 4px; +} + +#mkwsLang span { + border: solid 1px #d0e0ff; + padding: 0px 3px; +} + +#mkwsSearch { + float: right; +} + +#mkwsSwitch { + float: right; + padding-left: 1em; + padding-top: 0.4em; +} + +#mkwsTargets { + background-color: #fafafa; +} + +#mkwsStat { + margin-top: 10px; + border-top: 1px solid #156a16; + padding-top: 5px; + font-size: small; +} + +#mkwsStat span.head { + font-weight: bold; +} + +#mkwsStat span.clients:before { + content: "Active clients: "; +} + +#mkwsStat span.records:before { + content: "Retrieved records: "; +} + +#mkwsSwitch a, +#mkwsLang a, +#mkwsTermlists a, +#mkwsRanking a, +#mkwsPager a, +#mkwsNavi a, +#mkwsRecords a, +#mkwsShiftedTermlists a { + color: #005701; + text-decoration: none; +} + +#mkwsSwitch a:hover, +#mkwsLang a:hover, +#mkwsTermlists a:hover, +#mkwsPager a:hover, +#mkwsRecords a:hover, +#mkwsShiftedTermlists a:hover { + text-decoration: underline; +} + +#mkwsNavi a.crossout:hover { + text-decoration: line-through; +} + +#mkwsSearch input#mkwsButton { + border: 3px outset #132194; + background-color: #132194; + padding: 2px; + width: 6em; + color: #FFFFFF; + font-weight: bold; + text-transform: uppercase; + font-size: 10px; + margin-left: 8px; + cursor: pointer; +} + +#mkwsSearch input#mkwsQuery { + border: 2px inset #e0f0ff; + padding: 3px; + font-size: 12px; + background: #f0f8ff; +} + +#mkwsTermlists .title, +#mkwsShiftedTermlists .title { + font-size: large; + font-weight: bold; + text-transform: uppercase; +} + +#mkwsTermlists, +#mkwsShiftedTermlists div#termlist { + background: #d0e0ff; + padding: 0.7em; + font-size: small; + + border-top-right-radius: 10px; + -moz-border-top-right-radius: 10px; + -webkit-border-top-right-radius: 10px; +} + +#mkwsTermlists div.facet, +#mkwsShiftedTermlists div.facet { + background: #e0f0ff; + padding: 0.7em; + margin-top: 0.7em; + + border-top-right-radius: 10px; + -moz-border-top-right-radius: 10px; + -webkit-border-top-right-radius: 10px; +} + +#mkwsTermlists div.termtitle, +#mkwsShiftedTermlists div.termtitle { + font-weight: bold; +} + +#mkwsRecords div.record, +#mkwsShiftedTermlists div.record { + padding: 5px; +} + +#mkwsRecords div.details { + border: 1px solid #404040; + background: #e8e8e8; + color: darkgray; + padding: 5px 10px; + margin: 10px 0px; + box-shadow: 10px 10px 5px #808080; + + border-top-right-radius: 10px; + -moz-border-top-right-radius: 10px; + -webkit-border-top-right-radius: 10px; +} + +#mkwsRecords div.details th, +#mkwsShiftedTermlists div.details th { + text-align: right; + vertical-align: top; + padding-right: 0.6em; +} + +#mkwsRecords div.details th:after, +#mkwsShiftedTermlists div.details th:after { + content: ":"; +} + +#mkwsPager { + background: #e0e0e0; + padding: 0.3em; +} + +#mkwsBytarget table thead tr td { + background-color: #132194; + color: white; + font-weight: bold; + padding: 0.2em 0.5em; +} + +#mkwsBytarget table tbody tr:nth-child(odd) { + background-color: #e0f0ff; +} + +#mkwsBytarget table tbody tr:nth-child(even) { + background-color: #d0e0ff; +} + +#mkwsBytarget table tbody tr td { + padding: 0.2em 0.5em; +} diff --git a/tools/mod_perl/MyApache2/CopyCookie.pm b/tools/mod_perl/MyApache2/CopyCookie.pm new file mode 100644 index 0000000..3e29647 --- /dev/null +++ b/tools/mod_perl/MyApache2/CopyCookie.pm @@ -0,0 +1,41 @@ +package MyApache2::CopyCookie; + +use Apache2::Filter (); +use Apache2::RequestRec (); +use APR::Table (); + +use Apache2::Const -compile => qw(OK); + +use constant BUFF_LEN => 1024; + +sub handler { + my $f = shift; + + # If the server generated a new cookie, make it available in a + # header other than the magic "Cookie" that clients can't read. + my $ho = $f->r->headers_out; + my $cookie = $ho->get('Set-Cookie'); + if (defined $cookie && $cookie ne "") { + $ho->set('X-Set-Cake', $cookie); + } + + # If the client sent an existing cookie as X-Cake, but didn't + # set Cookie, copy the former to the latter. + my $hi = $f->r->headers_in; + $cookie = $hi->get('Cookie'); + if (!defined $cookie || $cookie eq "") { + $cookie = $hi->get('X-Cake'); + if (defined $cookie && $cookie ne "") { + warn "copying X-Cake '$cookie' to Cookie"; + $hi->set('Cookie', $cookie); + } + } + + while ($f->read(my $buffer, BUFF_LEN)) { + $f->print($buffer); + } + + return Apache2::Const::OK; +} + +1; diff --git a/tools/mod_perl/MyApache2/SetACAO.pm b/tools/mod_perl/MyApache2/SetACAO.pm new file mode 100644 index 0000000..66334fc --- /dev/null +++ b/tools/mod_perl/MyApache2/SetACAO.pm @@ -0,0 +1,30 @@ +package MyApache2::SetACAO; + +use Apache2::Filter (); +use Apache2::RequestRec (); +use APR::Table (); + +use Apache2::Const -compile => qw(OK); + +use constant BUFF_LEN => 1024; + +sub handler { + my $f = shift; + + # If the client generated an Origin header, echo its content back + # in an ACAO header. This is better than just using *, since it + # doesnt prevent credentials from being accepted. + my $origin = $f->r->headers_in->get('Origin'); + if (defined $origin && $origin ne "") { + $f->r->headers_out->set('Access-Control-Allow-Origin', $origin); + warn "MyApache2::SetACAO copied Origin '$origin' to ACAO"; + } + + while ($f->read(my $buffer, BUFF_LEN)) { + $f->print($buffer); + } + + return Apache2::Const::OK; +} + +1;