1 /* A very simple client that shows a basic usage of the pz2.js
4 "use strict"; // HTML5: disable for debug >= 2
7 * global config object: mkws_config
9 * needs to be defined in the HTML header before
10 * including this JS file
14 var mkws_config = {}; // for the guys who forgot to define mkws_config...
16 if (typeof mkws_config.use_service_proxy === 'undefined')
17 mkws_config.use_service_proxy = true;
21 var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
22 var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/";
24 var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
25 var usesessions = mkws_config.use_service_proxy ? false : true;
28 var mkws_locale_lang = {
31 "Subjects": "Schlagwörter",
32 "Sources": "Daten und Quellen",
33 "TERMLISTS": "Termlisten",
35 "Prev": "Zurück",
37 "Sort by": "Sortieren nach",
38 "and show": "und zeige",
39 "per page": "pro Seite",
40 "Displaying": "Zeige",
47 "Subject": "Schlagwort",
54 "Authors": "Forfattere",
57 "TERMLISTS": "TERMLISTS",
58 "Next": "Næste",
60 "Search": "Søg",
61 "Sort by": "Sorter efter",
63 "per page": "per side",
64 "Displaying": "Viser",
69 "Author": "Forfatter",
72 "Location": "Lokation",
78 // create a parameters array and pass it to the pz2's constructor
79 // then register the form submit event with the pz2.search function
80 // autoInit is set to true on default
81 var my_paz = new pz2( { "onshow": my_onshow,
82 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
83 "pazpar2path": pazpar2path,
87 "termlist": "xtargets,subject,author",
88 "onbytarget": my_onbytarget,
89 "usesessions" : usesessions,
90 "showResponseType": '', // or "json" (for debugging?)
91 "onrecord": my_onrecord } );
97 var curDetRecData = null;
98 var curSort = 'relevance';
100 var submitted = false;
106 // pz2.js event handlers:
108 function my_oninit() {
113 function my_onshow(data) {
114 totalRec = data.merged;
116 var pager = document.getElementById("pager");
117 pager.innerHTML = "";
118 pager.innerHTML +='<hr/><div style="float: right">' + M('Displaying') + ': '
119 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
120 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
121 + data.total + ')</div>';
124 var results = document.getElementById("results");
127 for (var i = 0; i < data.hits.length; i++) {
128 var hit = data.hits[i];
129 html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
130 +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
131 +'<a href="#" id="rec_'+hit.recid
132 +'" onclick="showDetails(this.id);return false;"><b>'
133 + hit["md-title"] +' </b></a>');
134 if (hit["md-title-remainder"] !== undefined) {
135 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
137 if (hit["md-title-responsibility"] !== undefined) {
138 html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
140 if (hit.recid == curDetRecId) {
141 html.push(renderDetails(curDetRecData));
145 replaceHtml(results, html.join(''));
148 function my_onstat(data) {
149 var stat = document.getElementById("mkwsStat");
153 stat.innerHTML = '<b>STATUS INFO</b> -- Active clients: '
155 + '/' + data.clients + ' -- </span>'
156 + '<span>Retrieved records: ' + data.records
157 + '/' + data.hits + ' :.</span>';
160 function my_onterm(data) {
161 if (!mkws_config.termlist_menu)
165 termlists.push('<hr/><b>' + M('TERMLISTS') + ':</b><hr/><div class="termtitle">' + M('Sources') + '</div>');
166 for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
167 termlists.push('<a href="#" target_id='+data.xtargets[i].id
168 + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
169 + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
172 termlists.push('<hr/><div class="termtitle">' + M('Subjects') + '</div>');
173 for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
174 termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span> ('
175 + data.subject[i].freq + ')</span><br/>');
178 termlists.push('<hr/><div class="termtitle">' + M('Authors') + '</div>');
179 for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
180 termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
181 + data.author[i].name
183 + data.author[i].freq
186 var termlist = document.getElementById("termlist");
187 replaceHtml(termlist, termlists.join(''));
190 function my_onrecord(data) {
191 // FIXME: record is async!!
192 clearTimeout(my_paz.recordTimer);
193 // in case on_show was faster to redraw element
194 var detRecordDiv = document.getElementById('det_'+data.recid);
195 if (detRecordDiv) return;
196 curDetRecData = data;
197 var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
198 var html = renderDetails(curDetRecData);
199 recordDiv.innerHTML += html;
202 function my_onbytarget(data) {
203 var targetDiv = document.getElementById("bytarget");
204 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
205 +'<td>Records</td><td>State</td></tr></thead><tbody>';
207 for (var i = 0; i < data.length; i++ ) {
208 table += "<tr><td>" + data[i].id +
209 "</td><td>" + data[i].hits +
210 "</td><td>" + data[i].diagnostic +
211 "</td><td>" + data[i].records +
212 "</td><td>" + data[i].state + "</td></tr>";
215 table += '</tbody></table>';
216 targetDiv.innerHTML = table;
219 ////////////////////////////////////////////////////////////////////////////////
220 ////////////////////////////////////////////////////////////////////////////////
222 // wait until the DOM is ready
225 document.search.onsubmit = onFormSubmitEventHandler;
226 document.search.query.value = '';
227 document.select.sort.onchange = onSelectDdChange;
228 document.select.perpage.onchange = onSelectDdChange;
231 // when search button pressed
232 function onFormSubmitEventHandler()
237 switchView('records'); // In case it's configured to start off as hidden
242 function onSelectDdChange()
244 if (!submitted) return false;
247 my_paz.show(0, recPerPage, curSort);
257 function triggerSearch ()
259 my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
262 function loadSelect ()
264 curSort = document.select.sort.value;
265 recPerPage = document.select.perpage.value;
268 // limit the query after clicking the facet
269 function limitQuery (field, value)
271 document.search.query.value += ' and ' + field + '="' + value + '"';
272 onFormSubmitEventHandler();
275 // limit by target functions
276 function limitTarget (id, name)
278 var navi = document.getElementById('navi');
280 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
282 navi.innerHTML += '<hr/>';
283 curFilter = 'pz:id=' + id;
290 function delimitTarget ()
292 var navi = document.getElementById('navi');
301 function drawPager (pagerDiv)
303 //client indexes pages from 1 but pz2 from 0
305 var pages = Math.ceil(totalRec / recPerPage);
307 var firstClkbl = ( curPage - onsides > 0 )
311 var lastClkbl = firstClkbl + 2*onsides < pages
312 ? firstClkbl + 2*onsides
315 var prev = '<span id="prev"><< ' + M('Prev') + '</span><b> | </b>';
317 prev = '<a href="#" id="prev" onclick="pagerPrev();">'
318 +'<< ' + M('Prev') + '</a><b> | </b>';
321 for(var i = firstClkbl; i <= lastClkbl; i++) {
324 numLabel = '<b>' + i + '</b>';
326 middle += '<a href="#" onclick="showPage(' + i + ')"> '
327 + numLabel + ' </a>';
330 var next = '<b> | </b><span id="next">' + M('Next') + ' >></span>';
331 if (pages - curPage > 0)
332 next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
333 + M('Next') + ' >></a>';
340 if (lastClkbl < pages)
343 pagerDiv.innerHTML += '<div style="float: clear">'
344 + prev + predots + middle + postdots + next + '</div><hr/>';
347 function showPage (pageNum)
350 my_paz.showPage( curPage - 1 );
353 // simple paging functions
355 function pagerNext() {
356 if ( totalRec - recPerPage*curPage > 0) {
362 function pagerPrev() {
363 if ( my_paz.showPrev() != false )
367 // swithing view between targets and records
369 function switchView(view) {
371 var targets = document.getElementById('mkwsTargets');
372 var records = document.getElementById('mkwsRecords');
376 targets.style.display = "block";
377 records.style.display = "none";
380 targets.style.display = "none";
381 records.style.display = "block";
384 alert('Unknown view.');
388 // detailed record drawing
389 function showDetails (prefixRecId) {
390 var recId = prefixRecId.replace('rec_', '');
391 var oldRecId = curDetRecId;
394 // remove current detailed view if any
395 var detRecordDiv = document.getElementById('det_'+oldRecId);
398 detRecordDiv.parentNode.removeChild(detRecordDiv);
400 // if the same clicked, just hide
401 if (recId == oldRecId) {
403 curDetRecData = null;
406 // request the record
407 my_paz.record(recId);
410 function replaceHtml(el, html) {
411 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
412 /*@cc_on // Pure innerHTML is slightly faster in IE
413 oldEl.innerHTML = html;
416 var newEl = oldEl.cloneNode(false);
417 newEl.innerHTML = html;
418 oldEl.parentNode.replaceChild(newEl, oldEl);
419 /* Since we just removed the old element from the DOM, return a reference
420 to the new element, which can be used to restore variable references. */
424 function renderDetails(data, marker)
426 var details = '<div class="details" id="det_'+data.recid+'"><table>';
427 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
428 if (data["md-title"] != undefined) {
429 details += '<tr><td><b>' + M('Title') + '</b></td><td><b>:</b> '+data["md-title"];
430 if (data["md-title-remainder"] !== undefined) {
431 details += ' : <span>' + data["md-title-remainder"] + ' </span>';
433 if (data["md-title-responsibility"] !== undefined) {
434 details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
436 details += '</td></tr>';
438 if (data["md-date"] != undefined)
439 details += '<tr><td><b>' + M('Date') + '</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
440 if (data["md-author"] != undefined)
441 details += '<tr><td><b>' + M('Author') + '</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
442 if (data["md-electronic-url"] != undefined)
443 details += '<tr><td><b>URL</b></td><td><b>:</b> <a href="' + data["md-electronic-url"] + '" target="_blank">' + data["md-electronic-url"] + '</a>' + '</td></tr>';
444 if (data["location"][0]["md-subject"] != undefined)
445 details += '<tr><td><b>' + M('Subject') + '</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
446 if (data["location"][0]["@name"] != undefined)
447 details += '<tr><td><b>' + M('Location') + '</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
448 details += '</table></div>';
453 * All the HTML stuff to render the search forms and
456 function mkws_html_all(config) {
458 /* default mkws config */
459 var mkws_config_default = {
460 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
461 perpage: [10, 20, 30, 50],
462 sort_default: "relevance",
465 switch_menu: true, /* show/hide Records|Targets menu */
466 lang_menu: true, /* show/hide language menu */
467 lang_display: [], /* display languages links for given languages, [] for all */
468 termlist_menu: true, /* show/hide termlist */
469 debug: 0, /* debug level for development: 0..2 */
474 /* set global debug flag early */
475 if (config.debug !== 'undefined') {
476 mkws_debug = config.debug;
477 } else if (mkws_config_default.debug !== 'undefined') {
478 mkws_debug = mkws_config_default.debug;
481 /* override standard config values by function parameters */
482 for (var k in mkws_config_default) {
483 if (typeof config[k] === 'undefined')
484 mkws_config[k] = mkws_config_default[k];
485 debug("Set config: " + k + ' => ' + mkws_config[k]);
488 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
489 debug("Reset query width: " + mkws_config.query_width);
490 mkws_config.query_width = 50;
493 mkws_set_lang(mkws_config);
494 if (mkws_config.lang_menu)
495 mkws_html_lang(mkws_config);
497 // For some reason, doing this programmatically results in
498 // document.search.query being undefined, hence the raw HTML.
499 debug("HTML search form");
500 $("#mkwsSearch").html('\
501 <form id="searchForm" name="search" action="" >\
502 <input id="query" type="text" size="' + mkws_config.query_width + '" />\
503 <input id="button" type="submit" value="' + M('Search') + '" />\
506 debug("HTML records");
507 $("#mkwsRecords").html('\
508 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
510 <td width="250" valign="top">\
511 <div id="termlist"></div>\
515 <form name="select" id="select" action="" >\
516 ' + M('Sort by') + mkws_html_sort(config) + '\
517 ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
518 ' + M('per page') + '.\
521 <div id="pager"></div>\
522 <div id="navi"></div>\
523 <div id="results"></div>\
528 mkws_html_switch(config);
529 if (mkws_config.use_service_proxy)
530 mkws_service_proxy_auth(config.service_proxy_auth);
535 function mkws_set_lang(mkws_config) {
536 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
537 if (!lang || !mkws_locale_lang[lang]) {
538 mkws_config.lang = ""
540 mkws_config.lang = lang;
543 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
544 return mkws_config.lang;
547 function mkws_html_switch(config) {
548 debug("HTML switch");
550 $("#mkwsSwitch").html($("<a/>", {
552 onclick: "switchView(\'records\')",
555 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
556 $("#mkwsSwitch").append($("<a/>", {
558 onclick: "switchView(\'targets\')",
562 debug("HTML targets");
563 $("#mkwsTargets").html('\
565 No information available yet.\
567 $("#mkwsTargets").css("display", "none");
569 if (!config.switch_menu) {
570 debug("disable switch menu");
571 $("#mkwsSwitch").css("display", "none");
575 function mkws_html_sort(config) {
577 var sort_html = '<select name="sort" id="sort">';
579 for(var i = 0; i < config.sort.length; i++) {
580 var key = config.sort[i][0];
581 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
583 sort_html += '<option value="' + key + '"';
584 if (key == config.sort_default) {
585 sort_html += ' selected="selected"';
587 sort_html += '>' + val + '</option>';
589 sort_html += '</select>';
594 function mkws_html_perpage(config) {
595 debug("HTML perpage");
596 var perpage_html = '<select name="perpage" id="perpage">';
598 for(var i = 0; i < config.perpage.length; i++) {
599 var key = config.perpage[i];
601 perpage_html += '<option value="' + key + '"';
602 if (key == config.perpage_default) {
603 perpage_html += ' selected="selected"';
605 perpage_html += '>' + key + '</option>';
607 perpage_html += '</select>';
613 * Run service-proxy authentication in background (after page load).
614 * The username/password is configured in the apache config file
617 function mkws_service_proxy_auth(auth_url) {
619 auth_url = "http://mkws.indexdata.com/service-proxy-auth";
621 debug("Run service proxy auth URL: " + auth_url);
623 var request = new pzHttpRequest(auth_url);
624 request.get(null, function(data) {
625 if (!jQuery.isXMLDoc(data)) {
626 alert("service proxy auth response document is not valid XML document, give up!");
629 var status = $(data).find("status");
630 if (status.text() != "OK") {
631 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
637 /* create locale language menu */
638 function mkws_html_lang(mkws_config) {
639 var lang_default = "en";
640 var lang = mkws_config.lang || lang_default;
643 /* display a list of configured languages, or all */
644 var lang_display = mkws_config.lang_display || [];
646 for (var i = 0; i < lang_display.length; i++) {
647 hash[lang_display[i]] = 1;
650 for (var k in mkws_locale_lang) {
651 if (hash[k] == 1 || lang_display.length == 0)
656 if (lang_display.length == 0 || hash[lang_default] == 1)
657 list.push(lang_default);
659 debug("Language menu for: " + list.join(", "));
663 for(var i = 0; i < list.length; i++) {
672 data += ' <a href="?lang=' + l + '">' + l + '</a> '
676 $("#mkwsLang").html(data);
681 var lang = mkws_config.lang;
683 if (!lang || !mkws_locale_lang[lang])
686 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
689 /* implement jQuery.parseQuerystring() for parsing URL parameters */
691 parseQuerystring: function() {
693 var qs = window.location.search.replace('?', '');
694 var pairs = qs.split('&');
695 $.each(pairs, function(i, v){
696 var pair = v.split('=');
697 nvpair[pair[0]] = pair[1];
701 pazpar2: function(data) {
702 document.write('<div id="mkwsSwitch"></div>\
703 <div id="mkwsLang"></div>\
704 <div id="mkwsSearch"></div>\
705 <div id="mkwsRecords"></div>\
706 <div id="mkwsTargets"></div>\
708 <div id="mkwsStat"></div>\
709 <span>Powered by MKWS © 2013 <a href="http://www.indexdata.com">Index Data</a></span>\
712 mkws_html_all(mkws_config);
716 function debug(string) {
720 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
724 // you need to disable use strict at the top of the file!!!
725 if (mkws_debug >= 3) {
726 console.log(arguments.callee.caller);
727 } else if (mkws_debug >= 2) {
728 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
734 $(document).ready(function() { mkws_html_all(mkws_config) });