move the jquery plugins out of the _mkws() function,
[mkws-moved-to-github.git] / tools / htdocs / mkws.js
index 2a3f471..34ad96d 100644 (file)
@@ -1,24 +1,24 @@
-/* A very simple client that shows a basic usage of the pz2.js
-*/
+/*! MKWS, the MasterKey Widget Set. Copyright (C) 2013, Index Data */
 
 "use strict"; // HTML5: disable for debug_level >= 2
 
 // Set up namespace and some state.
 var mkws = {
-    filters: [],
+    sort: 'relevance',
+    authenticated: false,
+    filters: []
 };
 
-/*
- * global config object: mkws_config
- *
- * Needs to be defined in the HTML header before including this JS file.
- * Define empty mkws_config for simple applications that don't define it.
- */
+// Define empty mkws_config for simple applications that don't define it.
 if (!mkws_config)
     var mkws_config = {};
 
-// Wrapper for jQuery
-(function ($) {
+// wrapper for jQuery lib
+function _mkws($) {
+    // if (console && console.log) console.log("run _mkws()");
+
+    // call this function only once
+    if (mkws.init) return;
 
 mkws.locale_lang = {
     "de": {
@@ -87,7 +87,7 @@ mkws.debug_function = function (string) {
     }
 
     var now = $.now();
-    var timestamp = (now - mkws.debug_time.start)/1000 + " (+" + (now - mkws.debug_time.last)/1000 + ") "
+    var timestamp = ((now - mkws.debug_time.start)/1000).toFixed(3) + " (+" + ((now - mkws.debug_time.last)/1000).toFixed(3) + ") "
     mkws.debug_time.last = now;
 
     // you need to disable use strict at the top of the file!!!
@@ -99,10 +99,11 @@ mkws.debug_function = function (string) {
     console.log(timestamp + string);
 }
 var debug = mkws.debug_function; // local alias
+debug("start running MKWS");
 
 
 Handlebars.registerHelper('json', function(obj) {
-    return JSON.stringify(obj);
+    return $.toJSON(obj);
 });
 
 
@@ -158,6 +159,7 @@ Handlebars.registerHelper('commaList', function(items, options) {
     /* 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"]],
@@ -191,6 +193,11 @@ Handlebars.registerHelper('commaList', function(items, options) {
     }
 }
 
+mkws.sort = mkws_config.sort_default;
+debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to mkws.sort");
+
+mkws.usesessions = mkws_config.use_service_proxy ? false : true;
+
 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
     debug("Reset query width: " + mkws_config.query_width);
     mkws_config.query_width = 50;
@@ -207,19 +214,19 @@ for (var key in mkws_config) {
     }
 }
 
-
+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 my_paz = new pz2( { "onshow": my_onshow,
                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
-                    "pazpar2path": mkws_config.pazpar2_url || "http://mkws.indexdata.com/service-proxy/",
+                    "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,
+                   "usesessions" : mkws.usesessions,
                     "showResponseType": '', // or "json" (for debugging?)
                     "onrecord": my_onrecord } );
 
@@ -231,7 +238,6 @@ var recPerPage = 20;
 var totalRec = 0;
 var curDetRecId = '';
 var curDetRecData = null;
-var curSort = 'relevance';
 var submitted = false;
 var SourceMax = 16;
 var SubjectMax = 10;
@@ -326,7 +332,8 @@ function my_onterm(data) {
     }
 
     var termlist = document.getElementById("mkwsTermlists");
-    replaceHtml(termlist, acc.join(''));
+    if (termlist)
+       replaceHtml(termlist, acc.join(''));
 }
 
 function add_single_facet(acc, caption, data, max, pzIndex) {
@@ -408,12 +415,26 @@ function domReady ()
 // when search button pressed
 function onFormSubmitEventHandler()
 {
+    newSearch(document.mkwsSearchForm.mkwsQuery.value);
+    return false;
+}
+
+function newSearch(query, sort, targets)
+{
+    debug("newSearch: " + query);
+
+    if (mkws_config.use_service_proxy && !mkws.authenticated) {
+       alert("searching before authentication");
+       return;
+    }
+
+    mkws.filters = []
+    redraw_navi();
     resetPage();
     loadSelect();
-    triggerSearch();
+    triggerSearch(query, sort, targets);
     mkws.switchView('records'); // In case it's configured to start off as hidden
     submitted = true;
-    return false;
 }
 
 function onSelectDdChange()
@@ -421,7 +442,7 @@ function onSelectDdChange()
     if (!submitted) return false;
     resetPage();
     loadSelect();
-    my_paz.show(0, recPerPage, curSort);
+    my_paz.show(0, recPerPage, mkws.sort);
     return false;
 }
 
@@ -431,17 +452,34 @@ function resetPage()
     totalRec = 0;
 }
 
-function triggerSearch ()
+function triggerSearch (query, sort, targets)
 {
     var pp2filter = "";
     var pp2limit = "";
 
+    // Re-use previous query/sort if new ones are not specified
+    if (query) {
+       mkws.query = query;
+    }
+    if (sort) {
+       mkws.sort = sort;
+    }
+    if (targets) {
+       // ### should support multiple |-separated targets
+       mkws.filters.push({ id: targets, name: targets });
+    }
+
     for (var i in mkws.filters) {
        var filter = mkws.filters[i];
        if (filter.id) {
            if (pp2filter)
                pp2filter += ",";
-           pp2filter += 'pz:id=' + filter.id;
+           if (filter.id.match(/^[a-z:]+[=~]/)) {
+               debug("filter '" + filter.id + "' already begins with SETTING OP");
+           } else {
+               filter.id = 'pz:id=' + filter.id;
+           }
+           pp2filter += filter.id;
        } else {
            if (pp2limit)
                pp2limit += ",";
@@ -449,15 +487,15 @@ function triggerSearch ()
        }
     }
 
-    debug("triggerSearch: filters = " + JSON.stringify(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit);
-    my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, pp2filter, undefined, { limit: pp2limit });
+    debug("triggerSearch(" + mkws.query + "): filters = " + $.toJSON(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit);
+    my_paz.search(mkws.query, recPerPage, mkws.sort, pp2filter, undefined, { limit: pp2limit });
 }
 
 function loadSelect ()
 {
     if (document.mkwsSelect) {
        if (document.mkwsSelect.mkwsSort)
-           curSort = document.mkwsSelect.mkwsSort.value;
+           mkws.sort = document.mkwsSelect.mkwsSort.value;
        if (document.mkwsSelect.mkwsPerpage)
            recPerPage = document.mkwsSelect.mkwsPerpage.value;
     }
@@ -489,16 +527,16 @@ mkws.limitTarget  = function (id, name)
 
 mkws.delimitQuery = function (field, value)
 {
-    debug("delimitQuery(field=" + field + ", value=" + value + ")");    
+    debug("delimitQuery(field=" + field + ", value=" + value + ")");
     var newFilters = [];
     for (var i in mkws.filters) {
        var filter = mkws.filters[i];
        if (filter.field &&
            field == filter.field &&
            value == filter.value) {
-           debug("delimitTarget() removing filter " + JSON.stringify(filter));
+           debug("delimitTarget() removing filter " + $.toJSON(filter));
        } else {
-           debug("delimitTarget() keeping filter " + JSON.stringify(filter));
+           debug("delimitTarget() keeping filter " + $.toJSON(filter));
            newFilters.push(filter);
        }
     }
@@ -514,14 +552,14 @@ mkws.delimitQuery = function (field, value)
 
 mkws.delimitTarget = function (id)
 {
-    debug("delimitTarget(id=" + id + ")");    
+    debug("delimitTarget(id=" + id + ")");
     var newFilters = [];
     for (var i in mkws.filters) {
        var filter = mkws.filters[i];
        if (filter.id) {
-           debug("delimitTarget() removing filter " + JSON.stringify(filter));
+           debug("delimitTarget() removing filter " + $.toJSON(filter));
        } else {
-           debug("delimitTarget() keeping filter " + JSON.stringify(filter));
+           debug("delimitTarget() keeping filter " + $.toJSON(filter));
            newFilters.push(filter);
        }
     }
@@ -555,7 +593,7 @@ function redraw_navi ()
                ');return false;">' + filter.value + '</a>';
        }
     }
-    
+
     navi.innerHTML = text;
 }
 
@@ -782,6 +820,18 @@ function defaultTemplate(name)
        </tr>\
       </table>\
 ';
+    } else if (name === "Summary") {
+       return '\
+      <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
+       <b>{{md-title}}</b>\
+      </a>\
+      {{#if md-title-remainder}}\
+        <span>{{md-title-remainder}}</span>\
+      {{/if}}\
+      {{#if md-title-responsibility}}\
+       <span><i>{{md-title-responsibility}}</i></span>\
+      {{/if}}\
+';
     }
 
     var s = "There is no default '" + name +"' template!";
@@ -855,9 +905,14 @@ function mkws_html_all() {
 
     mkws_html_switch();
 
-    if (mkws_config.use_service_proxy)
-         mkws_service_proxy_auth(mkws_config.service_proxy_auth, 
-          mkws_config.service_proxy_auth_domain);
+    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
@@ -880,6 +935,24 @@ function mkws_html_all() {
     }
 }
 
+
+function run_auto_searches() {
+    debug("run auto searches");
+
+    var node = $('#mkwsRecords');
+    if (node.attr('autosearch')) {
+       var query = node.attr('autosearch');
+       var sort = node.attr('sort');
+       var targets = node.attr('targets');
+       var s = "running auto search: '" + query + "'";
+       if (sort) s += " sorted by '" + sort + "'";
+       if (targets) s += " in targets '" + targets + "'";
+       debug(s);
+       newSearch(query, sort, targets);
+    }
+}
+
+
 function mkws_set_lang()  {
     var lang = $.parseQuerystring().lang || mkws_config.lang;
     if (!lang || !mkws.locale_lang[lang]) {
@@ -908,7 +981,7 @@ function mkws_html_switch() {
 }
 
 function mkws_html_sort() {
-    debug("HTML sort");
+    debug("HTML sort, mkws.sort = '" + mkws.sort + "'");
     var sort_html = '<select name="mkwsSort" id="mkwsSort">';
 
     for(var i = 0; i < mkws_config.sort_options.length; i++) {
@@ -917,7 +990,7 @@ function mkws_html_sort() {
        var val = opt.length == 1 ? opt[0] : opt[1];
 
        sort_html += '<option value="' + key + '"';
-       if (key == mkws_config.sort_default) {
+       if (mkws.sort == key || mkws.sort == val) {
            sort_html += ' selected="selected"';
        }
        sort_html += '>' + M(val) + '</option>';
@@ -950,9 +1023,14 @@ function mkws_html_perpage() {
  * The username/password is configured in the apache config file
  * for the site.
  */
-function mkws_service_proxy_auth(auth_url, auth_domain) {
+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(/^http:\/\/(.*?)\/.*/, '$1');
+       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;
@@ -970,7 +1048,8 @@ function mkws_service_proxy_auth(auth_url, auth_domain) {
        }
 
        debug("Service proxy auth successfully done");
-       mkws.service_proxy_auth = true;
+       mkws.authenticated = true;
+       run_auto_searches();
     });
 }
 
@@ -1053,10 +1132,72 @@ function M(word) {
     return mkws.locale_lang[lang][word] || word;
 }
 
+// main
+(function() {
+    try {
+       mkws_html_all()
+    }
+
+    catch (e) {
+       mkws_config.error = e.message;
+       // alert(e.message);
+    }
+})();
+
+    // done
+    mkws.init = true;
+};
+
+
 /*
- * implement jQuery plugins
+ * implement jQuery plugin $.pazpar2({})
  */
-$.extend({
+function _mkws_jquery_plugin ($) {
+    function debug (string) { // delayed debug, internal variables are set after dom ready
+       setTimeout(function() { mkws.debug(string); }, 500);
+    }
+
+    function init_popup(obj) {
+       var config = obj ? obj : {};
+
+       var height = config.height || 760;
+       var width = config.width || 880;
+       var id_button = config.id_button || "input#mkwsButton";
+       var id_popup = config.id_popup || "#mkwsPopup";
+
+       debug("popup height: " + height + ", width: " + width);
+
+       // make sure that jquery-ui was loaded afte jQuery core lib, e.g.:
+       // <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
+       if (!$.ui) {
+           debug("Error: jquery-ui.js is missing, did you included it after jquery core in the HTML file?");
+           return;
+       }
+
+       $(id_popup).dialog({
+         closeOnEscape: true,
+         autoOpen: false,
+         height: height,
+         width: width,
+         modal: true,
+         resizable: true,
+         buttons: {
+                 Cancel: function() {
+                         $(this).dialog("close");
+                 }
+         },
+         close: function() { }
+       });
+
+       $(id_button)
+         .button()
+         .click(function() {
+                 $(id_popup).dialog("open");
+         });
+    };
+
+    $.extend({
+
     // implement $.parseQuerystring() for parsing URL parameters
     parseQuerystring: function() {
        var nvpair = {};
@@ -1069,9 +1210,6 @@ $.extend({
        return nvpair;
     },
 
-    debug2: function(string) { // delayed debug, internal variables are set after dom ready
-       setTimeout(function() { debug(string); }, 500);
-    },
 
     // service-proxy or pazpar2
     pazpar2: function(config) {
@@ -1143,71 +1281,27 @@ $.extend({
          </div>'
 
        if (config && config.layout == 'div') {
-           this.debug2("jquery plugin layout: div");
+           debug("jquery plugin layout: div");
            document.write(div);
        } else if (config && config.layout == 'popup') {
-           this.debug2("jquery plugin layout: popup with id: " + id_popup);
+           debug("jquery plugin layout: popup with id: " + id_popup);
            document.write(popup);
            $(document).ready( function() { init_popup(config); } );
        } else {
-           this.debug2("jquery plugin layout: table");
+           debug("jquery plugin layout: table");
            document.write(table);
        }
     }
 });
-
-function init_popup(obj) {
-    var config = obj ? obj : {};
-
-    var height = config.height || 760;
-    var width = config.width || 880;
-    var id_button = config.id_button || "input#mkwsButton";
-    var id_popup = config.id_popup || "#mkwsPopup";
-
-    debug("popup height: " + height + ", width: " + width);
-
-    // make sure that jquery-ui was loaded afte jQuery core lib, e.g.:
-    // <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
-    if (!$.ui) {
-       debug("Error: jquery-ui.js is missing, did you included it after jquery core in the HTML file?");
-       return;
-    }
-
-    $(id_popup).dialog({
-      closeOnEscape: true,
-      autoOpen: false,
-      height: height,
-      width: width,
-      modal: true,
-      resizable: true,
-      buttons: {
-             Cancel: function() {
-                     $(this).dialog("close");
-             }
-      },
-      close: function() { }
-    });
-
-    $(id_button)
-      .button()
-      .click(function() {
-             $(id_popup).dialog("open");
-      });
 };
 
+// wrapper to call _mkws after page load
+(function (j) {
+    // enable before page load, so we could call it before mkws() runs
+    _mkws_jquery_plugin(j);
 
-
-
-/* magic */
-$(document).ready(function() {
-    try {
-       mkws_html_all()
-    }
-
-    catch (e) {
-       mkws_config.error = e.message;
-       // alert(e.message);
-    }
-});
-
+    $(document).ready(function() {
+       // if (console && console.log) console.log("on load ready");
+       _mkws(j);
+    });
 })(jQuery);