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 = '<span class="head">Status info</span>' +
155 '<span class="clients">' + data.activeclients + '/' + data.clients + '</span>' +
157 '<span class="records">' + data.records + '/' + data.hits + '</span>';
160 function my_onterm(data) {
162 if (!mkws_config.facets || mkws_config.facets.length == 0) {
163 $("#termlist").parent().hide();
167 // display if we first got results
168 $("#termlist").parent().show();
171 termlists.push('<div class="title">' + M('Termlists') + '</div>');
172 var facets = mkws_config.facets;
174 for(var i = 0; i < facets.length; i++) {
175 if (facets[i] == "sources")
176 add_single_facet(termlists, "Sources", data.xtargets, SourceMax, null);
177 if (facets[i] == "subjects")
178 add_single_facet(termlists, "Subjects", data.subject, SubjectMax, "su");
179 if (facets[i] == "authors")
180 add_single_facet(termlists, "Authors", data.author, AuthorMax, "au");
183 var termlist = document.getElementById("termlist");
184 replaceHtml(termlist, termlists.join(''));
187 function add_single_facet(acc, caption, data, max, cclIndex) {
188 acc.push('<div class="facet">');
189 acc.push('<div class="termtitle">' + M(caption) + '</div>');
190 for (var i = 0; i < data.length && i < max; i++ ) {
191 acc.push('<a href="#" ');
194 // Special case: target selection
195 acc.push('target_id='+data[i].id+' ');
196 action = 'limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
198 action = 'limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
200 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
201 + '<span> (' + data[i].freq + ')</span><br/>');
206 function my_onrecord(data) {
207 // FIXME: record is async!!
208 clearTimeout(my_paz.recordTimer);
209 // in case on_show was faster to redraw element
210 var detRecordDiv = document.getElementById('det_'+data.recid);
211 if (detRecordDiv) return;
212 curDetRecData = data;
213 var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
214 var html = renderDetails(curDetRecData);
215 recordDiv.innerHTML += html;
218 function my_onbytarget(data) {
219 var targetDiv = document.getElementById("bytarget");
220 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
221 +'<td>Records</td><td>State</td></tr></thead><tbody>';
223 for (var i = 0; i < data.length; i++ ) {
224 table += "<tr><td>" + data[i].id +
225 "</td><td>" + data[i].hits +
226 "</td><td>" + data[i].diagnostic +
227 "</td><td>" + data[i].records +
228 "</td><td>" + data[i].state + "</td></tr>";
231 table += '</tbody></table>';
232 targetDiv.innerHTML = table;
235 ////////////////////////////////////////////////////////////////////////////////
236 ////////////////////////////////////////////////////////////////////////////////
238 // wait until the DOM is ready
241 document.search.onsubmit = onFormSubmitEventHandler;
242 document.search.query.value = '';
243 document.select.sort.onchange = onSelectDdChange;
244 document.select.perpage.onchange = onSelectDdChange;
247 // when search button pressed
248 function onFormSubmitEventHandler()
253 switchView('records'); // In case it's configured to start off as hidden
258 function onSelectDdChange()
260 if (!submitted) return false;
263 my_paz.show(0, recPerPage, curSort);
273 function triggerSearch ()
275 my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
278 function loadSelect ()
280 curSort = document.select.sort.value;
281 recPerPage = document.select.perpage.value;
284 // limit the query after clicking the facet
285 function limitQuery (field, value)
287 document.search.query.value += ' and ' + field + '="' + value + '"';
288 onFormSubmitEventHandler();
291 // limit by target functions
292 function limitTarget (id, name)
294 var navi = document.getElementById('navi');
296 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
298 navi.innerHTML += '<hr/>';
299 curFilter = 'pz:id=' + id;
306 function delimitTarget ()
308 var navi = document.getElementById('navi');
317 function drawPager (pagerDiv)
319 //client indexes pages from 1 but pz2 from 0
321 var pages = Math.ceil(totalRec / recPerPage);
323 var firstClkbl = ( curPage - onsides > 0 )
327 var lastClkbl = firstClkbl + 2*onsides < pages
328 ? firstClkbl + 2*onsides
331 var prev = '<span id="prev"><< ' + M('Prev') + '</span><b> | </b>';
333 prev = '<a href="#" id="prev" onclick="pagerPrev();">'
334 +'<< ' + M('Prev') + '</a><b> | </b>';
337 for(var i = firstClkbl; i <= lastClkbl; i++) {
340 numLabel = '<b>' + i + '</b>';
342 middle += '<a href="#" onclick="showPage(' + i + ')"> '
343 + numLabel + ' </a>';
346 var next = '<b> | </b><span id="next">' + M('Next') + ' >></span>';
347 if (pages - curPage > 0)
348 next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
349 + M('Next') + ' >></a>';
356 if (lastClkbl < pages)
359 pagerDiv.innerHTML += '<div style="float: clear">'
360 + prev + predots + middle + postdots + next + '</div><hr/>';
363 function showPage (pageNum)
366 my_paz.showPage( curPage - 1 );
369 // simple paging functions
371 function pagerNext() {
372 if ( totalRec - recPerPage*curPage > 0) {
378 function pagerPrev() {
379 if ( my_paz.showPrev() != false )
383 // swithing view between targets and records
385 function switchView(view) {
387 var targets = document.getElementById('mkwsTargets');
388 var records = document.getElementById('mkwsRecords');
389 var blanket = document.getElementById('mkwsBlanket');
393 targets.style.display = "block";
394 records.style.display = "none";
395 if (blanket) { blanket.style.display = "none"; }
398 targets.style.display = "none";
399 records.style.display = "block";
400 if (blanket) { blanket.style.display = "block"; }
403 targets.style.display = "none";
404 records.style.display = "none";
405 if (blanket) { blanket.style.display = "none"; }
408 alert('Unknown view.');
412 // detailed record drawing
413 function showDetails (prefixRecId) {
414 var recId = prefixRecId.replace('rec_', '');
415 var oldRecId = curDetRecId;
418 // remove current detailed view if any
419 var detRecordDiv = document.getElementById('det_'+oldRecId);
422 detRecordDiv.parentNode.removeChild(detRecordDiv);
424 // if the same clicked, just hide
425 if (recId == oldRecId) {
427 curDetRecData = null;
430 // request the record
431 my_paz.record(recId);
434 function replaceHtml(el, html) {
435 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
436 /*@cc_on // Pure innerHTML is slightly faster in IE
437 oldEl.innerHTML = html;
440 var newEl = oldEl.cloneNode(false);
441 newEl.innerHTML = html;
442 oldEl.parentNode.replaceChild(newEl, oldEl);
443 /* Since we just removed the old element from the DOM, return a reference
444 to the new element, which can be used to restore variable references. */
448 function renderDetails(data, marker)
450 var details = '<div class="details" id="det_'+data.recid+'"><table>';
451 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
453 details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
454 details += renderField("Date", data["md-date"]);
455 details += renderField("Author", data["md-author"]);
456 details += renderField("URL", data["md-electronic-url"]);
457 details += renderField("Subject", data["location"][0]["md-subject"]);
458 details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
459 details += '</table></div>';
464 function renderField(caption, data, data2, data3) {
465 if (data === undefined) {
469 if (caption == "URL") {
470 data = '<a href="' + data + '" target="_blank">' + data + '</a>';
473 if (data2 != undefined) {
474 data = data + " (" + data2 + ")";
477 if (data3 != undefined) {
478 data = data + " <i>" + data3 + "</i>";
481 return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
486 * All the HTML stuff to render the search forms and
489 function mkws_html_all(config) {
491 /* default mkws config */
492 var mkws_config_default = {
493 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
494 perpage: [10, 20, 30, 50],
495 sort_default: "relevance",
498 switch_menu: true, /* show/hide Records|Targets menu */
499 lang_menu: true, /* show/hide language menu */
500 lang_display: [], /* display languages links for given languages, [] for all */
501 facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
503 debug: 0, /* debug level for development: 0..2 */
508 /* set global debug flag early */
509 if (config.debug !== 'undefined') {
510 mkws_debug = config.debug;
511 } else if (mkws_config_default.debug !== 'undefined') {
512 mkws_debug = mkws_config_default.debug;
515 /* override standard config values by function parameters */
516 for (var k in mkws_config_default) {
517 if (typeof config[k] === 'undefined')
518 mkws_config[k] = mkws_config_default[k];
519 debug("Set config: " + k + ' => ' + mkws_config[k]);
522 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
523 debug("Reset query width: " + mkws_config.query_width);
524 mkws_config.query_width = 50;
527 mkws_set_lang(mkws_config);
528 if (mkws_config.lang_menu)
529 mkws_html_lang(mkws_config);
531 // For some reason, doing this programmatically results in
532 // document.search.query being undefined, hence the raw HTML.
533 debug("HTML search form");
534 $("#mkwsSearch").html('\
535 <form id="searchForm" name="search" action="" >\
536 <input id="query" type="text" size="' + mkws_config.query_width + '" />\
537 <input id="button" type="submit" value="' + M('Search') + '" />\
540 debug("HTML records");
541 $("#mkwsRecords").html('\
542 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
544 <td width="250" valign="top">\
545 <div id="termlist"></div>\
549 <form name="select" id="select" action="" >\
550 ' + M('Sort by') + ' ' + mkws_html_sort(config) + '\
551 ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
552 ' + M('per page') + '.\
555 <div id="pager"></div>\
556 <div id="navi"></div>\
557 <div id="results"></div>\
562 mkws_html_switch(config);
563 if (mkws_config.use_service_proxy)
564 mkws_service_proxy_auth(config.service_proxy_auth);
568 // on first page, hide the termlist
569 $(document).ready(function() { $("#termlist").parent().hide(); } );
572 function mkws_set_lang(mkws_config) {
573 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
574 if (!lang || !mkws_locale_lang[lang]) {
575 mkws_config.lang = ""
577 mkws_config.lang = lang;
580 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
581 return mkws_config.lang;
584 function mkws_html_switch(config) {
585 debug("HTML switch");
587 $("#mkwsSwitch").html($("<a/>", {
589 onclick: "switchView(\'records\')",
592 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
593 $("#mkwsSwitch").append($("<a/>", {
595 onclick: "switchView(\'targets\')",
599 debug("HTML targets");
600 $("#mkwsTargets").html('\
602 No information available yet.\
604 $("#mkwsTargets").css("display", "none");
606 if (!config.switch_menu) {
607 debug("disable switch menu");
608 $("#mkwsSwitch").css("display", "none");
612 function mkws_html_sort(config) {
614 var sort_html = '<select name="sort" id="sort">';
616 for(var i = 0; i < config.sort.length; i++) {
617 var key = config.sort[i][0];
618 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
620 sort_html += '<option value="' + key + '"';
621 if (key == config.sort_default) {
622 sort_html += ' selected="selected"';
624 sort_html += '>' + val + '</option>';
626 sort_html += '</select>';
631 function mkws_html_perpage(config) {
632 debug("HTML perpage");
633 var perpage_html = '<select name="perpage" id="perpage">';
635 for(var i = 0; i < config.perpage.length; i++) {
636 var key = config.perpage[i];
638 perpage_html += '<option value="' + key + '"';
639 if (key == config.perpage_default) {
640 perpage_html += ' selected="selected"';
642 perpage_html += '>' + key + '</option>';
644 perpage_html += '</select>';
650 * Run service-proxy authentication in background (after page load).
651 * The username/password is configured in the apache config file
654 function mkws_service_proxy_auth(auth_url) {
656 auth_url = "http://mkws.indexdata.com/service-proxy-auth";
658 debug("Run service proxy auth URL: " + auth_url);
660 var request = new pzHttpRequest(auth_url);
661 request.get(null, function(data) {
662 if (!jQuery.isXMLDoc(data)) {
663 alert("service proxy auth response document is not valid XML document, give up!");
666 var status = $(data).find("status");
667 if (status.text() != "OK") {
668 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
674 /* create locale language menu */
675 function mkws_html_lang(mkws_config) {
676 var lang_default = "en";
677 var lang = mkws_config.lang || lang_default;
680 /* display a list of configured languages, or all */
681 var lang_display = mkws_config.lang_display || [];
683 for (var i = 0; i < lang_display.length; i++) {
684 hash[lang_display[i]] = 1;
687 for (var k in mkws_locale_lang) {
688 if (hash[k] == 1 || lang_display.length == 0)
693 if (lang_display.length == 0 || hash[lang_default] == 1)
694 list.push(lang_default);
696 debug("Language menu for: " + list.join(", "));
700 for(var i = 0; i < list.length; i++) {
707 data += ' <span>' + l + '</span> ';
709 data += ' <a href="?lang=' + l + '">' + l + '</a> '
713 $("#mkwsLang").html(data);
718 var lang = mkws_config.lang;
720 if (!lang || !mkws_locale_lang[lang])
723 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
726 /* implement jQuery.parseQuerystring() for parsing URL parameters */
728 parseQuerystring: function() {
730 var qs = window.location.search.replace('?', '');
731 var pairs = qs.split('&');
732 $.each(pairs, function(i, v){
733 var pair = v.split('=');
734 nvpair[pair[0]] = pair[1];
738 pazpar2: function(data) {
739 document.write('<div id="mkwsSwitch"></div>\
740 <div id="mkwsLang"></div>\
741 <div id="mkwsSearch"></div>\
742 <div id="mkwsRecords"></div>\
743 <div id="mkwsTargets"></div>\
745 <div id="mkwsStat"></div>\
746 <span>Powered by MKWS © 2013 <a href="http://www.indexdata.com">Index Data</a></span>\
749 mkws_html_all(mkws_config);
753 function debug(string) {
757 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
761 // you need to disable use strict at the top of the file!!!
762 if (mkws_debug >= 3) {
763 console.log(arguments.callee.caller);
764 } else if (mkws_debug >= 2) {
765 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
771 $(document).ready(function() { mkws_html_all(mkws_config) });