1 /*! MKWS, the MasterKey Widget Set.
2 * Copyright (C) 2013-2014 Index Data
3 * See the file LICENSE for details
6 "use strict"; // HTML5: disable for debug_level >= 2
10 Handlebars.registerHelper('json', function(obj) {
15 Handlebars.registerHelper('translate', function(s) {
20 // We need {{attr '@name'}} because Handlebars can't parse {{@name}}
21 Handlebars.registerHelper('attr', function(attrName) {
22 return this[attrName];
27 * Use as follows: {{#if-any NAME1 having="NAME2"}}
28 * Applicable when NAME1 is the name of an array
29 * The guarded code runs only if at least one element of the NAME1
30 * array has a subelement called NAME2.
32 Handlebars.registerHelper('if-any', function(items, options) {
33 var having = options.hash.having;
34 for (var i in items) {
36 if (!having || item[having]) {
37 return options.fn(this);
44 Handlebars.registerHelper('first', function(items, options) {
45 var having = options.hash.having;
46 for (var i in items) {
48 if (!having || item[having]) {
49 return options.fn(item);
56 Handlebars.registerHelper('commaList', function(items, options) {
59 for (var i in items) {
60 if (i > 0) out += ", ";
61 out += options.fn(items[i])
68 Handlebars.registerHelper('index1', function(obj) {
69 return obj.data.index + 1;
74 // Set up global mkws object. Contains truly global state such as SP
75 // authentication, and a hash of team objects, indexed by windowid.
79 debug_level: 1, // Will be overridden from mkws_config, but
80 // initial value allows jQuery popup to use logging.
81 paz: undefined, // will be set up during initialisation
86 "Subjects": "Schlagwörter",
87 "Sources": "Daten und Quellen",
88 "source": "datenquelle",
89 "Termlists": "Termlisten",
91 "Prev": "Zurück",
93 "Sort by": "Sortieren nach",
94 "and show": "und zeige",
95 "per page": "pro Seite",
96 "Displaying": "Zeige",
104 "Subject": "Schlagwort",
105 "subject": "schlagwort",
107 "Records": "Datensätze",
108 "Targets": "Datenbanken",
114 "Authors": "Forfattere",
118 "Termlists": "Termlists",
119 "Next": "Næste",
121 "Search": "Søg",
122 "Sort by": "Sorter efter",
123 "and show": "og vis",
124 "per page": "per side",
125 "Displaying": "Viser",
130 "Author": "Forfatter",
131 "author": "forfatter",
133 "Subject": "Emneord",
134 "subject": "emneord",
135 "Location": "Lokation",
145 // The following PubSub code is modified from the jQuery manual:
146 // https://api.jquery.com/jQuery.Callbacks/
149 // mkws.queue("eventName").subscribe(function(param1, param2 ...) { ... });
150 // mkws.queue("eventName").publish(arg1, arg2, ...);
154 mkws.queue = function(id) {
156 var callbacks = $.Callbacks();
158 publish: callbacks.fire,
159 subscribe: callbacks.add,
160 unsubscribe: callbacks.remove
168 // Define empty mkws_config for simple applications that don't define it.
169 if (mkws_config == null || typeof mkws_config != 'object') {
170 var mkws_config = {};
174 // Factory function for widget objects.
175 function widget($, team, type, node) {
182 // ### More to do here, surely: e.g. wiring into the team
183 mkws.debug("made widget(team=" + team + ", type=" + type + ", node=" + node);
189 // Factory function for team objects. As much as possible, this uses
190 // only member variables (prefixed "m_") and inner functions with
191 // private scope. Some functions are visibl as member-functions to be
192 // called from outside code -- specifically, from generated
193 // HTML. These functions are that.switchView(), showDetails(),
194 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
195 // pagerPrev(), pagerNext(), showPage().
197 function team($, teamName) {
199 var m_teamName = teamName;
200 var m_submitted = false;
201 var m_query; // initially undefined
202 var m_sort; // will be set below
203 var m_perpage; // will be set below
207 var m_curDetRecId = '';
208 var m_curDetRecData = null;
210 // Timestamps for logging
214 var m_paz; // will be initialised below
218 var debug = function (s) {
220 var timestamp = ((now - m_debug_time.start)/1000).toFixed(3) + " (+" + ((now - m_debug_time.last)/1000).toFixed(3) + ") "
221 m_debug_time.last = now;
223 mkws.debug(m_teamName + ": " + timestamp + s);
226 debug("start running MKWS");
228 m_sort = mkws_config.sort_default;
229 debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to m_sort");
231 // ### should be in global code
232 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
233 debug("Reset query width: " + mkws_config.query_width);
234 mkws_config.query_width = 50;
237 // ### should be in global code
238 for (var key in mkws_config) {
239 if (mkws_config.hasOwnProperty(key)) {
240 if (key.match(/^language_/)) {
241 var lang = key.replace(/^language_/, "");
242 // Copy custom languages into list
243 mkws.locale_lang[lang] = mkws_config[key];
244 debug("Added locally configured language '" + lang + "'");
249 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
250 if (mkws_config.pazpar2_url.match(/^\/\//)) {
251 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
252 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
255 debug("Create main pz2 object");
256 // create a parameters array and pass it to the pz2's constructor
257 // then register the form submit event with the pz2.search function
258 // autoInit is set to true on default
259 m_paz = new pz2({ "onshow": my_onshow,
260 "windowid": teamName,
261 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
262 "pazpar2path": mkws_config.pazpar2_url,
265 "onterm": (mkws_config.facets.length ? my_onterm : undefined),
266 "termlist": mkws_config.facets.join(','),
267 "onbytarget": my_onbytarget,
268 "usesessions" : mkws_config.use_service_proxy ? false : true,
269 "showResponseType": '', // or "json" (for debugging?)
270 "onrecord": my_onrecord });
272 if (!isNaN(parseInt(mkws_config.perpage_default))) {
273 m_perpage = parseInt(mkws_config.perpage_default);
277 // Finds the node of the specified class within the current team
278 function findnode(selector, teamName) {
279 teamName ||= m_teamName;
280 return $(selector + '.mkwsTeam_' + m_teamName);
285 // pz2.js event handlers:
287 function my_oninit(teamName) {
294 function my_onshow(data, teamName) {
296 m_totalRec = data.merged;
298 var pager = findnode(".mkwsPager");
300 pager.html(drawPager(data))
303 var results = findnode(".mkwsRecords");
308 for (var i = 0; i < data.hits.length; i++) {
309 var hit = data.hits[i];
310 html.push('<div class="record" id="mkwsRecdiv_' + teamName + '_' + hit.recid + '" >',
313 if (hit.recid == m_curDetRecId) {
315 html.push(renderDetails(m_curDetRecData));
318 results.html(html.join(''));
322 function renderSummary(hit)
324 var template = loadTemplate("Summary");
325 hit._id = "mkwsRec_" + hit.recid;
326 hit._onclick = "mkws.showDetails('" + m_teamName + "', this.id);return false;"
327 return template(hit);
331 function my_onstat(data, teamName) {
333 var stat = findnode('.mkwsStat');
334 if (stat.length === 0)
337 stat.html('<span class="head">' + M('Status info') + '</span>' +
339 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
341 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
345 function my_onterm(data, teamName) {
347 var node = findnode(".mkwsTermlists");
348 if (node.length == 0) return;
350 // no facets: this should never happen
351 if (!mkws_config.facets || mkws_config.facets.length == 0) {
352 alert("my_onterm called even though we have no facets: " + $.toJSON(data));
357 // display if we first got results
361 acc.push('<div class="title">' + M('Termlists') + '</div>');
362 var facets = mkws_config.facets;
364 for(var i = 0; i < facets.length; i++) {
365 if (facets[i] == "xtargets") {
366 add_single_facet(acc, "Sources", data.xtargets, 16, null);
367 } else if (facets[i] == "subject") {
368 add_single_facet(acc, "Subjects", data.subject, 10, "subject");
369 } else if (facets[i] == "author") {
370 add_single_facet(acc, "Authors", data.author, 10, "author");
372 alert("bad facet configuration: '" + facets[i] + "'");
376 node.html(acc.join(''));
380 function add_single_facet(acc, caption, data, max, pzIndex) {
381 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + m_teamName + '">');
382 acc.push('<div class="termtitle">' + M(caption) + '</div>');
383 for (var i = 0; i < data.length && i < max; i++) {
384 acc.push('<div class="term">');
385 acc.push('<a href="#" ');
388 // Special case: target selection
389 acc.push('target_id='+data[i].id+' ');
390 if (!target_filtered(data[i].id)) {
391 action = 'mkws.limitTarget(\'' + m_teamName + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
394 action = 'mkws.limitQuery(\'' + m_teamName + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
396 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
397 + ' <span>' + data[i].freq + '</span>');
404 function target_filtered(id) {
405 for (var i = 0; i < m_filters.length; i++) {
406 if (m_filters[i].id === id ||
407 m_filters[i].id === 'pz:id=' + id) {
415 function my_onrecord(data, args, teamName) {
416 debug("record: teamName=" + teamName + ", m_teamName=" + m_teamName);
417 // FIXME: record is async!!
418 clearTimeout(m_paz.recordTimer);
419 // in case on_show was faster to redraw element
420 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
421 if (detRecordDiv) return;
422 m_curDetRecData = data;
423 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_curDetRecData.recid);
424 var html = renderDetails(m_curDetRecData);
425 recordDiv.innerHTML += html;
429 function my_onbytarget(data, teamName) {
431 var targetDiv = findnode('.mkwsBytarget');
436 var table ='<table><thead><tr>' +
437 '<td>' + M('Target ID') + '</td>' +
438 '<td>' + M('Hits') + '</td>' +
439 '<td>' + M('Diags') + '</td>' +
440 '<td>' + M('Records') + '</td>' +
441 '<td>' + M('State') + '</td>' +
442 '</tr></thead><tbody>';
444 for (var i = 0; i < data.length; i++) {
445 table += "<tr><td>" + data[i].id +
446 "</td><td>" + data[i].hits +
447 "</td><td>" + data[i].diagnostic +
448 "</td><td>" + data[i].records +
449 "</td><td>" + data[i].state + "</td></tr>";
452 table += '</tbody></table>';
453 targetDiv.html(table);
456 ////////////////////////////////////////////////////////////////////////////////
457 ////////////////////////////////////////////////////////////////////////////////
460 // when search button pressed
461 // ### This is closure, so can always just operate on its own team
462 function onFormSubmitEventHandler()
464 mkws.handle_node_with_team(this, function (tname) {
465 var val = findnode('.mkwsQuery').val();
466 mkws.teams[tname].newSearch(val);
473 // ### won't need to be externally visible once onFormSubmitEventHandler() is fixed.
474 // ### doesn't need windowid
475 that.newSearch = function(query, sort, targets, windowid)
477 debug("newSearch: " + query);
479 if (mkws_config.use_service_proxy && !mkws.authenticated) {
480 alert("searching before authentication");
488 triggerSearch(query, sort, targets, windowid);
489 that.switchView('records'); // In case it's configured to start off as hidden
494 function onSelectDdChange()
496 if (!m_submitted) return false;
499 m_paz.show(0, m_perpage, m_sort);
511 // ### doesn't need windowid
512 function triggerSearch (query, sort, targets, windowid)
517 // Re-use previous query/sort if new ones are not specified
525 // ### should support multiple |-separated targets
526 m_filters.push({ id: targets, name: targets });
529 for (var i in m_filters) {
530 var filter = m_filters[i];
534 if (filter.id.match(/^[a-z:]+[=~]/)) {
535 debug("filter '" + filter.id + "' already begins with SETTING OP");
537 filter.id = 'pz:id=' + filter.id;
539 pp2filter += filter.id;
543 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
549 params.limit = pp2limit;
552 params.windowid = windowid;
554 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
556 // We can use: params.torusquery = "udb=NAME"
557 // Note: that won't work when running against raw pazpar2
558 m_paz.search(m_query, m_perpage, m_sort, pp2filter, undefined, params);
562 function loadSelect ()
564 var node = findnode('.mkwsSort');
565 if (node.length && node.val() != m_sort) {
566 debug("changing m_sort from " + m_sort + " to " + node.val());
569 node = findnode('.mkwsPerpage');
570 if (node.length && node.val() != m_perpage) {
571 debug("changing m_perpage from " + m_perpage + " to " + node.val());
572 m_perpage = node.val();
577 // limit by target functions
578 that.limitTarget = function (id, name)
580 debug("limitTarget(id=" + id + ", name=" + name + ")");
581 m_filters.push({ id: id, name: name });
590 // limit the query after clicking the facet
591 that.limitQuery = function (field, value)
593 debug("limitQuery(field=" + field + ", value=" + value + ")");
594 m_filters.push({ field: field, value: value });
603 that.delimitTarget = function (id)
605 debug("delimitTarget(id=" + id + ")");
607 for (var i in m_filters) {
608 var filter = m_filters[i];
610 debug("delimitTarget() removing filter " + $.toJSON(filter));
612 debug("delimitTarget() keeping filter " + $.toJSON(filter));
613 newFilters.push(filter);
616 m_filters = newFilters;
626 that.delimitQuery = function (field, value)
628 debug("delimitQuery(field=" + field + ", value=" + value + ")");
630 for (var i in m_filters) {
631 var filter = m_filters[i];
633 field == filter.field &&
634 value == filter.value) {
635 debug("delimitQuery() removing filter " + $.toJSON(filter));
637 debug("delimitQuery() keeping filter " + $.toJSON(filter));
638 newFilters.push(filter);
641 m_filters = newFilters;
651 function redraw_navi ()
653 var navi = findnode('.mkwsNavi');
657 for (var i in m_filters) {
661 var filter = m_filters[i];
663 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
664 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
666 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
667 "', '" + filter.field + "', '" + filter.value + "'" +
668 ');return false;">' + filter.value + '</a>';
676 function drawPager (data)
678 var s = '<div style="float: right">' + M('Displaying') + ': '
679 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
680 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
681 + data.total + ')</div>';
683 //client indexes pages from 1 but pz2 from 0
685 var pages = Math.ceil(m_totalRec / m_perpage);
687 var firstClkbl = (m_curPage - onsides > 0)
688 ? m_curPage - onsides
691 var lastClkbl = firstClkbl + 2*onsides < pages
692 ? firstClkbl + 2*onsides
695 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
697 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + m_teamName + '\');">'
698 +'<< ' + M('Prev') + '</a><b> | </b>';
701 for(var i = firstClkbl; i <= lastClkbl; i++) {
704 numLabel = '<b>' + i + '</b>';
706 middle += '<a href="#" onclick="mkws.showPage(\'' + m_teamName + '\', ' + i + ')"> '
707 + numLabel + ' </a>';
710 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
711 if (pages - m_curPage > 0)
712 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + m_teamName + '\')">'
713 + M('Next') + ' >></a>';
720 if (lastClkbl < pages)
723 s += '<div style="float: clear">'
724 + prev + predots + middle + postdots + next + '</div>';
730 that.showPage = function (pageNum)
733 m_paz.showPage(m_curPage - 1);
737 // simple paging functions
738 that.pagerNext = function () {
739 if (m_totalRec - m_perpage*m_curPage > 0) {
746 that.pagerPrev = function () {
747 if (m_paz.showPrev() != false)
752 // switching view between targets and records
753 that.switchView = function(view) {
754 var targets = findnode('.mkwsTargets');
755 // ### Fix next line to use findnode()
756 var results = $('.mkwsResults.mkwsTeam_' + m_teamName + ',.mkwsRecords.mkwsTeam_' + m_teamName);
757 var blanket = findnode('.mkwsBlanket');
758 var motd = findnode('.mkwsMOTD');
762 if (targets) targets.css('display', 'block');
763 if (results) results.css('display', 'none');
764 if (blanket) blanket.css('display', 'none');
765 if (motd) motd.css('display', 'none');
768 if (targets) targets.css('display', 'none');
769 if (results) results.css('display', 'block');
770 if (blanket) blanket.css('display', 'block');
771 if (motd) motd.css('display', 'none');
774 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
775 if (targets) targets.css('display', 'none');
776 if (results) results.css('display', 'none');
777 if (blanket) blanket.css('display', 'none');
778 if (motd) motd.css('display', 'none');
781 alert("Unknown view '" + view + "'");
786 // detailed record drawing
787 that.showDetails = function (prefixRecId) {
788 var recId = prefixRecId.replace('mkwsRec_', '');
789 var oldRecId = m_curDetRecId;
790 m_curDetRecId = recId;
792 // remove current detailed view if any
793 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecId);
796 detRecordDiv.parentNode.removeChild(detRecordDiv);
798 // if the same clicked, just hide
799 if (recId == oldRecId) {
801 m_curDetRecData = null;
804 // request the record
805 debug("showDetails() requesting record '" + recId + "'");
810 function renderDetails(data, marker)
812 var template = loadTemplate("Record");
813 var details = template(data);
814 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
818 function loadTemplate(name)
820 var template = m_template[name];
822 if (template === undefined) {
823 // Fall back to generic template if there is no team-specific one
824 var node = findnode(".mkwsTemplate_" + name);
826 node = $(".mkwsTemplate_" + name + ".mkwsTeam_ALL");
829 var source = node.html();
831 source = defaultTemplate(name);
834 template = Handlebars.compile(source);
835 debug("compiled template '" + name + "'");
836 m_template[name] = template;
843 function defaultTemplate(name)
845 if (name === 'Record') {
849 <th>{{translate "Title"}}</th>\
852 {{#if md-title-remainder}}\
853 ({{md-title-remainder}})\
855 {{#if md-title-responsibility}}\
856 <i>{{md-title-responsibility}}</i>\
862 <th>{{translate "Date"}}</th>\
863 <td>{{md-date}}</td>\
868 <th>{{translate "Author"}}</th>\
869 <td>{{md-author}}</td>\
872 {{#if md-electronic-url}}\
874 <th>{{translate "Links"}}</th>\
876 {{#each md-electronic-url}}\
877 <a href="{{this}}">Link{{index1}}</a>\
882 {{#if-any location having="md-subject"}}\
884 <th>{{translate "Subject"}}</th>\
886 {{#first location having="md-subject"}}\
888 {{#commaList md-subject}}\
889 {{this}}{{/commaList}}\
896 <th>{{translate "Locations"}}</th>\
898 {{#commaList location}}\
899 {{attr "@name"}}{{/commaList}}\
904 } else if (name === "Summary") {
906 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
909 {{#if md-title-remainder}}\
910 <span>{{md-title-remainder}}</span>\
912 {{#if md-title-responsibility}}\
913 <span><i>{{md-title-responsibility}}</i></span>\
918 var s = "There is no default '" + name +"' template!";
925 * All the HTML stuff to render the search forms and
928 // ### This and other multi-word identifiers should be camelCase
929 function mkws_html_all() {
931 if (mkws_config.show_lang)
934 debug("HTML search form");
935 mkws.handle_node_with_team(findnode('.mkwsSearch'), function(tname) {
937 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
938 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
939 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
943 debug("HTML records");
944 // If the team has a .mkwsResults, populate it in the usual
945 // way. If not, assume that it's a smarter application that
946 // defines its own subcomponents, some or all of the
953 if ($(".mkwsResults.mkwsTeam_" + m_teamName).length) {
954 $(".mkwsResults.mkwsTeam_" + m_teamName).html('\
955 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
957 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
958 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
960 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
961 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
962 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
963 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
964 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
969 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
975 var node = findnode(".mkwsRanking");
977 var ranking_data = '';
978 ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
979 if (mkws_config.show_sort) {
980 ranking_data += M('Sort by') + ' ' + mkws_html_sort() + ' ';
982 if (mkws_config.show_perpage) {
983 ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
985 ranking_data += '</form>';
987 node.html(ranking_data);
992 // ### Should not be in the team code, since window size is global
993 if (mkws_config.responsive_design_width) {
994 // Responsive web design - change layout on the fly based on
995 // current screen width. Required for mobile devices.
996 $(window).resize(function(e) { mkws.resize_page() });
997 // initial check after page load
998 $(document).ready(function() { mkws.resize_page() });
1002 node = findnode('.mkwsSearchForm');
1004 node.submit(onFormSubmitEventHandler);
1005 node = findnode('.mkwsSort');
1007 node.change(onSelectDdChange);
1008 node = findnode('.mkwsPerpage');
1010 node.change(onSelectDdChange);
1012 // on first page, hide the termlist
1013 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
1014 var motd = findnode(".mkwsMOTD");
1015 var container = findnode(".mkwsMOTDContainer");
1016 if (motd.length && container.length) {
1017 // Move the MOTD from the provided element down into the container
1018 motd.appendTo(container);
1023 // implement $.parseQuerystring() for parsing URL parameters
1024 function parseQuerystring() {
1026 var qs = window.location.search.replace('?', '');
1027 var pairs = qs.split('&');
1028 $.each(pairs, function(i, v){
1029 var pair = v.split('=');
1030 nvpair[pair[0]] = pair[1];
1036 function mkws_set_lang() {
1037 var lang = parseQuerystring().lang || mkws_config.lang;
1038 if (!lang || !mkws.locale_lang[lang]) {
1039 mkws_config.lang = ""
1041 mkws_config.lang = lang;
1044 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
1045 return mkws_config.lang;
1049 function mkws_html_switch() {
1050 debug("HTML switch for team " + m_teamName);
1052 var node = findnode(".mkwsSwitch");
1053 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
1054 node.append($("<span/>", { text: " | " }));
1055 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
1057 debug("HTML targets");
1058 var node = findnode(".mkwsTargets");
1060 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
1061 No information available yet.\
1063 node.css("display", "none");
1067 function mkws_html_sort() {
1068 debug("HTML sort, m_sort = '" + m_sort + "'");
1069 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
1071 for(var i = 0; i < mkws_config.sort_options.length; i++) {
1072 var opt = mkws_config.sort_options[i];
1074 var val = opt.length == 1 ? opt[0] : opt[1];
1076 sort_html += '<option value="' + key + '"';
1077 if (m_sort == key || m_sort == val) {
1078 sort_html += ' selected="selected"';
1080 sort_html += '>' + M(val) + '</option>';
1082 sort_html += '</select>';
1088 function mkws_html_perpage() {
1089 debug("HTML perpage, m_perpage = " + m_perpage);
1090 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
1092 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
1093 var key = mkws_config.perpage_options[i];
1095 perpage_html += '<option value="' + key + '"';
1096 if (key == m_perpage) {
1097 perpage_html += ' selected="selected"';
1099 perpage_html += '>' + key + '</option>';
1101 perpage_html += '</select>';
1103 return perpage_html;
1107 /* create locale language menu */
1108 function mkws_html_lang() {
1109 var lang_default = "en";
1110 var lang = mkws_config.lang || lang_default;
1113 /* display a list of configured languages, or all */
1114 var lang_options = mkws_config.lang_options || [];
1115 var toBeIncluded = {};
1116 for (var i = 0; i < lang_options.length; i++) {
1117 toBeIncluded[lang_options[i]] = true;
1120 for (var k in mkws.locale_lang) {
1121 if (toBeIncluded[k] || lang_options.length == 0)
1126 if (lang_options.length == 0 || toBeIncluded[lang_default])
1127 list.push(lang_default);
1129 debug("Language menu for: " + list.join(", "));
1133 for(var i = 0; i < list.length; i++) {
1140 data += ' <span>' + l + '</span> ';
1142 data += ' <a href="?lang=' + l + '">' + l + '</a> '
1146 findnode(".mkwsLang").html(data);
1150 that.run_auto_search = function() {
1151 // ### should check mkwsTermlist as well, for facet-only teams
1152 var node = findnode('.mkwsRecords');
1153 var query = node.attr('autosearch');
1157 if (query.match(/^!param!/)) {
1158 var param = query.replace(/^!param!/, '');
1159 query = getParameterByName(param);
1160 debug("obtained query '" + query + "' from param '" + param + "'");
1162 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
1164 } else if (query.match(/^!path!/)) {
1165 var index = query.replace(/^!path!/, '');
1166 var path = window.location.pathname.split('/');
1167 query = path[path.length - index];
1168 debug("obtained query '" + query + "' from path-component '" + index + "'");
1170 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1174 debug("node=" + node + ", class='" + node.className + "', query=" + query);
1176 var sort = node.attr('sort');
1177 var targets = node.attr('targets');
1178 var s = "running auto search: '" + query + "'";
1179 if (sort) s += " sorted by '" + sort + "'";
1180 if (targets) s += " in targets '" + targets + "'";
1183 this.newSearch(query, sort, targets, m_teamName);
1187 // This function is taken from a StackOverflow answer
1188 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1189 // ### should we unify this and parseQuerystring()?
1190 function getParameterByName(name) {
1191 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1192 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1193 results = regex.exec(location.search);
1194 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1200 var lang = mkws_config.lang;
1202 if (!lang || !mkws.locale_lang[lang])
1205 return mkws.locale_lang[lang][word] || word;
1207 mkws.M = M; // so the Handlebars helper can use it
1217 mkws_config.error = e.message;
1218 // alert(e.message);
1222 // Bizarrely, 'that' is just an empty hash. All its state is in
1223 // the closure variables defined earlier in this function.
1228 // wrapper to call team() after page load
1230 mkws.debug = function (string) {
1231 if (!mkws.debug_level)
1234 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1238 // you need to disable use strict at the top of the file!!!
1239 if (mkws.debug_level >= 3) {
1240 console.log(arguments.callee.caller);
1241 } else if (mkws.debug_level >= 2) {
1242 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1244 console.log(string);
1246 var debug = mkws.debug;
1249 mkws.handle_node_with_team = function(node, callback) {
1250 // First branch for DOM objects; second branch for jQuery objects
1251 var classes = node.className || node.attr('class');
1253 // For some reason, if we try to proceed when classes is
1254 // undefined, we don't get an error message, but this
1255 // function and its callers, up several stack level,
1256 // silently return. What a crock.
1257 mkws.debug("handle_node_with_team() called on node with no classes");
1260 var list = classes.split(/\s+/)
1263 for (var i = 0; i < list.length; i++) {
1264 var cname = list[i];
1265 if (cname.match(/^mkwsTeam_/)) {
1266 teamName = cname.replace(/^mkwsTeam_/, '');
1267 } else if (cname.match(/^mkws/)) {
1268 type = cname.replace(/^mkws/, '');
1271 callback.call(node, teamName, type);
1275 mkws.resize_page = function () {
1276 var list = ["mkwsSwitch", "mkwsLang"];
1278 var width = mkws_config.responsive_design_width;
1279 var parent = $(".mkwsTermlists").parent();
1281 if ($(window).width() <= width &&
1282 parent.hasClass("mkwsTermlistContainer1")) {
1283 debug("changing from wide to narrow: " + $(window).width());
1284 $(".mkwsTermlistContainer1").hide();
1285 $(".mkwsTermlistContainer2").show();
1286 for (var tname in mkws.teams) {
1287 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1288 for(var i = 0; i < list.length; i++) {
1289 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1292 } else if ($(window).width() > width &&
1293 parent.hasClass("mkwsTermlistContainer2")) {
1294 debug("changing from narrow to wide: " + $(window).width());
1295 $(".mkwsTermlistContainer1").show();
1296 $(".mkwsTermlistContainer2").hide();
1297 for (var tname in mkws.teams) {
1298 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1299 for(var i = 0; i < list.length; i++) {
1300 $("." + list[i] + ".mkwsTeam_" + tname).show();
1307 mkws.switchView = function(tname, view) {
1308 mkws.teams[tname].switchView(view);
1311 mkws.showDetails = function (tname, prefixRecId) {
1312 mkws.teams[tname].showDetails(prefixRecId);
1315 mkws.limitTarget = function (tname, id, name) {
1316 mkws.teams[tname].limitTarget(id, name);
1319 mkws.limitQuery = function (tname, field, value) {
1320 mkws.teams[tname].limitQuery(field, value);
1323 mkws.delimitTarget = function (tname, id) {
1324 mkws.teams[tname].delimitTarget(id);
1327 mkws.delimitQuery = function (tname, field, value) {
1328 mkws.teams[tname].delimitQuery(field, value);
1331 mkws.showPage = function (tname, pageNum) {
1332 mkws.teams[tname].showPage(pageNum);
1335 mkws.pagerPrev = function (tname) {
1336 mkws.teams[tname].pagerPrev();
1339 mkws.pagerNext = function (tname) {
1340 mkws.teams[tname].pagerNext();
1344 function default_mkws_config() {
1345 /* default mkws config */
1346 var config_default = {
1347 use_service_proxy: true,
1348 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1349 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1351 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1352 perpage_options: [10, 20, 30, 50],
1353 sort_default: "relevance",
1354 perpage_default: 20,
1356 show_lang: true, /* show/hide language menu */
1357 show_sort: true, /* show/hide sort menu */
1358 show_perpage: true, /* show/hide perpage menu */
1359 lang_options: [], /* display languages links for given languages, [] for all */
1360 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1361 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1362 debug_level: 1, /* debug level for development: 0..2 */
1367 /* Set global debug_level flag early so that debug() works */
1368 if (typeof mkws_config.debug_level !== 'undefined') {
1369 mkws.debug_level = mkws_config.debug_level;
1370 } else if (typeof config_default.debug_level !== 'undefined') {
1371 mkws.debug_level = config_default.debug_level;
1374 // make sure the mkws_config is a valid hash
1375 if (!$.isPlainObject(mkws_config)) {
1376 debug("ERROR: mkws_config is not an JS object, ignore it....");
1380 /* override standard config values by function parameters */
1381 for (var k in config_default) {
1382 if (typeof mkws_config[k] === 'undefined')
1383 mkws_config[k] = config_default[k];
1384 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1390 * Run service-proxy authentication in background (after page load).
1391 * The username/password is configured in the apache config file
1394 function authenticate_session(auth_url, auth_domain, pp2_url) {
1395 debug("Run service proxy auth URL: " + auth_url);
1398 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1399 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1402 var request = new pzHttpRequest(auth_url, function(err) {
1403 alert("HTTP call for authentication failed: " + err)
1407 request.get(null, function(data) {
1408 if (!$.isXMLDoc(data)) {
1409 alert("service proxy auth response document is not valid XML document, give up!");
1412 var status = $(data).find("status");
1413 if (status.text() != "OK") {
1414 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1418 debug("Service proxy auth successfully done");
1419 mkws.authenticated = true;
1420 run_auto_searches();
1425 function run_auto_searches() {
1426 debug("running auto searches");
1428 for (var teamName in mkws.teams) {
1429 mkws.teams[teamName].run_auto_search();
1434 $(document).ready(function() {
1435 debug("on load ready");
1436 default_mkws_config();
1438 // Backwards compatibility: set new magic class names on any
1439 // elements that have the old magic IDs.
1440 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1441 "Results", "Records", "Targets", "Ranking",
1442 "Termlists", "Stat", "MOTD" ];
1443 for (var i = 0; i < ids.length; i++) {
1444 var id = 'mkws' + ids[i];
1445 var node = $('#' + id);
1446 if (node.attr('id')) {
1448 debug("added magic class to '" + node.attr('id') + "'");
1452 // For all MKWS-classed nodes that don't have a team
1453 // specified, set the team to AUTO.
1454 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1455 if (!this.className.match(/mkwsTeam_/)) {
1456 debug("adding AUTO team to node with class '" + this.className + "'");
1457 $(this).addClass('mkwsTeam_AUTO');
1461 // Find all nodes with an class, and determine their team from
1462 // the mkwsTeam_* class. Make all team objects.
1464 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1465 mkws.handle_node_with_team(this, function(tname, type) {
1466 if (!mkws.teams[tname]) {
1467 mkws.teams[tname] = team(j, tname);
1468 debug("Made MKWS team '" + tname + "'");
1470 var myTeam = mkws.teams[tname];
1471 var myWidget = widget(j, myTeam, type, this);
1475 debug("Walking MKWS nodes took " + (now-then) + " ms");
1477 if (mkws_config.use_service_proxy) {
1478 authenticate_session(mkws_config.service_proxy_auth,
1479 mkws_config.service_proxy_auth_domain,
1480 mkws_config.pazpar2_url);
1483 run_auto_searches();