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 // Multiple OR-clauses separated by commas are handled
279 // More complex cases may not work
281 function findnode(selector, teamName) {
282 teamName = teamName || m_teamName;
284 selector = selector.split(',').map(function(s) {
285 return s + '.mkwsTeam_' + teamName;
293 // pz2.js event handlers:
295 function my_oninit(teamName) {
302 function my_onshow(data, teamName) {
304 m_totalRec = data.merged;
306 var pager = findnode(".mkwsPager");
308 pager.html(drawPager(data))
311 var results = findnode(".mkwsRecords");
316 for (var i = 0; i < data.hits.length; i++) {
317 var hit = data.hits[i];
318 html.push('<div class="record" id="mkwsRecdiv_' + teamName + '_' + hit.recid + '" >',
321 if (hit.recid == m_curDetRecId) {
323 html.push(renderDetails(m_curDetRecData));
326 results.html(html.join(''));
330 function renderSummary(hit)
332 var template = loadTemplate("Summary");
333 hit._id = "mkwsRec_" + hit.recid;
334 hit._onclick = "mkws.showDetails('" + m_teamName + "', this.id);return false;"
335 return template(hit);
339 function my_onstat(data, teamName) {
341 var stat = findnode('.mkwsStat');
342 if (stat.length === 0)
345 stat.html('<span class="head">' + M('Status info') + '</span>' +
347 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
349 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
353 function my_onterm(data, teamName) {
355 var node = findnode(".mkwsTermlists");
356 if (node.length == 0) return;
358 // no facets: this should never happen
359 if (!mkws_config.facets || mkws_config.facets.length == 0) {
360 alert("my_onterm called even though we have no facets: " + $.toJSON(data));
365 // display if we first got results
369 acc.push('<div class="title">' + M('Termlists') + '</div>');
370 var facets = mkws_config.facets;
372 for(var i = 0; i < facets.length; i++) {
373 if (facets[i] == "xtargets") {
374 add_single_facet(acc, "Sources", data.xtargets, 16, null);
375 } else if (facets[i] == "subject") {
376 add_single_facet(acc, "Subjects", data.subject, 10, "subject");
377 } else if (facets[i] == "author") {
378 add_single_facet(acc, "Authors", data.author, 10, "author");
380 alert("bad facet configuration: '" + facets[i] + "'");
384 node.html(acc.join(''));
388 function add_single_facet(acc, caption, data, max, pzIndex) {
389 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + m_teamName + '">');
390 acc.push('<div class="termtitle">' + M(caption) + '</div>');
391 for (var i = 0; i < data.length && i < max; i++) {
392 acc.push('<div class="term">');
393 acc.push('<a href="#" ');
396 // Special case: target selection
397 acc.push('target_id='+data[i].id+' ');
398 if (!target_filtered(data[i].id)) {
399 action = 'mkws.limitTarget(\'' + m_teamName + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
402 action = 'mkws.limitQuery(\'' + m_teamName + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
404 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
405 + ' <span>' + data[i].freq + '</span>');
412 function target_filtered(id) {
413 for (var i = 0; i < m_filters.length; i++) {
414 if (m_filters[i].id === id ||
415 m_filters[i].id === 'pz:id=' + id) {
423 function my_onrecord(data, args, teamName) {
424 debug("record: teamName=" + teamName + ", m_teamName=" + m_teamName);
425 // FIXME: record is async!!
426 clearTimeout(m_paz.recordTimer);
427 // in case on_show was faster to redraw element
428 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
429 if (detRecordDiv) return;
430 m_curDetRecData = data;
431 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_curDetRecData.recid);
432 var html = renderDetails(m_curDetRecData);
433 recordDiv.innerHTML += html;
437 function my_onbytarget(data, teamName) {
439 var targetDiv = findnode('.mkwsBytarget');
444 var table ='<table><thead><tr>' +
445 '<td>' + M('Target ID') + '</td>' +
446 '<td>' + M('Hits') + '</td>' +
447 '<td>' + M('Diags') + '</td>' +
448 '<td>' + M('Records') + '</td>' +
449 '<td>' + M('State') + '</td>' +
450 '</tr></thead><tbody>';
452 for (var i = 0; i < data.length; i++) {
453 table += "<tr><td>" + data[i].id +
454 "</td><td>" + data[i].hits +
455 "</td><td>" + data[i].diagnostic +
456 "</td><td>" + data[i].records +
457 "</td><td>" + data[i].state + "</td></tr>";
460 table += '</tbody></table>';
461 targetDiv.html(table);
464 ////////////////////////////////////////////////////////////////////////////////
465 ////////////////////////////////////////////////////////////////////////////////
468 // when search button pressed
469 // ### This is closure, so can always just operate on its own team
470 function onFormSubmitEventHandler()
472 mkws.handle_node_with_team(this, function (tname) {
473 var val = findnode('.mkwsQuery').val();
474 mkws.teams[tname].newSearch(val);
481 // ### won't need to be externally visible once onFormSubmitEventHandler() is fixed.
482 // ### doesn't need windowid
483 that.newSearch = function(query, sort, targets, windowid)
485 debug("newSearch: " + query);
487 if (mkws_config.use_service_proxy && !mkws.authenticated) {
488 alert("searching before authentication");
496 triggerSearch(query, sort, targets, windowid);
497 that.switchView('records'); // In case it's configured to start off as hidden
502 function onSelectDdChange()
504 if (!m_submitted) return false;
507 m_paz.show(0, m_perpage, m_sort);
519 // ### doesn't need windowid
520 function triggerSearch (query, sort, targets, windowid)
525 // Re-use previous query/sort if new ones are not specified
533 // ### should support multiple |-separated targets
534 m_filters.push({ id: targets, name: targets });
537 for (var i in m_filters) {
538 var filter = m_filters[i];
542 if (filter.id.match(/^[a-z:]+[=~]/)) {
543 debug("filter '" + filter.id + "' already begins with SETTING OP");
545 filter.id = 'pz:id=' + filter.id;
547 pp2filter += filter.id;
551 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
557 params.limit = pp2limit;
560 params.windowid = windowid;
562 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
564 // We can use: params.torusquery = "udb=NAME"
565 // Note: that won't work when running against raw pazpar2
566 m_paz.search(m_query, m_perpage, m_sort, pp2filter, undefined, params);
570 function loadSelect ()
572 var node = findnode('.mkwsSort');
573 if (node.length && node.val() != m_sort) {
574 debug("changing m_sort from " + m_sort + " to " + node.val());
577 node = findnode('.mkwsPerpage');
578 if (node.length && node.val() != m_perpage) {
579 debug("changing m_perpage from " + m_perpage + " to " + node.val());
580 m_perpage = node.val();
585 // limit by target functions
586 that.limitTarget = function (id, name)
588 debug("limitTarget(id=" + id + ", name=" + name + ")");
589 m_filters.push({ id: id, name: name });
598 // limit the query after clicking the facet
599 that.limitQuery = function (field, value)
601 debug("limitQuery(field=" + field + ", value=" + value + ")");
602 m_filters.push({ field: field, value: value });
611 that.delimitTarget = function (id)
613 debug("delimitTarget(id=" + id + ")");
615 for (var i in m_filters) {
616 var filter = m_filters[i];
618 debug("delimitTarget() removing filter " + $.toJSON(filter));
620 debug("delimitTarget() keeping filter " + $.toJSON(filter));
621 newFilters.push(filter);
624 m_filters = newFilters;
634 that.delimitQuery = function (field, value)
636 debug("delimitQuery(field=" + field + ", value=" + value + ")");
638 for (var i in m_filters) {
639 var filter = m_filters[i];
641 field == filter.field &&
642 value == filter.value) {
643 debug("delimitQuery() removing filter " + $.toJSON(filter));
645 debug("delimitQuery() keeping filter " + $.toJSON(filter));
646 newFilters.push(filter);
649 m_filters = newFilters;
659 function redraw_navi ()
661 var navi = findnode('.mkwsNavi');
665 for (var i in m_filters) {
669 var filter = m_filters[i];
671 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
672 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
674 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
675 "', '" + filter.field + "', '" + filter.value + "'" +
676 ');return false;">' + filter.value + '</a>';
684 function drawPager (data)
686 var s = '<div style="float: right">' + M('Displaying') + ': '
687 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
688 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
689 + data.total + ')</div>';
691 //client indexes pages from 1 but pz2 from 0
693 var pages = Math.ceil(m_totalRec / m_perpage);
695 var firstClkbl = (m_curPage - onsides > 0)
696 ? m_curPage - onsides
699 var lastClkbl = firstClkbl + 2*onsides < pages
700 ? firstClkbl + 2*onsides
703 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
705 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + m_teamName + '\');">'
706 +'<< ' + M('Prev') + '</a><b> | </b>';
709 for(var i = firstClkbl; i <= lastClkbl; i++) {
712 numLabel = '<b>' + i + '</b>';
714 middle += '<a href="#" onclick="mkws.showPage(\'' + m_teamName + '\', ' + i + ')"> '
715 + numLabel + ' </a>';
718 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
719 if (pages - m_curPage > 0)
720 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + m_teamName + '\')">'
721 + M('Next') + ' >></a>';
728 if (lastClkbl < pages)
731 s += '<div style="float: clear">'
732 + prev + predots + middle + postdots + next + '</div>';
738 that.showPage = function (pageNum)
741 m_paz.showPage(m_curPage - 1);
745 // simple paging functions
746 that.pagerNext = function () {
747 if (m_totalRec - m_perpage*m_curPage > 0) {
754 that.pagerPrev = function () {
755 if (m_paz.showPrev() != false)
760 // switching view between targets and records
761 that.switchView = function(view) {
762 var targets = findnode('.mkwsTargets');
763 var results = findnode('.mkwsResults,.mkwsRecords');
764 var blanket = findnode('.mkwsBlanket');
765 var motd = findnode('.mkwsMOTD');
769 if (targets) targets.css('display', 'block');
770 if (results) results.css('display', 'none');
771 if (blanket) blanket.css('display', 'none');
772 if (motd) motd.css('display', 'none');
775 if (targets) targets.css('display', 'none');
776 if (results) results.css('display', 'block');
777 if (blanket) blanket.css('display', 'block');
778 if (motd) motd.css('display', 'none');
781 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
782 if (targets) targets.css('display', 'none');
783 if (results) results.css('display', 'none');
784 if (blanket) blanket.css('display', 'none');
785 if (motd) motd.css('display', 'none');
788 alert("Unknown view '" + view + "'");
793 // detailed record drawing
794 that.showDetails = function (prefixRecId) {
795 var recId = prefixRecId.replace('mkwsRec_', '');
796 var oldRecId = m_curDetRecId;
797 m_curDetRecId = recId;
799 // remove current detailed view if any
800 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecId);
803 detRecordDiv.parentNode.removeChild(detRecordDiv);
805 // if the same clicked, just hide
806 if (recId == oldRecId) {
808 m_curDetRecData = null;
811 // request the record
812 debug("showDetails() requesting record '" + recId + "'");
817 function renderDetails(data, marker)
819 var template = loadTemplate("Record");
820 var details = template(data);
821 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
825 function loadTemplate(name)
827 var template = m_template[name];
829 if (template === undefined) {
830 // Fall back to generic template if there is no team-specific one
831 var node = findnode(".mkwsTemplate_" + name);
833 node = findnode(".mkwsTemplate_" + name, "ALL");
836 var source = node.html();
838 source = defaultTemplate(name);
841 template = Handlebars.compile(source);
842 debug("compiled template '" + name + "'");
843 m_template[name] = template;
850 function defaultTemplate(name)
852 if (name === 'Record') {
856 <th>{{translate "Title"}}</th>\
859 {{#if md-title-remainder}}\
860 ({{md-title-remainder}})\
862 {{#if md-title-responsibility}}\
863 <i>{{md-title-responsibility}}</i>\
869 <th>{{translate "Date"}}</th>\
870 <td>{{md-date}}</td>\
875 <th>{{translate "Author"}}</th>\
876 <td>{{md-author}}</td>\
879 {{#if md-electronic-url}}\
881 <th>{{translate "Links"}}</th>\
883 {{#each md-electronic-url}}\
884 <a href="{{this}}">Link{{index1}}</a>\
889 {{#if-any location having="md-subject"}}\
891 <th>{{translate "Subject"}}</th>\
893 {{#first location having="md-subject"}}\
895 {{#commaList md-subject}}\
896 {{this}}{{/commaList}}\
903 <th>{{translate "Locations"}}</th>\
905 {{#commaList location}}\
906 {{attr "@name"}}{{/commaList}}\
911 } else if (name === "Summary") {
913 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
916 {{#if md-title-remainder}}\
917 <span>{{md-title-remainder}}</span>\
919 {{#if md-title-responsibility}}\
920 <span><i>{{md-title-responsibility}}</i></span>\
925 var s = "There is no default '" + name +"' template!";
932 * All the HTML stuff to render the search forms and
935 // ### This and other multi-word identifiers should be camelCase
936 function mkws_html_all() {
938 if (mkws_config.show_lang)
941 debug("HTML search form");
942 mkws.handle_node_with_team(findnode('.mkwsSearch'), function(tname) {
944 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
945 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
946 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
950 debug("HTML records");
951 // If the team has a .mkwsResults, populate it in the usual
952 // way. If not, assume that it's a smarter application that
953 // defines its own subcomponents, some or all of the
960 if (findnode(".mkwsResults").length) {
961 findnode(".mkwsResults").html('\
962 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
964 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
965 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
967 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
968 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
969 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
970 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
971 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
976 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
982 var node = findnode(".mkwsRanking");
984 var ranking_data = '';
985 ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
986 if (mkws_config.show_sort) {
987 ranking_data += M('Sort by') + ' ' + mkws_html_sort() + ' ';
989 if (mkws_config.show_perpage) {
990 ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
992 ranking_data += '</form>';
994 node.html(ranking_data);
999 // ### Should not be in the team code, since window size is global
1000 if (mkws_config.responsive_design_width) {
1001 // Responsive web design - change layout on the fly based on
1002 // current screen width. Required for mobile devices.
1003 $(window).resize(function(e) { mkws.resize_page() });
1004 // initial check after page load
1005 $(document).ready(function() { mkws.resize_page() });
1009 node = findnode('.mkwsSearchForm');
1011 node.submit(onFormSubmitEventHandler);
1012 node = findnode('.mkwsSort');
1014 node.change(onSelectDdChange);
1015 node = findnode('.mkwsPerpage');
1017 node.change(onSelectDdChange);
1019 // on first page, hide the termlist
1020 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
1021 var motd = findnode(".mkwsMOTD");
1022 var container = findnode(".mkwsMOTDContainer");
1023 if (motd.length && container.length) {
1024 // Move the MOTD from the provided element down into the container
1025 motd.appendTo(container);
1030 // implement $.parseQuerystring() for parsing URL parameters
1031 function parseQuerystring() {
1033 var qs = window.location.search.replace('?', '');
1034 var pairs = qs.split('&');
1035 $.each(pairs, function(i, v){
1036 var pair = v.split('=');
1037 nvpair[pair[0]] = pair[1];
1043 function mkws_set_lang() {
1044 var lang = parseQuerystring().lang || mkws_config.lang;
1045 if (!lang || !mkws.locale_lang[lang]) {
1046 mkws_config.lang = ""
1048 mkws_config.lang = lang;
1051 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
1052 return mkws_config.lang;
1056 function mkws_html_switch() {
1057 debug("HTML switch for team " + m_teamName);
1059 var node = findnode(".mkwsSwitch");
1060 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
1061 node.append($("<span/>", { text: " | " }));
1062 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
1064 debug("HTML targets");
1065 var node = findnode(".mkwsTargets");
1067 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
1068 No information available yet.\
1070 node.css("display", "none");
1074 function mkws_html_sort() {
1075 debug("HTML sort, m_sort = '" + m_sort + "'");
1076 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
1078 for(var i = 0; i < mkws_config.sort_options.length; i++) {
1079 var opt = mkws_config.sort_options[i];
1081 var val = opt.length == 1 ? opt[0] : opt[1];
1083 sort_html += '<option value="' + key + '"';
1084 if (m_sort == key || m_sort == val) {
1085 sort_html += ' selected="selected"';
1087 sort_html += '>' + M(val) + '</option>';
1089 sort_html += '</select>';
1095 function mkws_html_perpage() {
1096 debug("HTML perpage, m_perpage = " + m_perpage);
1097 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
1099 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
1100 var key = mkws_config.perpage_options[i];
1102 perpage_html += '<option value="' + key + '"';
1103 if (key == m_perpage) {
1104 perpage_html += ' selected="selected"';
1106 perpage_html += '>' + key + '</option>';
1108 perpage_html += '</select>';
1110 return perpage_html;
1114 /* create locale language menu */
1115 function mkws_html_lang() {
1116 var lang_default = "en";
1117 var lang = mkws_config.lang || lang_default;
1120 /* display a list of configured languages, or all */
1121 var lang_options = mkws_config.lang_options || [];
1122 var toBeIncluded = {};
1123 for (var i = 0; i < lang_options.length; i++) {
1124 toBeIncluded[lang_options[i]] = true;
1127 for (var k in mkws.locale_lang) {
1128 if (toBeIncluded[k] || lang_options.length == 0)
1133 if (lang_options.length == 0 || toBeIncluded[lang_default])
1134 list.push(lang_default);
1136 debug("Language menu for: " + list.join(", "));
1140 for(var i = 0; i < list.length; i++) {
1147 data += ' <span>' + l + '</span> ';
1149 data += ' <a href="?lang=' + l + '">' + l + '</a> '
1153 findnode(".mkwsLang").html(data);
1157 that.run_auto_search = function() {
1158 // ### should check mkwsTermlist as well, for facet-only teams
1159 var node = findnode('.mkwsRecords');
1160 var query = node.attr('autosearch');
1164 if (query.match(/^!param!/)) {
1165 var param = query.replace(/^!param!/, '');
1166 query = getParameterByName(param);
1167 debug("obtained query '" + query + "' from param '" + param + "'");
1169 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
1171 } else if (query.match(/^!path!/)) {
1172 var index = query.replace(/^!path!/, '');
1173 var path = window.location.pathname.split('/');
1174 query = path[path.length - index];
1175 debug("obtained query '" + query + "' from path-component '" + index + "'");
1177 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1181 debug("node=" + node + ", class='" + node.className + "', query=" + query);
1183 var sort = node.attr('sort');
1184 var targets = node.attr('targets');
1185 var s = "running auto search: '" + query + "'";
1186 if (sort) s += " sorted by '" + sort + "'";
1187 if (targets) s += " in targets '" + targets + "'";
1190 this.newSearch(query, sort, targets, m_teamName);
1194 // This function is taken from a StackOverflow answer
1195 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1196 // ### should we unify this and parseQuerystring()?
1197 function getParameterByName(name) {
1198 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1199 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1200 results = regex.exec(location.search);
1201 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1207 var lang = mkws_config.lang;
1209 if (!lang || !mkws.locale_lang[lang])
1212 return mkws.locale_lang[lang][word] || word;
1214 mkws.M = M; // so the Handlebars helper can use it
1224 mkws_config.error = e.message;
1225 // alert(e.message);
1229 // Bizarrely, 'that' is just an empty hash. All its state is in
1230 // the closure variables defined earlier in this function.
1235 // wrapper to call team() after page load
1237 mkws.debug = function (string) {
1238 if (!mkws.debug_level)
1241 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1245 // you need to disable use strict at the top of the file!!!
1246 if (mkws.debug_level >= 3) {
1247 console.log(arguments.callee.caller);
1248 } else if (mkws.debug_level >= 2) {
1249 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1251 console.log(string);
1253 var debug = mkws.debug;
1256 mkws.handle_node_with_team = function(node, callback) {
1257 // First branch for DOM objects; second branch for jQuery objects
1258 var classes = node.className || node.attr('class');
1260 // For some reason, if we try to proceed when classes is
1261 // undefined, we don't get an error message, but this
1262 // function and its callers, up several stack level,
1263 // silently return. What a crock.
1264 mkws.debug("handle_node_with_team() called on node with no classes");
1267 var list = classes.split(/\s+/)
1270 for (var i = 0; i < list.length; i++) {
1271 var cname = list[i];
1272 if (cname.match(/^mkwsTeam_/)) {
1273 teamName = cname.replace(/^mkwsTeam_/, '');
1274 } else if (cname.match(/^mkws/)) {
1275 type = cname.replace(/^mkws/, '');
1278 callback.call(node, teamName, type);
1282 mkws.resize_page = function () {
1283 var list = ["mkwsSwitch", "mkwsLang"];
1285 var width = mkws_config.responsive_design_width;
1286 var parent = $(".mkwsTermlists").parent();
1288 if ($(window).width() <= width &&
1289 parent.hasClass("mkwsTermlistContainer1")) {
1290 debug("changing from wide to narrow: " + $(window).width());
1291 $(".mkwsTermlistContainer1").hide();
1292 $(".mkwsTermlistContainer2").show();
1293 for (var tname in mkws.teams) {
1294 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1295 for(var i = 0; i < list.length; i++) {
1296 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1299 } else if ($(window).width() > width &&
1300 parent.hasClass("mkwsTermlistContainer2")) {
1301 debug("changing from narrow to wide: " + $(window).width());
1302 $(".mkwsTermlistContainer1").show();
1303 $(".mkwsTermlistContainer2").hide();
1304 for (var tname in mkws.teams) {
1305 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1306 for(var i = 0; i < list.length; i++) {
1307 $("." + list[i] + ".mkwsTeam_" + tname).show();
1314 mkws.switchView = function(tname, view) {
1315 mkws.teams[tname].switchView(view);
1318 mkws.showDetails = function (tname, prefixRecId) {
1319 mkws.teams[tname].showDetails(prefixRecId);
1322 mkws.limitTarget = function (tname, id, name) {
1323 mkws.teams[tname].limitTarget(id, name);
1326 mkws.limitQuery = function (tname, field, value) {
1327 mkws.teams[tname].limitQuery(field, value);
1330 mkws.delimitTarget = function (tname, id) {
1331 mkws.teams[tname].delimitTarget(id);
1334 mkws.delimitQuery = function (tname, field, value) {
1335 mkws.teams[tname].delimitQuery(field, value);
1338 mkws.showPage = function (tname, pageNum) {
1339 mkws.teams[tname].showPage(pageNum);
1342 mkws.pagerPrev = function (tname) {
1343 mkws.teams[tname].pagerPrev();
1346 mkws.pagerNext = function (tname) {
1347 mkws.teams[tname].pagerNext();
1351 function default_mkws_config() {
1352 /* default mkws config */
1353 var config_default = {
1354 use_service_proxy: true,
1355 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1356 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1358 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1359 perpage_options: [10, 20, 30, 50],
1360 sort_default: "relevance",
1361 perpage_default: 20,
1363 show_lang: true, /* show/hide language menu */
1364 show_sort: true, /* show/hide sort menu */
1365 show_perpage: true, /* show/hide perpage menu */
1366 lang_options: [], /* display languages links for given languages, [] for all */
1367 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1368 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1369 debug_level: 1, /* debug level for development: 0..2 */
1374 /* Set global debug_level flag early so that debug() works */
1375 if (typeof mkws_config.debug_level !== 'undefined') {
1376 mkws.debug_level = mkws_config.debug_level;
1377 } else if (typeof config_default.debug_level !== 'undefined') {
1378 mkws.debug_level = config_default.debug_level;
1381 // make sure the mkws_config is a valid hash
1382 if (!$.isPlainObject(mkws_config)) {
1383 debug("ERROR: mkws_config is not an JS object, ignore it....");
1387 /* override standard config values by function parameters */
1388 for (var k in config_default) {
1389 if (typeof mkws_config[k] === 'undefined')
1390 mkws_config[k] = config_default[k];
1391 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1397 * Run service-proxy authentication in background (after page load).
1398 * The username/password is configured in the apache config file
1401 function authenticate_session(auth_url, auth_domain, pp2_url) {
1402 debug("Run service proxy auth URL: " + auth_url);
1405 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1406 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1409 var request = new pzHttpRequest(auth_url, function(err) {
1410 alert("HTTP call for authentication failed: " + err)
1414 request.get(null, function(data) {
1415 if (!$.isXMLDoc(data)) {
1416 alert("service proxy auth response document is not valid XML document, give up!");
1419 var status = $(data).find("status");
1420 if (status.text() != "OK") {
1421 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1425 debug("Service proxy auth successfully done");
1426 mkws.authenticated = true;
1427 run_auto_searches();
1432 function run_auto_searches() {
1433 debug("running auto searches");
1435 for (var teamName in mkws.teams) {
1436 mkws.teams[teamName].run_auto_search();
1441 $(document).ready(function() {
1442 debug("on load ready");
1443 default_mkws_config();
1445 // Backwards compatibility: set new magic class names on any
1446 // elements that have the old magic IDs.
1447 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1448 "Results", "Records", "Targets", "Ranking",
1449 "Termlists", "Stat", "MOTD" ];
1450 for (var i = 0; i < ids.length; i++) {
1451 var id = 'mkws' + ids[i];
1452 var node = $('#' + id);
1453 if (node.attr('id')) {
1455 debug("added magic class to '" + node.attr('id') + "'");
1459 // For all MKWS-classed nodes that don't have a team
1460 // specified, set the team to AUTO.
1461 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1462 if (!this.className.match(/mkwsTeam_/)) {
1463 debug("adding AUTO team to node with class '" + this.className + "'");
1464 $(this).addClass('mkwsTeam_AUTO');
1468 // Find all nodes with an class, and determine their team from
1469 // the mkwsTeam_* class. Make all team objects.
1471 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1472 mkws.handle_node_with_team(this, function(tname, type) {
1473 if (!mkws.teams[tname]) {
1474 mkws.teams[tname] = team(j, tname);
1475 debug("Made MKWS team '" + tname + "'");
1477 var myTeam = mkws.teams[tname];
1478 var myWidget = widget(j, myTeam, type, this);
1482 debug("Walking MKWS nodes took " + (now-then) + " ms");
1484 if (mkws_config.use_service_proxy) {
1485 authenticate_session(mkws_config.service_proxy_auth,
1486 mkws_config.service_proxy_auth_domain,
1487 mkws_config.pazpar2_url);
1490 run_auto_searches();