X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=tools%2Fhtdocs%2Fmkws.js;h=f5a1a9e8ce31890670d83c81b517677110938aa2;hp=a9661a405f8f6eb363303106191c0c11d0d8027e;hb=c5a0a022ec2d93dd0ebd02704b2469846e377681;hpb=0fa89564f9dee5d33a5c22ebfba71f704839d00b diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js index a9661a4..f5a1a9e 100644 --- a/tools/htdocs/mkws.js +++ b/tools/htdocs/mkws.js @@ -1,93 +1,181 @@ -/*! MKWS, the MasterKey Widget Set. Copyright (C) 2013-2014, Index Data */ +/*! MKWS, the MasterKey Widget Set. + * Copyright (C) 2013-2014 Index Data + * See the file LICENSE for details + */ "use strict"; // HTML5: disable for debug_level >= 2 -// Set up global mkws object. Contains a hash of session objects, + +// Handlebars helpers +Handlebars.registerHelper('json', function(obj) { + return $.toJSON(obj); +}); + + +Handlebars.registerHelper('translate', function(s) { + return mkws.M(s); +}); + + +// We need {{attr '@name'}} because Handlebars can't parse {{@name}} +Handlebars.registerHelper('attr', function(attrName) { + return this[attrName]; +}); + + +/* + * Use as follows: {{#if-any NAME1 having="NAME2"}} + * Applicable when NAME1 is the name of an array + * The guarded code runs only if at least one element of the NAME1 + * array has a subelement called NAME2. + */ +Handlebars.registerHelper('if-any', function(items, options) { + var having = options.hash.having; + for (var i in items) { + var item = items[i] + if (!having || item[having]) { + return options.fn(this); + } + } + return ""; +}); + + +Handlebars.registerHelper('first', function(items, options) { + var having = options.hash.having; + for (var i in items) { + var item = items[i] + if (!having || item[having]) { + return options.fn(item); + } + } + return ""; +}); + + +Handlebars.registerHelper('commaList', function(items, options) { + var out = ""; + + for (var i in items) { + if (i > 0) out += ", "; + out += options.fn(items[i]) + } + + return out; +}); + + + +// Some functions are visible to be called from outside code, namely +// generated HTML: that.switchView(), showDetails(), limitTarget(), +// limitQuery(), delimitTarget(), delimitQuery(), pagerPrev(), +// pagerNext(), showPage(). Also mkws.M() is made available for the +// Handlebars helper 'translate' + + +// Set up global mkws object. Contains a hash of team objects, // indexed by windowid. var mkws = { authenticated: false, - sessions: {} -}; - -mkws.locale_lang = { - "de": { - "Authors": "Autoren", - "Subjects": "Schlagwörter", - "Sources": "Daten und Quellen", - "Termlists": "Termlisten", - "Next": "Weiter", - "Prev": "Zurück", - "Search": "Suche", - "Sort by": "Sortieren nach", - "and show": "und zeige", - "per page": "pro Seite", - "Displaying": "Zeige", - "to": "von", - "of": "aus", - "found": "gefunden", - "Title": "Titel", - "Author": "Autor", - "Date": "Datum", - "Subject": "Schlagwort", - "Location": "Ort", - "Records": "Datensätze", - "Targets": "Datenbanken", - - "dummy": "dummy" - }, - - "da": { - "Authors": "Forfattere", - "Subjects": "Emner", - "Sources": "Kilder", - "Termlists": "Termlists", - "Next": "Næste", - "Prev": "Forrige", - "Search": "Søg", - "Sort by": "Sorter efter", - "and show": "og vis", - "per page": "per side", - "Displaying": "Viser", - "to": "til", - "of": "ud af", - "found": "fandt", - "Title": "Title", - "Author": "Forfatter", - "Date": "Dato", - "Subject": "Emneord", - "Location": "Lokation", - "Records": "Poster", - "Targets": "Baser", - - "dummy": "dummy" + debug_function: undefined, // will be set during initialisation + debug_level: undefined, // will be initialised from mkws_config + paz: undefined, // will be set up during initialisation + teams: {}, + locale_lang: { + "de": { + "Authors": "Autoren", + "Subjects": "Schlagwörter", + "Sources": "Daten und Quellen", + "source": "datenquelle", + "Termlists": "Termlisten", + "Next": "Weiter", + "Prev": "Zurück", + "Search": "Suche", + "Sort by": "Sortieren nach", + "and show": "und zeige", + "per page": "pro Seite", + "Displaying": "Zeige", + "to": "von", + "of": "aus", + "found": "gefunden", + "Title": "Titel", + "Author": "Autor", + "author": "autor", + "Date": "Datum", + "Subject": "Schlagwort", + "subject": "schlagwort", + "Location": "Ort", + "Records": "Datensätze", + "Targets": "Datenbanken", + + "dummy": "dummy" + }, + + "da": { + "Authors": "Forfattere", + "Subjects": "Emner", + "Sources": "Kilder", + "source": "kilder", + "Termlists": "Termlists", + "Next": "Næste", + "Prev": "Forrige", + "Search": "Søg", + "Sort by": "Sorter efter", + "and show": "og vis", + "per page": "per side", + "Displaying": "Viser", + "to": "til", + "of": "ud af", + "found": "fandt", + "Title": "Title", + "Author": "Forfatter", + "author": "forfatter", + "Date": "Dato", + "Subject": "Emneord", + "subject": "emneord", + "Location": "Lokation", + "Records": "Poster", + "Targets": "Baser", + + "dummy": "dummy" + } } }; + // Define empty mkws_config for simple applications that don't define it. if (mkws_config == null || typeof mkws_config != 'object') { var mkws_config = {}; } -// wrapper for jQuery lib -function _make_mkws_team($, teamName) { - if (console && console.log) - console.log("run _make_mkws_team(" + (teamName ? teamName : "") + ")"); - - // call this function only once - if (mkws.init) { - alert("_make_mkws_team() called twice: how did that happen?!"); - return; - } +// wrapper for jQuery lib +function team($, teamName) { + var that = {}; + var m_teamName = teamName; + var m_submitted = false; + var m_query; // initially undefined var m_sort = 'relevance'; var m_filters = []; - - // keep time state for debugging + var m_totalRec = 0; + var m_recPerPage = 20; + var m_curPage = 1; + var m_curDetRecId = ''; + var m_curDetRecData = null; var m_debug_time = { + // Timestamps for logging "start": $.now(), "last": $.now() }; + var m_paz; // will be initialised below + + + // if (console && console.log) // disabled, will fail in IE8 + // console.log("run team(" + (teamName ? teamName : "") + ")"); + + // Needs to be defined inside team() so it can see m_debug_time + // ### member access won't work: there is only one instance of this function mkws.debug_function = function (string) { if (!mkws.debug_level) return; @@ -106,117 +194,11 @@ function _make_mkws_team($, teamName) { } else if (mkws.debug_level >= 2) { console.log(timestamp + ">>> called from function " + arguments.callee.caller.name + ' <<<'); } - console.log(timestamp + string); + console.log(m_teamName + ": " + timestamp + string); } var debug = mkws.debug_function; // local alias debug("start running MKWS"); - - Handlebars.registerHelper('json', function(obj) { - return $.toJSON(obj); - }); - - - Handlebars.registerHelper('translate', function(s) { - debug("translating '" + s + "'"); - return M(s); - }); - - - // We need {{attr '@name'}} because Handlebars can't parse {{@name}} - Handlebars.registerHelper('attr', function(attrName) { - return this[attrName]; - }); - - - /* - * Use as follows: {{#if-any NAME1 having="NAME2"}} - * Applicable when NAME1 is the name of an array - * The guarded code runs only if at least one element of the NAME1 - * array has a subelement called NAME2. - */ - Handlebars.registerHelper('if-any', function(items, options) { - var having = options.hash.having; - for (var i in items) { - var item = items[i] - if (!having || item[having]) { - return options.fn(this); - } - } - return ""; - }); - - - Handlebars.registerHelper('first', function(items, options) { - var having = options.hash.having; - for (var i in items) { - var item = items[i] - if (!having || item[having]) { - return options.fn(item); - } - } - return ""; - }); - - - Handlebars.registerHelper('commaList', function(items, options) { - var out = ""; - - for (var i in items) { - if (i > 0) out += ", "; - out += options.fn(items[i]) - } - - return out; - }); - - - { - - /* default mkws config */ - var config_default = { - use_service_proxy: true, - pazpar2_url: "http://mkws.indexdata.com/service-proxy/", - service_proxy_auth: "http://mkws.indexdata.com/service-proxy-auth", - lang: "", - sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]], - perpage_options: [10, 20, 30, 50], - sort_default: "relevance", - perpage_default: 20, - query_width: 50, - show_lang: true, /* show/hide language menu */ - show_sort: true, /* show/hide sort menu */ - show_perpage: true, /* show/hide perpage menu */ - lang_options: [], /* display languages links for given languages, [] for all */ - facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */ - responsive_design_width: undefined, /* a page with less pixel width considered as narrow */ - debug_level: 1, /* debug level for development: 0..2 */ - - dummy: "dummy" - }; - - /* set global debug_level flag early */ - if (typeof mkws_config.debug_level !== 'undefined') { - mkws.debug_level = mkws_config.debug_level; - } else if (typeof config_default.debug_level !== 'undefined') { - mkws.debug_level = config_default.debug_level; - } - - // make sure the mkws_config is a valid hash - if (!$.isPlainObject(mkws_config)) { - debug("ERROR: mkws_config is not an JS object, ignore it...."); - mkws_config = {}; - } - - /* override standard config values by function parameters */ - for (var k in config_default) { - if (typeof mkws_config[k] === 'undefined') - mkws_config[k] = config_default[k]; - debug("Set config: " + k + ' => ' + mkws_config[k]); - } - } - - m_sort = mkws_config.sort_default; debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to m_sort"); @@ -236,66 +218,55 @@ function _make_mkws_team($, teamName) { } } - // protocol independend link for pazpar2: "//mkws/sp" -> "https://mkws/sp" + // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp" if (mkws_config.pazpar2_url.match(/^\/\//)) { mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url; - debug("adjust protocol independend links: " + mkws_config.pazpar2_url); + debug("adjust protocol independent links: " + mkws_config.pazpar2_url); } debug("Create main pz2 object"); // create a parameters array and pass it to the pz2's constructor // then register the form submit event with the pz2.search function // autoInit is set to true on default - var m_paz = new pz2( { "onshow": my_onshow, - "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way - "pazpar2path": mkws_config.pazpar2_url, - "oninit": my_oninit, - "onstat": my_onstat, - "onterm": my_onterm, - "termlist": "xtargets,subject,author", - "onbytarget": my_onbytarget, - "usesessions" : mkws_config.use_service_proxy ? false : true, - "showResponseType": '', // or "json" (for debugging?) - "onrecord": my_onrecord } ); - - // some state vars - var curPage = 1; - var recPerPage = 20; - var totalRec = 0; - var curDetRecId = ''; - var curDetRecData = null; - var submitted = false; - var SourceMax = 16; - var SubjectMax = 10; - var AuthorMax = 10; + m_paz = new pz2({ "onshow": my_onshow, + "windowid": teamName, + "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way + "pazpar2path": mkws_config.pazpar2_url, + "oninit": my_oninit, + "onstat": my_onstat, + "onterm": (mkws_config.facets.length ? my_onterm : undefined), + "termlist": mkws_config.facets.join(','), + "onbytarget": my_onbytarget, + "usesessions" : mkws_config.use_service_proxy ? false : true, + "showResponseType": '', // or "json" (for debugging?) + "onrecord": my_onrecord }); if (!isNaN(parseInt(mkws_config.perpage_default))) { - recPerPage = parseInt(mkws_config.perpage_default); + m_recPerPage = parseInt(mkws_config.perpage_default); } + // // pz2.js event handlers: // - function my_oninit() { + function my_oninit(teamName) { + debug("init"); m_paz.stat(); m_paz.bytarget(); } - function my_onshow(data) { - totalRec = data.merged; - // move it out - var pager = document.getElementById("mkwsPager"); - if (pager) { - pager.innerHTML = ""; - pager.innerHTML +='
' + M('Displaying') + ': ' - + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) + - ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': ' - + data.total + ')
'; - drawPager(pager); + + function my_onshow(data, teamName) { + debug("show"); + m_totalRec = data.merged; + + var pager = $("#mkwsPager"); + if (pager.length) { + drawPager(pager, data); } // navi - var results = document.getElementById("mkwsRecords"); + var results = $(".mkwsRecords.mkwsTeam_" + m_teamName); var html = []; for (var i = 0; i < data.hits.length; i++) { @@ -303,79 +274,86 @@ function _make_mkws_team($, teamName) { html.push('
', renderSummary(hit), '
'); - if (hit.recid == curDetRecId) { - html.push(renderDetails(curDetRecData)); + if (hit.recid == m_curDetRecId) { + if (m_curDetRecData) + html.push(renderDetails(m_curDetRecData)); } } - replaceHtml(results, html.join('')); + results.html(html.join('')); } function renderSummary(hit) { - loadTemplate("Summary"); + var template = loadTemplate("Summary"); hit._id = "mkwsRec_" + hit.recid; - hit._onclick = "mkws.showDetails(this.id);return false;" - return mkws.templateSummary(hit); + hit._onclick = "mkws.showDetails('" + m_teamName + "', this.id);return false;" + return template(hit); } - function my_onstat(data) { - var stat = document.getElementById("mkwsStat"); - if (stat == null) + function my_onstat(data, teamName) { + debug("stat"); + var stat = $('.mkwsStat.mkwsTeam_' + teamName); + if (stat.length === 0) return; - stat.innerHTML = '' + M('Status info') + '' + + stat.html('' + M('Status info') + '' + ' -- ' + '' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '' + ' -- ' + - '' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + ''; + '' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + ''); } - function my_onterm(data) { - // no facets + + function my_onterm(data, teamName) { + debug("term"); + var node = $(".mkwsTermlists.mkwsTeam_" + teamName); + if (node.length == 0) return; + + // no facets: this should never happen if (!mkws_config.facets || mkws_config.facets.length == 0) { - $("#mkwsTermlists").hide(); + alert("my_onterm called even though we have no facets: " + $.toJSON(data)); + node.hide(); return; } // display if we first got results - $("#mkwsTermlists").show(); + node.show(); var acc = []; acc.push('
' + M('Termlists') + '
'); var facets = mkws_config.facets; for(var i = 0; i < facets.length; i++) { - if (facets[i] == "sources") { - add_single_facet(acc, "Sources", data.xtargets, SourceMax, null); - } else if (facets[i] == "subjects") { - add_single_facet(acc, "Subjects", data.subject, SubjectMax, "subject"); - } else if (facets[i] == "authors") { - add_single_facet(acc, "Authors", data.author, AuthorMax, "author"); + if (facets[i] == "xtargets") { + add_single_facet(acc, "Sources", data.xtargets, 16, null); + } else if (facets[i] == "subject") { + add_single_facet(acc, "Subjects", data.subject, 10, "subject"); + } else if (facets[i] == "author") { + add_single_facet(acc, "Authors", data.author, 10, "author"); } else { alert("bad facet configuration: '" + facets[i] + "'"); } } - var termlist = document.getElementById("mkwsTermlists"); - if (termlist) - replaceHtml(termlist, acc.join('')); + node.html(acc.join('')); } + function add_single_facet(acc, caption, data, max, pzIndex) { - acc.push('
'); + acc.push('
'); acc.push('
' + M(caption) + '
'); - for (var i = 0; i < data.length && i < max; i++ ) { + for (var i = 0; i < data.length && i < max; i++) { acc.push('
'); acc.push('' + data[i].name + '' + ' ' + data[i].freq + ''); @@ -384,22 +362,25 @@ function _make_mkws_team($, teamName) { acc.push('
'); } - function my_onrecord(data) { + + function my_onrecord(data, args, teamName) { + debug("record"); // FIXME: record is async!! clearTimeout(m_paz.recordTimer); // in case on_show was faster to redraw element var detRecordDiv = document.getElementById('mkwsDet_'+data.recid); if (detRecordDiv) return; - curDetRecData = data; - var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid); - var html = renderDetails(curDetRecData); + m_curDetRecData = data; + var recordDiv = document.getElementById('mkwsRecdiv_'+m_curDetRecData.recid); + var html = renderDetails(m_curDetRecData); recordDiv.innerHTML += html; } - function my_onbytarget(data) { - var targetDiv = document.getElementById("mkwsBytarget"); + + function my_onbytarget(data, teamName) { + debug("target"); + var targetDiv = $('.mkwsBytarget.mkwsTeam_' + teamName); if (!targetDiv) { - // No mkwsTargets div. return; } @@ -411,7 +392,7 @@ function _make_mkws_team($, teamName) { '' + M('State') + '' + ''; - for (var i = 0; i < data.length; i++ ) { + for (var i = 0; i < data.length; i++) { table += "" + data[i].id + "" + data[i].hits + "" + data[i].diagnostic + @@ -420,17 +401,25 @@ function _make_mkws_team($, teamName) { } table += ''; - targetDiv.innerHTML = table; + targetDiv.html(table); } //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////// + // wait until the DOM is ready function domReady () { - document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler; - document.mkwsSearchForm.mkwsQuery.value = ''; + $('.mkwsSearchForm.mkwsTeam_' + m_teamName).each(function (i, obj) { + debug("adding search-forms for team '" + m_teamName + "'"); + var node = this; + mkws.handle_node_with_team(node, function(tname) { + debug("adding search-form '" + tname + "' for team '" + m_teamName + "'"); + $(node).submit(onFormSubmitEventHandler); + }); + }); + if (document.mkwsSelect) { if (document.mkwsSelect.mkwsSort) document.mkwsSelect.mkwsSort.onchange = onSelectDdChange; @@ -439,14 +428,20 @@ function _make_mkws_team($, teamName) { } } + // when search button pressed function onFormSubmitEventHandler() { - newSearch(document.mkwsSearchForm.mkwsQuery.value); + mkws.handle_node_with_team(this, function (tname) { + var val = $('.mkwsQuery.mkwsTeam_' + tname).val(); + mkws.teams[tname].newSearch(val); + }); + return false; } - function newSearch(query, sort, targets, windowid) + + that.newSearch = function(query, sort, targets, windowid) { debug("newSearch: " + query); @@ -456,29 +451,32 @@ function _make_mkws_team($, teamName) { } m_filters = [] - redraw_navi(); // ### should use windowid + redraw_navi(); resetPage(); // ### the globals it resents should be indexed by windowid loadSelect(); // ### should use windowid triggerSearch(query, sort, targets, windowid); - mkws.switchView('records'); // In case it's configured to start off as hidden - submitted = true; + that.switchView('records'); // In case it's configured to start off as hidden + m_submitted = true; } + function onSelectDdChange() { - if (!submitted) return false; + if (!m_submitted) return false; resetPage(); loadSelect(); - m_paz.show(0, recPerPage, m_sort); + m_paz.show(0, m_recPerPage, m_sort); return false; } + function resetPage() { - curPage = 1; - totalRec = 0; + m_curPage = 1; + m_totalRec = 0; } + function triggerSearch (query, sort, targets, windowid) { var pp2filter = ""; @@ -486,7 +484,7 @@ function _make_mkws_team($, teamName) { // Re-use previous query/sort if new ones are not specified if (query) { - mkws.query = query; + m_query = query; } if (sort) { m_sort = sort; @@ -521,26 +519,28 @@ function _make_mkws_team($, teamName) { if (windowid) { params.windowid = windowid; } - debug("triggerSearch(" + mkws.query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params)); + debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params)); - m_paz.search(mkws.query, recPerPage, m_sort, pp2filter, undefined, params); + m_paz.search(m_query, m_recPerPage, m_sort, pp2filter, undefined, params); } + function loadSelect () { if (document.mkwsSelect) { if (document.mkwsSelect.mkwsSort) m_sort = document.mkwsSelect.mkwsSort.value; if (document.mkwsSelect.mkwsPerpage) - recPerPage = document.mkwsSelect.mkwsPerpage.value; + m_recPerPage = document.mkwsSelect.mkwsPerpage.value; } } - // limit the query after clicking the facet - mkws.limitQuery = function (field, value) + + // limit by target functions + that.limitTarget = function (id, name) { - debug("limitQuery(field=" + field + ", value=" + value + ")"); - m_filters.push({ field: field, value: value }); + debug("limitTarget(id=" + id + ", name=" + name + ")"); + m_filters.push({ id: id, name: name }); redraw_navi(); resetPage(); loadSelect(); @@ -548,11 +548,12 @@ function _make_mkws_team($, teamName) { return false; } - // limit by target functions - mkws.limitTarget = function (id, name) + + // limit the query after clicking the facet + that.limitQuery = function (field, value) { - debug("limitTarget(id=" + id + ", name=" + name + ")"); - m_filters.push({ id: id, name: name }); + debug("limitQuery(field=" + field + ", value=" + value + ")"); + m_filters.push({ field: field, value: value }); redraw_navi(); resetPage(); loadSelect(); @@ -560,15 +561,14 @@ function _make_mkws_team($, teamName) { return false; } - mkws.delimitQuery = function (field, value) + + that.delimitTarget = function (id) { - debug("delimitQuery(field=" + field + ", value=" + value + ")"); + debug("delimitTarget(id=" + id + ")"); var newFilters = []; for (var i in m_filters) { var filter = m_filters[i]; - if (filter.field && - field == filter.field && - value == filter.value) { + if (filter.id) { debug("delimitTarget() removing filter " + $.toJSON(filter)); } else { debug("delimitTarget() keeping filter " + $.toJSON(filter)); @@ -585,16 +585,18 @@ function _make_mkws_team($, teamName) { } - mkws.delimitTarget = function (id) + that.delimitQuery = function (field, value) { - debug("delimitTarget(id=" + id + ")"); + debug("delimitQuery(field=" + field + ", value=" + value + ")"); var newFilters = []; for (var i in m_filters) { var filter = m_filters[i]; - if (filter.id) { - debug("delimitTarget() removing filter " + $.toJSON(filter)); + if (filter.field && + field == filter.field && + value == filter.value) { + debug("delimitQuery() removing filter " + $.toJSON(filter)); } else { - debug("delimitTarget() keeping filter " + $.toJSON(filter)); + debug("delimitQuery() keeping filter " + $.toJSON(filter)); newFilters.push(filter); } } @@ -610,7 +612,7 @@ function _make_mkws_team($, teamName) { function redraw_navi () { - var navi = document.getElementById('mkwsNavi'); + var navi = $('.mkwsNavi.mkwsTeam_' + m_teamName); if (!navi) return; var text = ""; @@ -620,27 +622,32 @@ function _make_mkws_team($, teamName) { } var filter = m_filters[i]; if (filter.id) { - text += 'Source: ' + filter.name + ''; + text += M('source') + ': ' + filter.name + ''; } else { - text += filter.field + ': ' + filter.value + ''; } } - navi.innerHTML = text; + navi.html(text); } - function drawPager (pagerDiv) + function drawPager (pagerDiv, data) { + var s = '
' + M('Displaying') + ': ' + + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) + + ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': ' + + data.total + ')
'; + //client indexes pages from 1 but pz2 from 0 var onsides = 6; - var pages = Math.ceil(totalRec / recPerPage); + var pages = Math.ceil(m_totalRec / m_recPerPage); - var firstClkbl = ( curPage - onsides > 0 ) - ? curPage - onsides + var firstClkbl = (m_curPage - onsides > 0) + ? m_curPage - onsides : 1; var lastClkbl = firstClkbl + 2*onsides < pages @@ -648,14 +655,14 @@ function _make_mkws_team($, teamName) { : pages; var prev = '<< ' + M('Prev') + ' | '; - if (curPage > 1) + if (m_curPage > 1) prev = '' +'<< ' + M('Prev') + ' | '; var middle = ''; for(var i = firstClkbl; i <= lastClkbl; i++) { var numLabel = i; - if(i == curPage) + if(i == m_curPage) numLabel = '' + i + ''; middle += ' ' @@ -663,7 +670,7 @@ function _make_mkws_team($, teamName) { } var next = ' | ' + M('Next') + ' >>'; - if (pages - curPage > 0) + if (pages - m_curPage > 0) next = ' | ' + M('Next') + ' >>'; @@ -675,70 +682,72 @@ function _make_mkws_team($, teamName) { if (lastClkbl < pages) postdots = '...'; - pagerDiv.innerHTML += '
' + s += '
' + prev + predots + middle + postdots + next + '
'; + pagerDiv.html(s); } + mkws.showPage = function (pageNum) { - curPage = pageNum; - m_paz.showPage( curPage - 1 ); + m_curPage = pageNum; + m_paz.showPage(m_curPage - 1); } - // simple paging functions + // simple paging functions mkws.pagerNext = function () { - if ( totalRec - recPerPage*curPage > 0) { + if (m_totalRec - m_recPerPage*m_curPage > 0) { m_paz.showNext(); - curPage++; + m_curPage++; } } + mkws.pagerPrev = function () { - if ( m_paz.showPrev() != false ) - curPage--; + if (m_paz.showPrev() != false) + m_curPage--; } - // switching view between targets and records - mkws.switchView = function(view) { - debug("switchView: " + view); - - var targets = document.getElementById('mkwsTargets'); - var results = document.getElementById('mkwsResults') || - document.getElementById('mkwsRecords'); - var blanket = document.getElementById('mkwsBlanket'); - var motd = document.getElementById('mkwsMOTD'); + // switching view between targets and records + that.switchView = function(view) { + var targets = $('.mkwsTargets.mkwsTeam_' + m_teamName); + var results = $('.mkwsResults.mkwsTeam_' + m_teamName + ',.mkwsRecords.mkwsTeam_' + m_teamName); + var blanket = $('.mkwsBlanket.mkwsTeam_' + m_teamName); + var motd = $('.mkwsMOTD.mkwsTeam_' + m_teamName); switch(view) { case 'targets': - if (targets) targets.style.display = "block"; - if (results) results.style.display = "none"; - if (blanket) blanket.style.display = "none"; - if (motd) motd.style.display = "none"; + if (targets) targets.css('display', 'block'); + if (results) results.css('display', 'none'); + if (blanket) blanket.css('display', 'none'); + if (motd) motd.css('display', 'none'); break; case 'records': - if (targets) targets.style.display = "none"; - if (results) results.style.display = "block"; - if (blanket) blanket.style.display = "block"; - if (motd) motd.style.display = "none"; + if (targets) targets.css('display', 'none'); + if (results) results.css('display', 'block'); + if (blanket) blanket.css('display', 'block'); + if (motd) motd.css('display', 'none'); break; case 'none': - if (targets) targets.style.display = "none"; - if (results) results.style.display = "none"; - if (blanket) blanket.style.display = "none"; - if (motd) motd.style.display = "none"; + alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen"); + if (targets) targets.css('display', 'none'); + if (results) results.css('display', 'none'); + if (blanket) blanket.css('display', 'none'); + if (motd) motd.css('display', 'none'); break; default: alert("Unknown view '" + view + "'"); } } + // detailed record drawing - mkws.showDetails = function (prefixRecId) { + that.showDetails = function (prefixRecId) { var recId = prefixRecId.replace('mkwsRec_', ''); - var oldRecId = curDetRecId; - curDetRecId = recId; + var oldRecId = m_curDetRecId; + m_curDetRecId = recId; // remove current detailed view if any var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId); @@ -748,32 +757,19 @@ function _make_mkws_team($, teamName) { // if the same clicked, just hide if (recId == oldRecId) { - curDetRecId = ''; - curDetRecData = null; + m_curDetRecId = ''; + m_curDetRecData = null; return; } // request the record + debug("showDetails() requesting record '" + recId + "'"); m_paz.record(recId); } - function replaceHtml(el, html) { - var oldEl = typeof el === "string" ? document.getElementById(el) : el; - /*@cc_on // Pure innerHTML is slightly faster in IE - oldEl.innerHTML = html; - return oldEl; - @*/ - var newEl = oldEl.cloneNode(false); - newEl.innerHTML = html; - oldEl.parentNode.replaceChild(newEl, oldEl); - /* Since we just removed the old element from the DOM, return a reference - to the new element, which can be used to restore variable references. */ - return newEl; - }; function renderDetails(data, marker) { - loadTemplate("Record"); - var template = mkws.templateRecord; + var template = loadTemplate("Record"); var details = template(data); return '
' + details + '
'; } @@ -781,16 +777,20 @@ function _make_mkws_team($, teamName) { function loadTemplate(name) { - if (mkws['template' + name] === undefined) { + var template = mkws['template' + name]; + + if (template === undefined) { var source = $("#mkwsTemplate" + name).html(); if (!source) { source = defaultTemplate(name); } - var template = Handlebars.compile(source); + template = Handlebars.compile(source); debug("compiled template '" + name + "'"); mkws['template' + name] = template; } + + return template; } @@ -886,38 +886,45 @@ function _make_mkws_team($, teamName) { // For some reason, doing this programmatically results in // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML. debug("HTML search form"); - $("#mkwsSearch").html('\ -
\ - \ - \ + // ### There is only one match here by design: fix not to bother looping + $('.mkwsSearch.mkwsTeam_' + m_teamName).each(function (i, obj) { + var node = this; + mkws.handle_node_with_team(node, function(tname) { + $(node).html('\ +\ + \ + \
'); + }); + }); debug("HTML records"); - // If the application has an #mkwsResults, populate it in the - // usual way. If not, assume that it's a smarter application that - // defines its own subcomponents: - // #mkwsTermlists - // #mkwsRanking - // #mkwsPager - // #mkwsNavi - // #mkwsRecords - if ($("#mkwsResults").length) { - $("#mkwsResults").html('\ + // If the team has a .mkwsResults, populate it in the usual + // way. If not, assume that it's a smarter application that + // defines its own subcomponents, some or all of the + // following: + // .mkwsTermlists + // .mkwsRanking + // .mkwsPager + // .mkwsNavi + // .mkwsRecords + if ($(".mkwsResults.mkwsTeam_" + m_teamName).length) { + $(".mkwsResults.mkwsTeam_" + m_teamName).html('\ \ \ - \ - \ \ \ \ \
\ -
\ + 		\ +
\ 		\ -
\ -
\ -
\ -
\ + 		\ +
\ +
\ +
\ +
\
\ -
\ +
\
'); @@ -939,64 +946,27 @@ function _make_mkws_team($, teamName) { mkws_html_switch(); - if (mkws_config.use_service_proxy) { - mkws_service_proxy_auth(mkws_config.service_proxy_auth, - mkws_config.service_proxy_auth_domain, - mkws_config.pazpar2_url); - } else { - // raw pp2 - run_auto_searches(); - } - if (mkws_config.responsive_design_width) { // Responsive web design - change layout on the fly based on // current screen width. Required for mobile devices. - $(window).resize( function(e) { mkws_resize_page() }); + $(window).resize(function(e) { mkws.resize_page() }); // initial check after page load - $(document).ready(function() { mkws_resize_page() }); + $(document).ready(function() { mkws.resize_page() }); } domReady(); // on first page, hide the termlist - $(document).ready(function() { $("#mkwsTermlists").hide(); } ); - var motd = document.getElementById("mkwsMOTD"); - var container = document.getElementById("mkwsMOTDContainer"); - if (motd && container) { + $(document).ready(function() { $(".mkwsTermlists.mkwsTeam_" + m_teamName).hide(); }); + var motd = $(".mkwsMOTD.mkwsTeam_" + m_teamName); + var container = $(".mkwsMOTDContainer.mkwsTeam_" + m_teamName); + if (motd.length && container.length) { // Move the MOTD from the provided element down into the container - motd.parentNode.removeChild(motd); - container.appendChild(motd); + motd.appendTo(container); } } - function run_auto_searches() { - debug("running auto searches"); - - $('[id^="mkwsRecords"]').each(function () { - var node = $(this); - var query = node.attr('autosearch'); - - if (query) { - var windowid = undefined; - var id = node.attr('id'); - if (id.match(/^mkwsRecords_/, '')) { - windowid = id.replace(/^mkwsRecords_/, ''); - } - - var sort = node.attr('sort'); - var targets = node.attr('targets'); - var s = "running auto search: '" + query + "'"; - if (windowid) s += " [windowid '" + windowid + "']"; - if (sort) s += " sorted by '" + sort + "'"; - if (targets) s += " in targets '" + targets + "'"; - debug(s); - newSearch(query, sort, targets, windowid); - } - }); - } - - // implement $.parseQuerystring() for parsing URL parameters function parseQuerystring() { var nvpair = {}; @@ -1009,6 +979,7 @@ function _make_mkws_team($, teamName) { return nvpair; } + function mkws_set_lang() { var lang = parseQuerystring().lang || mkws_config.lang; if (!lang || !mkws.locale_lang[lang]) { @@ -1021,21 +992,25 @@ function _make_mkws_team($, teamName) { return mkws_config.lang; } + function mkws_html_switch() { - debug("HTML switch"); + debug("HTML switch for team " + m_teamName); - $("#mkwsSwitch").append($('' + M('Records') + '')); - $("#mkwsSwitch").append($("", { text: " | " })); - $("#mkwsSwitch").append($('' + M('Targets') + '')); + var node = $(".mkwsSwitch.mkwsTeam_" + m_teamName); + node.append($('' + M('Records') + '')); + node.append($("", { text: " | " })); + node.append($('' + M('Targets') + '')); debug("HTML targets"); - $("#mkwsTargets").html('\ -
\ + var node = $(".mkwsTargets.mkwsTeam_" + m_teamName); + node.html('\ +
\ No information available yet.\
'); - $("#mkwsTargets").css("display", "none"); + node.css("display", "none"); } + function mkws_html_sort() { debug("HTML sort, m_sort = '" + m_sort + "'"); var sort_html = ''; @@ -1074,40 +1050,6 @@ function _make_mkws_team($, teamName) { return perpage_html; } - /* - * Run service-proxy authentication in background (after page load). - * The username/password is configured in the apache config file - * for the site. - */ - function mkws_service_proxy_auth(auth_url, auth_domain, pp2_url) { - debug("Run service proxy auth URL: " + auth_url); - - if (!auth_domain) { - auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2'); - debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'"); - } - - var request = new pzHttpRequest(auth_url, function(err) { - alert("HTTP call for authentication failed: " + err) - return; - }, auth_domain); - - request.get(null, function(data) { - if (!$.isXMLDoc(data)) { - alert("service proxy auth response document is not valid XML document, give up!"); - return; - } - var status = $(data).find("status"); - if (status.text() != "OK") { - alert("service proxy auth repsonse status: " + status.text() + ", give up!"); - return; - } - - debug("Service proxy auth successfully done"); - mkws.authenticated = true; - run_auto_searches(); - }); - } /* create locale language menu */ function mkws_html_lang() { @@ -1117,18 +1059,18 @@ function _make_mkws_team($, teamName) { /* display a list of configured languages, or all */ var lang_options = mkws_config.lang_options || []; - var hash = {}; + var toBeIncluded = {}; for (var i = 0; i < lang_options.length; i++) { - hash[lang_options[i]] = 1; + toBeIncluded[lang_options[i]] = true; } for (var k in mkws.locale_lang) { - if (hash[k] == 1 || lang_options.length == 0) + if (toBeIncluded[k] || lang_options.length == 0) list.push(k); } // add english link - if (lang_options.length == 0 || hash[lang_default] == 1) + if (lang_options.length == 0 || toBeIncluded[lang_default]) list.push(lang_default); debug("Language menu for: " + list.join(", ")); @@ -1148,35 +1090,9 @@ function _make_mkws_team($, teamName) { } } - $("#mkwsLang").html(data); + $(".mkwsLang.mkwsTeam_" + m_teamName).html(data); } - function mkws_resize_page () { - var list = ["mkwsSwitch"]; - - var width = mkws_config.responsive_design_width; - var parentId = $("#mkwsTermlists").parent().attr('id'); - - if ($(window).width() <= width && - parentId === "mkwsTermlistContainer1") { - debug("changing from wide to narrow: " + $(window).width()); - $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer2")); - $("#mkwsTermlistContainer1").hide(); - $("#mkwsTermlistContainer2").show(); - for(var i = 0; i < list.length; i++) { - $("#" + list[i]).hide(); - } - } else if ($(window).width() > width && - parentId === "mkwsTermlistContainer2") { - debug("changing from narrow to wide: " + $(window).width()); - $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer1")); - $("#mkwsTermlistContainer1").show(); - $("#mkwsTermlistContainer2").hide(); - for(var i = 0; i < list.length; i++) { - $("#" + list[i]).show(); - } - } - }; /* locale */ function M(word) { @@ -1187,6 +1103,8 @@ function _make_mkws_team($, teamName) { return mkws.locale_lang[lang][word] || word; } + mkws.M = M; // so the Handlebars helper can use it + // main (function() { @@ -1200,8 +1118,9 @@ function _make_mkws_team($, teamName) { } })(); - // done - mkws.init = true; + // Bizarrely, 'that' is just an empty hash. All its state is in + // the closure variables defined earlier in this function. + return that; }; @@ -1338,7 +1257,7 @@ function _mkws_jquery_plugin ($) { } else if (config && config.layout == 'popup') { debug("jquery plugin layout: popup with id: " + id_popup); document.write(popup); - $(document).ready( function() { init_popup(config); } ); + $(document).ready(function() { init_popup(config); }); } else { debug("jquery plugin layout: table"); document.write(table); @@ -1348,13 +1267,242 @@ function _mkws_jquery_plugin ($) { }; -// wrapper to call _make_mkws_team() after page load +// wrapper to call team() after page load (function (j) { + function log(s) { + if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */ + return; + } + console.log(s); + } + // enable before page load, so we could call it before mkws() runs _mkws_jquery_plugin(j); + + mkws.handle_node_with_team = function(node, callback) { + var classes = node.className; + var list = classes.split(/\s+/) + var tname; + for (var i = 0; i < list.length; i++) { + var cname = list[i]; + if (cname.match(/^mkwsTeam_/)) { + tname = cname.replace(/^mkwsTeam_/, ''); + } + } + callback(tname); + } + + + mkws.resize_page = function () { + var list = ["mkwsSwitch", "mkwsLang"]; + + var width = mkws_config.responsive_design_width; + var parent = $(".mkwsTermlists").parent(); + + if ($(window).width() <= width && + parent.hasClass("mkwsTermlistContainer1")) { + log("changing from wide to narrow: " + $(window).width()); + $(".mkwsTermlistContainer1").hide(); + $(".mkwsTermlistContainer2").show(); + for (var tname in mkws.teams) { + $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname)); + for(var i = 0; i < list.length; i++) { + $("." + list[i] + ".mkwsTeam_" + tname).hide(); + } + } + } else if ($(window).width() > width && + parent.hasClass("mkwsTermlistContainer2")) { + log("changing from narrow to wide: " + $(window).width()); + $(".mkwsTermlistContainer1").show(); + $(".mkwsTermlistContainer2").hide(); + for (var tname in mkws.teams) { + $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname)); + for(var i = 0; i < list.length; i++) { + $("." + list[i] + ".mkwsTeam_" + tname).show(); + } + } + } + }; + + + mkws.switchView = function(tname, view) { + mkws.teams[tname].switchView(view); + } + + mkws.showDetails = function (tname, prefixRecId) { + mkws.teams[tname].showDetails(prefixRecId); + } + + mkws.limitTarget = function (tname, id, name) { + mkws.teams[tname].limitTarget(id, name); + } + + mkws.limitQuery = function (tname, field, value) { + mkws.teams[tname].limitQuery(field, value); + } + + mkws.delimitTarget = function (tname, id) { + mkws.teams[tname].delimitTarget(id); + } + + mkws.delimitQuery = function (tname, field, value) { + mkws.teams[tname].delimitQuery(field, value); + } + + + function default_mkws_config() { + /* default mkws config */ + var config_default = { + use_service_proxy: true, + pazpar2_url: "//mkws.indexdata.com/service-proxy/", + service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth", + lang: "", + sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]], + perpage_options: [10, 20, 30, 50], + sort_default: "relevance", + perpage_default: 20, + query_width: 50, + show_lang: true, /* show/hide language menu */ + show_sort: true, /* show/hide sort menu */ + show_perpage: true, /* show/hide perpage menu */ + lang_options: [], /* display languages links for given languages, [] for all */ + facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */ + responsive_design_width: undefined, /* a page with less pixel width considered as narrow */ + debug_level: 1, /* debug level for development: 0..2 */ + + dummy: "dummy" + }; + + /* Set global debug_level flag early so that debug() works */ + if (typeof mkws_config.debug_level !== 'undefined') { + mkws.debug_level = mkws_config.debug_level; + } else if (typeof config_default.debug_level !== 'undefined') { + mkws.debug_level = config_default.debug_level; + } + + // make sure the mkws_config is a valid hash + if (!$.isPlainObject(mkws_config)) { + debug("ERROR: mkws_config is not an JS object, ignore it...."); + mkws_config = {}; + } + + /* override standard config values by function parameters */ + for (var k in config_default) { + if (typeof mkws_config[k] === 'undefined') + mkws_config[k] = config_default[k]; + //debug("Set config: " + k + ' => ' + mkws_config[k]); + } + } + + + /* + * Run service-proxy authentication in background (after page load). + * The username/password is configured in the apache config file + * for the site. + */ + function authenticate_session(auth_url, auth_domain, pp2_url) { + log("Run service proxy auth URL: " + auth_url); + + if (!auth_domain) { + auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2'); + log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'"); + } + + var request = new pzHttpRequest(auth_url, function(err) { + alert("HTTP call for authentication failed: " + err) + return; + }, auth_domain); + + request.get(null, function(data) { + if (!$.isXMLDoc(data)) { + alert("service proxy auth response document is not valid XML document, give up!"); + return; + } + var status = $(data).find("status"); + if (status.text() != "OK") { + alert("service proxy auth repsonse status: " + status.text() + ", give up!"); + return; + } + + log("Service proxy auth successfully done"); + mkws.authenticated = true; + run_auto_searches(); + }); + } + + + function run_auto_searches() { + log("running auto searches"); + + for (var teamName in mkws.teams) { + // ### should check mkwsTermlist as well, for facet-only teams + var node = $('.mkwsRecords.mkwsTeam_' + teamName); + var query = node.attr('autosearch'); + log("teamName '" + teamName + "', node=" + node + ", class='" + node.className + "', query=" + query); + + if (query) { + var sort = node.attr('sort'); + var targets = node.attr('targets'); + var s = "running auto search: '" + query + "'"; + if (teamName) s += " [teamName '" + teamName + "']"; + if (sort) s += " sorted by '" + sort + "'"; + if (targets) s += " in targets '" + targets + "'"; + log(s); + var team = mkws.teams[teamName]; + log($.toJSON(team)); + team.newSearch(query, sort, targets, teamName); + } + } + } + + $(document).ready(function() { - // if (console && console.log) console.log("on load ready"); - _make_mkws_team(j, null); + log("on load ready"); + default_mkws_config(); + + // Backwards compatibility: set new magic class names on any + // elements that have the old magic IDs. + var ids = [ "Switch", "Lang", "Search", "Pager", "Navi", + "Results", "Records", "Targets", "Ranking", + "Termlists", "Stat" ]; + for (var i = 0; i < ids.length; i++) { + var id = 'mkws' + ids[i]; + var node = $('#' + id); + if (node.attr('id')) { + node.addClass(id); + log("added magic class to '" + node.attr('id') + "'"); + } + } + + // For all MKWS-classed nodes that don't have a team + // specified, set the team to AUTO. + $('[class^="mkws"],[class*=" mkws"]').each(function () { + if (!this.className.match(/mkwsTeam_/)) { + log("adding AUTO team to node with class '" + this.className + "'"); + $(this).addClass('mkwsTeam_AUTO'); + } + }); + + // Find all nodes with an class, and determine their team from + // the mkwsTeam_* class. Make all team objects. + $('[class^="mkws"],[class*=" mkws"]').each(function () { + var node = this; + mkws.handle_node_with_team(node, function(tname) { + if (!mkws.teams[tname]) { + mkws.teams[tname] = team(j, tname); + log("Made MKWS team '" + tname + "'"); + } + }); + }); + + if (mkws_config.use_service_proxy) { + authenticate_session(mkws_config.service_proxy_auth, + mkws_config.service_proxy_auth_domain, + mkws_config.pazpar2_url); + } else { + // raw pp2 + run_auto_searches(); + } }); })(jQuery);