All member variable names now have the m_ prefix
[mkws-moved-to-github.git] / tools / htdocs / mkws.js
index 9893577..8b8ff07 100644 (file)
 
 "use strict"; // HTML5: disable for debug_level >= 2
 
+
+// Handlebars helpers
+Handlebars.registerHelper('json', function(obj) {
+    return $.toJSON(obj);
+});
+
+
+Handlebars.registerHelper('translate', function(s) {
+    debug("translating '" + 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: mkws.switchView(), showDetails(), limitTarget(),
 // limitQuery(), delimitTarget(), delimitQuery(), pagerPrev(),
-// pagerNext(), showPage()
+// pagerNext(), showPage(). Also mkws.M() is made available for the
+// Handlebars helper 'translate'
+
 
 // Set up global mkws object. Contains a hash of session 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"
+    init: false,
+    debug_function: undefined, // will be set during initialisation
+    debug_level: undefined, // will be initialised from mkws_config
+    sessions: {},
+    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"
+       }
     }
 };
 
+
 // 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 : "") + ")");
+    var m_sort = 'relevance';
+    var m_filters = [];
+    var m_curPage = 1;
+    var m_recPerPage = 20;
+    var m_totalRec = 0;
+    var m_curDetRecId = '';
+    var m_curDetRecData = null;
+    var m_submitted = false;
+    var m_SourceMax = 16;
+    var m_SubjectMax = 10;
+    var m_AuthorMax = 10;
+    var m_query; // initially undefined
+    var m_debug_time = {
+       // Timestamps for logging
+       "start": $.now(),
+       "last": $.now()
+    };
+
 
     // call this function only once
     if (mkws.init) {
@@ -84,15 +168,11 @@ function _make_mkws_team($, teamName) {
        return;
     }
 
-    var m_sort = 'relevance';
-    var m_filters = [];
+    // if (console && console.log) // disabled, will fail in IE8
+    // console.log("run _make_mkws_team(" + (teamName ? teamName : "") + ")");
 
-    // keep time state for debugging
-    var m_debug_time = {
-       "start": $.now(),
-       "last": $.now()
-    };
 
+    // Needs to be defined inside _make_mkws_team() so it can see m_debug_time
     mkws.debug_function = function (string) {
        if (!mkws.debug_level)
            return;
@@ -117,65 +197,6 @@ function _make_mkws_team($, teamName) {
     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 */
@@ -263,21 +284,11 @@ function _make_mkws_team($, teamName) {
                           "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;
-
     if (!isNaN(parseInt(mkws_config.perpage_default))) {
-       recPerPage = parseInt(mkws_config.perpage_default);
+       m_recPerPage = parseInt(mkws_config.perpage_default);
     }
 
+
     //
     // pz2.js event handlers:
     //
@@ -286,8 +297,9 @@ function _make_mkws_team($, teamName) {
        m_paz.bytarget();
     }
 
+
     function my_onshow(data) {
-       totalRec = data.merged;
+       m_totalRec = data.merged;
        // move it out
        var pager = document.getElementById("mkwsPager");
        if (pager) {
@@ -308,8 +320,8 @@ function _make_mkws_team($, teamName) {
            html.push('<div class="record" id="mkwsRecdiv_' + hit.recid + '" >',
                      renderSummary(hit),
                      '</div>');
-           if (hit.recid == curDetRecId) {
-               html.push(renderDetails(curDetRecData));
+           if (hit.recid == m_curDetRecId) {
+               html.push(renderDetails(m_curDetRecData));
            }
        }
        replaceHtml(results, html.join(''));
@@ -337,6 +349,7 @@ function _make_mkws_team($, teamName) {
             '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>';
     }
 
+
     function my_onterm(data) {
        // no facets
        if (!mkws_config.facets || mkws_config.facets.length == 0) {
@@ -353,11 +366,11 @@ function _make_mkws_team($, teamName) {
 
        for(var i = 0; i < facets.length; i++) {
            if (facets[i] == "sources") {
-               add_single_facet(acc, "Sources",  data.xtargets, SourceMax, null);
+               add_single_facet(acc, "Sources",  data.xtargets, m_SourceMax, null);
            } else if (facets[i] == "subjects") {
-               add_single_facet(acc, "Subjects", data.subject,  SubjectMax, "subject");
+               add_single_facet(acc, "Subjects", data.subject,  m_SubjectMax, "subject");
            } else if (facets[i] == "authors") {
-               add_single_facet(acc, "Authors",  data.author,   AuthorMax, "author");
+               add_single_facet(acc, "Authors",  data.author,   m_AuthorMax, "author");
            } else {
                alert("bad facet configuration: '" + facets[i] + "'");
            }
@@ -368,6 +381,7 @@ function _make_mkws_team($, teamName) {
            replaceHtml(termlist, acc.join(''));
     }
 
+
     function add_single_facet(acc, caption, data, max, pzIndex) {
        acc.push('<div class="facet" id="mkwsFacet' + caption + '">');
        acc.push('<div class="termtitle">' + M(caption) + '</div>');
@@ -389,18 +403,20 @@ function _make_mkws_team($, teamName) {
        acc.push('</div>');
     }
 
+
     function my_onrecord(data) {
        // 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");
        if (!targetDiv) {
@@ -431,6 +447,7 @@ function _make_mkws_team($, teamName) {
     ////////////////////////////////////////////////////////////////////////////////
     ////////////////////////////////////////////////////////////////////////////////
 
+
     // wait until the DOM is ready
     function domReady ()
     {
@@ -444,6 +461,7 @@ function _make_mkws_team($, teamName) {
        }
     }
 
+
     // when search button pressed
     function onFormSubmitEventHandler()
     {
@@ -451,6 +469,7 @@ function _make_mkws_team($, teamName) {
        return false;
     }
 
+
     function newSearch(query, sort, targets, windowid)
     {
        debug("newSearch: " + query);
@@ -466,24 +485,27 @@ function _make_mkws_team($, teamName) {
        loadSelect(); // ### should use windowid
        triggerSearch(query, sort, targets, windowid);
        mkws.switchView('records'); // In case it's configured to start off as hidden
-       submitted = true;
+       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 = "";
@@ -491,7 +513,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;
@@ -526,21 +548,23 @@ 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)
     {
@@ -553,6 +577,7 @@ function _make_mkws_team($, teamName) {
        return false;
     }
 
+
     // limit by target functions
     mkws.limitTarget  = function (id, name)
     {
@@ -565,6 +590,7 @@ function _make_mkws_team($, teamName) {
        return false;
     }
 
+
     mkws.delimitQuery = function (field, value)
     {
        debug("delimitQuery(field=" + field + ", value=" + value + ")");
@@ -642,10 +668,10 @@ function _make_mkws_team($, teamName) {
     {
        //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
@@ -653,14 +679,14 @@ function _make_mkws_team($, teamName) {
             : pages;
 
        var prev = '<span id="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
-       if (curPage > 1)
+       if (m_curPage > 1)
             prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev();">'
             +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
 
        var middle = '';
        for(var i = firstClkbl; i <= lastClkbl; i++) {
             var numLabel = i;
-            if(i == curPage)
+            if(i == m_curPage)
                numLabel = '<b>' + i + '</b>';
 
             middle += '<a href="#" onclick="mkws.showPage(' + i + ')"> '
@@ -668,7 +694,7 @@ function _make_mkws_team($, teamName) {
        }
 
        var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
-       if (pages - curPage > 0)
+       if (pages - m_curPage > 0)
             next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext()">'
             + M('Next') + ' &#62;&#62;</a>';
 
@@ -684,28 +710,30 @@ function _make_mkws_team($, teamName) {
             + prev + predots + middle + postdots + next + '</div>';
     }
 
+
     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--;
+            m_curPage--;
     }
 
-    // switching view between targets and records
 
+    // switching view between targets and records
     mkws.switchView = function(view) {
        debug("switchView: " + view);
 
@@ -739,11 +767,12 @@ function _make_mkws_team($, teamName) {
        }
     }
 
+
     // detailed record drawing
     mkws.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);
@@ -753,14 +782,15 @@ 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
        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
@@ -775,6 +805,7 @@ function _make_mkws_team($, teamName) {
        return newEl;
     };
 
+
     function renderDetails(data, marker)
     {
        var template = loadTemplate("Record");
@@ -1017,6 +1048,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]) {
@@ -1029,6 +1061,7 @@ function _make_mkws_team($, teamName) {
        return mkws_config.lang;
     }
 
+
     function mkws_html_switch() {
        debug("HTML switch");
 
@@ -1044,6 +1077,7 @@ function _make_mkws_team($, teamName) {
        $("#mkwsTargets").css("display", "none");
     }
 
+
     function mkws_html_sort() {
        debug("HTML sort, m_sort = '" + m_sort + "'");
        var sort_html = '<select name="mkwsSort" id="mkwsSort">';
@@ -1064,6 +1098,7 @@ function _make_mkws_team($, teamName) {
        return sort_html;
     }
 
+
     function mkws_html_perpage() {
        debug("HTML perpage");
        var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
@@ -1082,6 +1117,7 @@ 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
@@ -1117,6 +1153,7 @@ function _make_mkws_team($, teamName) {
        });
     }
 
+
     /* create locale language menu */
     function mkws_html_lang() {
        var lang_default = "en";
@@ -1159,6 +1196,7 @@ function _make_mkws_team($, teamName) {
        $("#mkwsLang").html(data);
     }
 
+
     function mkws_resize_page () {
        var list = ["mkwsSwitch"];
 
@@ -1186,6 +1224,7 @@ function _make_mkws_team($, teamName) {
        }
     };
 
+
     /* locale */
     function M(word) {
        var lang = mkws_config.lang;
@@ -1195,6 +1234,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() {