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) {
161 if (!mkws_config.termlist_menu)
165 termlists.push('<div class="title">' + M('Termlists') + '</div>');
167 termlists.push('<div class="facet">');
168 termlists.push('<div class="termtitle">' + M('Sources') + '</div>');
169 for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
170 termlists.push('<a href="#" target_id='+data.xtargets[i].id
171 + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
172 + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
174 termlists.push('</div>');
176 termlists.push('<div class="facet">');
177 termlists.push('<div class="termtitle">' + M('Subjects') + '</div>');
178 for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
179 termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span> ('
180 + data.subject[i].freq + ')</span><br/>');
182 termlists.push('</div>');
184 termlists.push('<div class="facet">');
185 termlists.push('<div class="termtitle">' + M('Authors') + '</div>');
186 for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
187 termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
188 + data.author[i].name
190 + data.author[i].freq
193 termlists.push('</div>');
195 var termlist = document.getElementById("termlist");
196 replaceHtml(termlist, termlists.join(''));
199 function my_onrecord(data) {
200 // FIXME: record is async!!
201 clearTimeout(my_paz.recordTimer);
202 // in case on_show was faster to redraw element
203 var detRecordDiv = document.getElementById('det_'+data.recid);
204 if (detRecordDiv) return;
205 curDetRecData = data;
206 var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
207 var html = renderDetails(curDetRecData);
208 recordDiv.innerHTML += html;
211 function my_onbytarget(data) {
212 var targetDiv = document.getElementById("bytarget");
213 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
214 +'<td>Records</td><td>State</td></tr></thead><tbody>';
216 for (var i = 0; i < data.length; i++ ) {
217 table += "<tr><td>" + data[i].id +
218 "</td><td>" + data[i].hits +
219 "</td><td>" + data[i].diagnostic +
220 "</td><td>" + data[i].records +
221 "</td><td>" + data[i].state + "</td></tr>";
224 table += '</tbody></table>';
225 targetDiv.innerHTML = table;
228 ////////////////////////////////////////////////////////////////////////////////
229 ////////////////////////////////////////////////////////////////////////////////
231 // wait until the DOM is ready
234 document.search.onsubmit = onFormSubmitEventHandler;
235 document.search.query.value = '';
236 document.select.sort.onchange = onSelectDdChange;
237 document.select.perpage.onchange = onSelectDdChange;
240 // when search button pressed
241 function onFormSubmitEventHandler()
246 switchView('records'); // In case it's configured to start off as hidden
251 function onSelectDdChange()
253 if (!submitted) return false;
256 my_paz.show(0, recPerPage, curSort);
266 function triggerSearch ()
268 my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
271 function loadSelect ()
273 curSort = document.select.sort.value;
274 recPerPage = document.select.perpage.value;
277 // limit the query after clicking the facet
278 function limitQuery (field, value)
280 document.search.query.value += ' and ' + field + '="' + value + '"';
281 onFormSubmitEventHandler();
284 // limit by target functions
285 function limitTarget (id, name)
287 var navi = document.getElementById('navi');
289 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
291 navi.innerHTML += '<hr/>';
292 curFilter = 'pz:id=' + id;
299 function delimitTarget ()
301 var navi = document.getElementById('navi');
310 function drawPager (pagerDiv)
312 //client indexes pages from 1 but pz2 from 0
314 var pages = Math.ceil(totalRec / recPerPage);
316 var firstClkbl = ( curPage - onsides > 0 )
320 var lastClkbl = firstClkbl + 2*onsides < pages
321 ? firstClkbl + 2*onsides
324 var prev = '<span id="prev"><< ' + M('Prev') + '</span><b> | </b>';
326 prev = '<a href="#" id="prev" onclick="pagerPrev();">'
327 +'<< ' + M('Prev') + '</a><b> | </b>';
330 for(var i = firstClkbl; i <= lastClkbl; i++) {
333 numLabel = '<b>' + i + '</b>';
335 middle += '<a href="#" onclick="showPage(' + i + ')"> '
336 + numLabel + ' </a>';
339 var next = '<b> | </b><span id="next">' + M('Next') + ' >></span>';
340 if (pages - curPage > 0)
341 next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
342 + M('Next') + ' >></a>';
349 if (lastClkbl < pages)
352 pagerDiv.innerHTML += '<div style="float: clear">'
353 + prev + predots + middle + postdots + next + '</div><hr/>';
356 function showPage (pageNum)
359 my_paz.showPage( curPage - 1 );
362 // simple paging functions
364 function pagerNext() {
365 if ( totalRec - recPerPage*curPage > 0) {
371 function pagerPrev() {
372 if ( my_paz.showPrev() != false )
376 // swithing view between targets and records
378 function switchView(view) {
380 var targets = document.getElementById('mkwsTargets');
381 var records = document.getElementById('mkwsRecords');
382 var blanket = document.getElementById('mkwsBlanket');
386 targets.style.display = "block";
387 records.style.display = "none";
388 if (blanket) { blanket.style.display = "none"; }
391 targets.style.display = "none";
392 records.style.display = "block";
393 if (blanket) { blanket.style.display = "block"; }
396 targets.style.display = "none";
397 records.style.display = "none";
398 if (blanket) { blanket.style.display = "none"; }
401 alert('Unknown view.');
405 // detailed record drawing
406 function showDetails (prefixRecId) {
407 var recId = prefixRecId.replace('rec_', '');
408 var oldRecId = curDetRecId;
411 // remove current detailed view if any
412 var detRecordDiv = document.getElementById('det_'+oldRecId);
415 detRecordDiv.parentNode.removeChild(detRecordDiv);
417 // if the same clicked, just hide
418 if (recId == oldRecId) {
420 curDetRecData = null;
423 // request the record
424 my_paz.record(recId);
427 function replaceHtml(el, html) {
428 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
429 /*@cc_on // Pure innerHTML is slightly faster in IE
430 oldEl.innerHTML = html;
433 var newEl = oldEl.cloneNode(false);
434 newEl.innerHTML = html;
435 oldEl.parentNode.replaceChild(newEl, oldEl);
436 /* Since we just removed the old element from the DOM, return a reference
437 to the new element, which can be used to restore variable references. */
441 function renderDetails(data, marker)
443 var details = '<div class="details" id="det_'+data.recid+'"><table>';
444 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
446 details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
447 details += renderField("Date", data["md-date"]);
448 details += renderField("Author", data["md-author"]);
449 details += renderField("URL", data["md-electronic-url"]);
450 details += renderField("Subject", data["location"][0]["md-subject"]);
451 details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
452 details += '</table></div>';
457 function renderField(caption, data, data2, data3) {
458 if (data === undefined) {
462 if (caption == "URL") {
463 data = '<a href="' + data + '" target="_blank">' + data + '</a>';
466 if (data2 != undefined) {
467 data = data + " (" + data2 + ")";
470 if (data3 != undefined) {
471 data = data + " <i>" + data3 + "</i>";
474 return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
479 * All the HTML stuff to render the search forms and
482 function mkws_html_all(config) {
484 /* default mkws config */
485 var mkws_config_default = {
486 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
487 perpage: [10, 20, 30, 50],
488 sort_default: "relevance",
491 switch_menu: true, /* show/hide Records|Targets menu */
492 lang_menu: true, /* show/hide language menu */
493 lang_display: [], /* display languages links for given languages, [] for all */
494 termlist_menu: true, /* show/hide termlist */
495 debug: 0, /* debug level for development: 0..2 */
500 /* set global debug flag early */
501 if (config.debug !== 'undefined') {
502 mkws_debug = config.debug;
503 } else if (mkws_config_default.debug !== 'undefined') {
504 mkws_debug = mkws_config_default.debug;
507 /* override standard config values by function parameters */
508 for (var k in mkws_config_default) {
509 if (typeof config[k] === 'undefined')
510 mkws_config[k] = mkws_config_default[k];
511 debug("Set config: " + k + ' => ' + mkws_config[k]);
514 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
515 debug("Reset query width: " + mkws_config.query_width);
516 mkws_config.query_width = 50;
519 mkws_set_lang(mkws_config);
520 if (mkws_config.lang_menu)
521 mkws_html_lang(mkws_config);
523 // For some reason, doing this programmatically results in
524 // document.search.query being undefined, hence the raw HTML.
525 debug("HTML search form");
526 $("#mkwsSearch").html('\
527 <form id="searchForm" name="search" action="" >\
528 <input id="query" type="text" size="' + mkws_config.query_width + '" />\
529 <input id="button" type="submit" value="' + M('Search') + '" />\
532 debug("HTML records");
533 $("#mkwsRecords").html('\
534 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
536 <td width="250" valign="top">\
537 <div id="termlist"></div>\
541 <form name="select" id="select" action="" >\
542 ' + M('Sort by') + ' ' + mkws_html_sort(config) + '\
543 ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
544 ' + M('per page') + '.\
547 <div id="pager"></div>\
548 <div id="navi"></div>\
549 <div id="results"></div>\
554 mkws_html_switch(config);
555 if (mkws_config.use_service_proxy)
556 mkws_service_proxy_auth(config.service_proxy_auth);
561 function mkws_set_lang(mkws_config) {
562 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
563 if (!lang || !mkws_locale_lang[lang]) {
564 mkws_config.lang = ""
566 mkws_config.lang = lang;
569 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
570 return mkws_config.lang;
573 function mkws_html_switch(config) {
574 debug("HTML switch");
576 $("#mkwsSwitch").html($("<a/>", {
578 onclick: "switchView(\'records\')",
581 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
582 $("#mkwsSwitch").append($("<a/>", {
584 onclick: "switchView(\'targets\')",
588 debug("HTML targets");
589 $("#mkwsTargets").html('\
591 No information available yet.\
593 $("#mkwsTargets").css("display", "none");
595 if (!config.switch_menu) {
596 debug("disable switch menu");
597 $("#mkwsSwitch").css("display", "none");
601 function mkws_html_sort(config) {
603 var sort_html = '<select name="sort" id="sort">';
605 for(var i = 0; i < config.sort.length; i++) {
606 var key = config.sort[i][0];
607 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
609 sort_html += '<option value="' + key + '"';
610 if (key == config.sort_default) {
611 sort_html += ' selected="selected"';
613 sort_html += '>' + val + '</option>';
615 sort_html += '</select>';
620 function mkws_html_perpage(config) {
621 debug("HTML perpage");
622 var perpage_html = '<select name="perpage" id="perpage">';
624 for(var i = 0; i < config.perpage.length; i++) {
625 var key = config.perpage[i];
627 perpage_html += '<option value="' + key + '"';
628 if (key == config.perpage_default) {
629 perpage_html += ' selected="selected"';
631 perpage_html += '>' + key + '</option>';
633 perpage_html += '</select>';
639 * Run service-proxy authentication in background (after page load).
640 * The username/password is configured in the apache config file
643 function mkws_service_proxy_auth(auth_url) {
645 auth_url = "http://mkws.indexdata.com/service-proxy-auth";
647 debug("Run service proxy auth URL: " + auth_url);
649 var request = new pzHttpRequest(auth_url);
650 request.get(null, function(data) {
651 if (!jQuery.isXMLDoc(data)) {
652 alert("service proxy auth response document is not valid XML document, give up!");
655 var status = $(data).find("status");
656 if (status.text() != "OK") {
657 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
663 /* create locale language menu */
664 function mkws_html_lang(mkws_config) {
665 var lang_default = "en";
666 var lang = mkws_config.lang || lang_default;
669 /* display a list of configured languages, or all */
670 var lang_display = mkws_config.lang_display || [];
672 for (var i = 0; i < lang_display.length; i++) {
673 hash[lang_display[i]] = 1;
676 for (var k in mkws_locale_lang) {
677 if (hash[k] == 1 || lang_display.length == 0)
682 if (lang_display.length == 0 || hash[lang_default] == 1)
683 list.push(lang_default);
685 debug("Language menu for: " + list.join(", "));
689 for(var i = 0; i < list.length; i++) {
698 data += ' <a href="?lang=' + l + '">' + l + '</a> '
702 $("#mkwsLang").html(data);
707 var lang = mkws_config.lang;
709 if (!lang || !mkws_locale_lang[lang])
712 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
715 /* implement jQuery.parseQuerystring() for parsing URL parameters */
717 parseQuerystring: function() {
719 var qs = window.location.search.replace('?', '');
720 var pairs = qs.split('&');
721 $.each(pairs, function(i, v){
722 var pair = v.split('=');
723 nvpair[pair[0]] = pair[1];
727 pazpar2: function(data) {
728 document.write('<div id="mkwsSwitch"></div>\
729 <div id="mkwsLang"></div>\
730 <div id="mkwsSearch"></div>\
731 <div id="mkwsRecords"></div>\
732 <div id="mkwsTargets"></div>\
734 <div id="mkwsStat"></div>\
735 <span>Powered by MKWS © 2013 <a href="http://www.indexdata.com">Index Data</a></span>\
738 mkws_html_all(mkws_config);
742 function debug(string) {
746 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
750 // you need to disable use strict at the top of the file!!!
751 if (mkws_debug >= 3) {
752 console.log(arguments.callee.caller);
753 } else if (mkws_debug >= 2) {
754 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
760 $(document).ready(function() { mkws_html_all(mkws_config) });