X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=mkdru.client.js;h=fdb54e6a90fa4358f4a0487f9fe04a058d60b4a5;hb=2ac88bd98cd870652e1610dec04be01d2ebee745;hp=ebd713f75c430ea66343670b11e6270fcac581fb;hpb=4cdc8af49704ea30676f4a7588457bbd4e83f411;p=mkdru-moved-to-drupal.org.git diff --git a/mkdru.client.js b/mkdru.client.js index ebd713f..fdb54e6 100644 --- a/mkdru.client.js +++ b/mkdru.client.js @@ -1,55 +1,106 @@ // Set up namespace and some state. var mkdru = { // Settings to pass to pz2.js - usesessions: Drupal.settings.mkdru.use_sessions === '1', - // showResponseType: 'json', + useSessions: Drupal.settings.mkdru.use_sessions === '1', // Variables - submitted: false, + active: false, pz2: null, totalRec: 0, pagerRange: 6, - sourceMax: Drupal.settings.mkdru.source_max, - subjectMax: Drupal.settings.mkdru.subject_max, - authorMax: Drupal.settings.mkdru.author_max, pazpar2Path: Drupal.settings.mkdru.pz2_path, + facetContainerSelector: Drupal.settings.mkdru.facetContainerSelector, + // Facets + facets: { + source: { + displayName: Drupal.settings.mkdru.source_dname || "Source", + orderWeight: Drupal.settings.mkdru.source_weight || 1, + pz2Name: 'xtargets', + max: Drupal.settings.mkdru.source_max || 10 + }, + subject: { + displayName: Drupal.settings.mkdru.subject_dname || "Subject", + orderWeight: Drupal.settings.mkdru.source_weight || 2, + pz2Name: 'subject', + max: Drupal.settings.mkdru.subject_max || 10, + multiLimit: true, + limiter: 'su' + }, + author: { + displayName: Drupal.settings.mkdru.author_dname || "Author", + orderWeight: Drupal.settings.mkdru.source_weight || 3, + pz2Name: 'author', + max: Drupal.settings.mkdru.author_max || 10, + multiLimit: false, + limiter: 'au' + } + }, // State defaultState: { page: 1, perpage: 20, sort: 'relevance', filter: null, - query:null, + query:'', recid:null }, - state: {} + state: {}, + realm: '' }; +// Wrapper for jQuery +(function ($) { + // So we can use jQuery BBQ with Drupal 6 and its 1.2.6 jQuery if (!$.isArray) $.isArray = function(obj) { return Object.prototype.toString.call(obj) === "[object Array]"; -}, +}; + +// BBQ has no handy way to remove params without changing the hash. +// This takes an object to add and an array of keys to delete. +mkdru.hashAddDelMany = function (add, del) { + var newHash = $.deparam.fragment(); + if (typeof(add) === 'object') + $.extend(newHash, add); + if ($.isArray(del)) + for (var i=0; i < del.length; i++) + if (newHash[del[i]] !== 'undefined') + delete newHash[del[i]]; + return $.param.fragment("#", newHash); +} + +// It's sometimes cumbersome that object literals can't take variable keys. +mkdru.hashAddDelOne = function (key, value, del) { + var toAdd; + var toDel; + if (key && value) { + var toAdd = {}; + toAdd[key] = value; + } + if (del) { + var toDel = []; + toDel.push(del); + } + return mkdru.hashAddDelMany(toAdd, toDel); +} // pz2.js event handlers: mkdru.pz2Init = function () { if (mkdru.state.query) { - mkdru.triggerSearch(); + mkdru.search(); } - //mkdru.pz2.stat(); + mkdru.pz2.stat(); //mkdru.pz2.bytarget(); }; mkdru.pz2Show = function (data) { mkdru.totalRec = data.merged; $('.mkdru-pager').html(mkdru.generatePager()); - var countsHtml = Drupal.t('Displaying: ') + (data.start + 1) + - Drupal.t(' to ') + (data.start + data.num) + Drupal.t(' of ') - + data.merged + Drupal.t(' (found: ') + data.total + ')'; - $('.mkdru-counts').html(countsHtml); - + $('.mkdru-counts').html(Drupal.theme('mkdruCounts', data.start + 1, + data.num, data.merged, data.total)); var html = ""; for (var i = 0; i < data.hits.length; i++) { html += Drupal.theme('mkdruResult', data.hits[i], @@ -68,44 +119,27 @@ mkdru.pz2Show = function (data) { }; mkdru.pz2Status = function (data) { + $('.mkdru-status').html(Drupal.theme('mkdruStatus', data.activeclients, data.clients)); }; mkdru.pz2Term = function (data) { - var html = ""; - for (var i = 0; i < data.xtargets.length && i < mkdru.sourceMax; i++ ) { - html += Drupal.theme('mkdruTerm', data.xtargets[i].name, data.xtargets[i].freq, - 'mkdru-facet-source', data.xtargets[i].id); - } - $('.mkdru-facet-sources').html(html); - - html = ""; - for (var i = 0; i < data.subject.length && i < mkdru.subjectMax; i++ ) { - html += Drupal.theme('mkdruTerm', data.subject[i].name, data.subject[i].freq, - 'mkdru-facet-subject', data.subject[i].id); + // if signaled, prepare container client-side + if (mkdru.facetContainerSelector) { + $(mkdru.facetContainerSelector).html(Drupal.theme('mkdruFacetContainer', + data, mkdru.facets)); } - $('.mkdru-facet-subjects').html(html); - - html = ""; - for (var i = 0; i < data.author.length && i < mkdru.authorMax; i++ ) { - html += Drupal.theme('mkdruTerm', data.author[i].name, data.author[i].freq, - 'mkdru-facet-author', data.author[i].id); + for (var facet in mkdru.facets) { + // facet is limited + if (mkdru.state['limit_' + facet]) { + $('.mkdru-facet-' + facet).html(Drupal.theme('mkdruFacetLimit', + data[mkdru.facets[facet].pz2Name][0], + mkdru.hashAddDelOne(null, null, 'limit_' + facet))); + } else { + $('.mkdru-facet-' + facet).html(Drupal.theme('mkdruFacet', + data[mkdru.facets[facet].pz2Name], + facet, mkdru.facets[facet].max)); + } } - $('.mkdru-facet-authors').html(html); - - $('.mkdru-facet-source').bind('click', function (e) { - mkdru.limitTarget(this.getAttribute('target_id'), this.firstChild.nodeValue); - return false; - }); - - $('.mkdru-facet-subject').bind('click', function (e) { - mkdru.limitQuery('su', this.firstChild.nodeValue); - return false; - }); - - $('.mkdru-facet-author').bind('click', function (e) { - mkdru.limitQuery('au', this.firstChild.nodeValue); - return false; - }); }; mkdru.pz2ByTarget = function (data) { @@ -115,8 +149,8 @@ mkdru.pz2ByTarget = function (data) { mkdru.pz2Record = function (data) { clearTimeout(mkdru.pz2.showTimer); $('.mkdru-results').hide(); - $('.mkdru-detail').html(Drupal.theme('mkdruDetail', data)); - $('.mkdru-detail-back').bind('click', function () {$.bbq.removeState('recid');}); + $('.mkdru-detail').html(Drupal.theme('mkdruDetail', data, + mkdru.hashAddDelOne(null, null, 'recid'))); $('.mkdru-detail').show(); clearTimeout(mkdru.pz2.recordTimer); }; @@ -127,14 +161,10 @@ mkdru.pz2Record = function (data) { // populate state from an object and fill in the blanks with defaults mkdru.stateFromObject = function (obj) { - for (var key in mkdru.defaultState) { - if (typeof(obj[key]) != "undefined") { + mkdru.state = $.extend({}, mkdru.defaultState); + for (var key in mkdru.defaultState) + if (typeof(obj[key]) != "undefined") mkdru.state[key] = obj[key]; - } - else { - mkdru.state[key] = mkdru.defaultState[key]; - } - } }; // populate state from current window's hash string @@ -151,7 +181,7 @@ mkdru.hashFromState = function () { alteredState[key] = mkdru.state[key]; } } - $.bbq.pushState(alteredState); + $.bbq.pushState(alteredState, 2); }; // update mkdru_form theme's ui to match state @@ -179,67 +209,112 @@ mkdru.hashChange = function () { } // Other internal link else { + // may need to run search again to limit targets + for (key in mkdru.state) { + if (key.substring(0,5) === 'limit' && mkdru.state[key]) { + mkdru.search(); + break; + } + } mkdru.pz2.showPage(mkdru.state.page-1); $('.mkdru-detail').hide(); $('.mkdru-results').show(); } }; +// return link to limit facet +mkdru.addLimit = function (facet, limit) { + var newHash = $.deparam.fragment(); + delete newHash['page']; + if ((typeof(newHash['limit_' + facet]) === 'undefined') + || !mkdru.facets[facet].multiLimit) { + newHash['limit_' + facet] = limit; + } + else { + newHash['limit_' + facet] += ';' + limit; + } + return $.param.fragment("#", newHash); +}; +// return link to remove limit from facet +mkdru.removeLimit = function (facet, limit) { + var newHash = $.deparam.fragment(); + delete newHash['page']; + if (!newHash['limit_' + facet].indexOf(';') || !mkdru.facets[facet].multiLimit) { + delete newHash['limit_' + facet]; + } + else { + var limits = newHash['limit_' + facet].split(';'); + for (var i = 0; i < limits.length; i++) { + if (limits[i] == limit) { + limits.splice(i, 1); + newHash['limit_' + facet] = limits.join(';'); + break; + } + } + } + return $.param.fragment("#", newHash); +}; -// UI functions: + + +// form submit handler mkdru.submitQuery = function () { + // new query, back to defaults (shallow copy) + mkdru.state = $.extend({}, mkdru.defaultState); mkdru.state.query = $('.mkdru-search input:text').attr('value'); - mkdru.resetPage(); mkdru.pollDropDowns(); mkdru.hashFromState(); mkdru.search(); - mkdru.submitted = true; + mkdru.active = true; return false; }; -mkdru.triggerSearch = function () { - mkdru.search(); - mkdru.submitted = true; -}; +// criteria drop-down (perpage, sort) handler +mkdru.submitCriteria = function () { + mkdru.pollDropDowns(); + //search is not ON, do nothing + if (!mkdru.active) return false; + // pages mean different things now + mkdru.state.page = 1; + mkdru.hashFromState(); + mkdru.pz2.show(0, mkdru.state.perpage, mkdru.state.sort); + return false; +} mkdru.search = function () { - mkdru.pz2.search(mkdru.state.query, mkdru.state.perpage, mkdru.state.sort, - mkdru.state.filter); + var filter = null; + var query = mkdru.state.query; + + // facet limit implementation + for (var facet in mkdru.facets) { + // facet is limited + if (mkdru.state['limit_' + facet]) { + if (facet == "source") { + filter = 'pz:id=' + mkdru.state.limit_source; + } + else { + var limits = mkdru.state['limit_' + facet].split(';'); + for (var i = 0; i < limits.length; i++) { + // ex. query + and au="{limit_author}" + query += ' and ' + mkdru.facets[facet]['limiter'] + '="' + + mkdru.state['limit_' + facet] + '"'; + } + } + } + } + + mkdru.pz2.search(query, mkdru.state.perpage, mkdru.state.sort, filter); + mkdru.active = true; }; mkdru.pollDropDowns = function () { mkdru.state.perpage = $('.mkdru-perpage').attr('value'); mkdru.state.sort = $('.mkdru-sort').attr('value'); - if (!mkdru.submitted) return false; - mkdru.resetPage(); - mkdru.hashFromState(); - mkdru.pz2.show(0, mkdru.state.perpage, mkdru.state.sort); - return false; -}; - -mkdru.limitQuery = function (field, value) { - $('.mkdru-search input:text').attr('value', function () { - return this.value += ' and ' + field + '="' + value + '"'; - }); - mkdru.submitQuery(); -}; - -mkdru.limitTarget = function (id, name) { - var navi = document.getElementById('mkdru-navi'); - navi.innerHTML = - 'Source: ' - + name + ''; - navi.innerHTML += '
'; - mkdru.state.filter = 'pz:id=' + id; - mkdru.resetPage(); - mkdru.pollDropDowns(); - mkdru.search(); - return false; }; mkdru.generatePager = function () { - // make sure page param is a number, otherwise pageing frwd will be broken + // cast page parameter to numeric so we can add to it if (typeof mkdru.state.page == "string") { mkdru.state.page = Number(mkdru.state.page); } @@ -247,7 +322,7 @@ mkdru.generatePager = function () { var first = (mkdru.state.page - mkdru.pagerRange > 0) ? mkdru.state.page - mkdru.pagerRange : 1; var last = first + 2 * mkdru.pagerRange < total - ? first + 2 * mkdru.pagerRange : total; + ? first + 2 * mkdru.pagerRange : total; var prev = null; var next = null; var pages = []; @@ -270,11 +345,6 @@ mkdru.generatePager = function () { total, prev, next); }; -mkdru.resetPage = function () { - mkdru.state.page = 1; - mkdru.totalRec = 0; -}; - // wait until the DOM is ready, bind events @@ -283,18 +353,25 @@ $(document).ready(function () { $(window).bind( 'hashchange', mkdru.hashChange); $('.mkdru-search').bind('submit', mkdru.submitQuery); $('.mkdru-search input:text').attr('value', ''); - $('.mkdru-perpage').bind('change', function () { mkdru.pollDropDowns() }); - $('.mkdru-sort').bind('change', function () { mkdru.pollDropDowns() }); + $('.mkdru-perpage').bind('change', mkdru.submitCriteria); + $('.mkdru-sort').bind('change', mkdru.submitCriteria); + + // generate termlist for pz2.js and populate facet limit state + var termlist = []; + for (var key in mkdru.facets) { + termlist.push(mkdru.facets[key].pz2Name); + mkdru.defaultState['limit_' + key] = null; + } mkdru.pz2 = new pz2( { "onshow": mkdru.pz2Show, "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way - "pazpar2path": mkdru.pazpar2path, + "pazpar2path": mkdru.pazpar2Path, "oninit": mkdru.pz2Init, "onstat": mkdru.pz2Status, "onterm": mkdru.pz2Term, - "termlist": "xtargets,subject,author", + "termlist": termlist.join(','), "onbytarget": mkdru.pz2ByTarget, - "usesessions" : mkdru.usesessions, + "usesessions" : mkdru.useSessions, "showResponseType": mkdru.showResponseType, "onrecord": mkdru.pz2Record, "autoInit": false } ); @@ -309,13 +386,39 @@ $(document).ready(function () { mkdru.state.query = Drupal.settings.mkdru.query } - if (mkdru.usesessions) { + //not running against SP? init, otherwise authenticate + if (mkdru.useSessions) { mkdru.pz2.init(); - } - else if (mkdru.state.recid) { - mkdru.pz2.record(mkdru.state.recid); - } - else if (mkdru.state.query) { - mkdru.triggerSearch(); + } else { + //runnin against SP + var user = Drupal.settings.mkdru.sp_user; + var pass = Drupal.settings.mkdru.sp_pass; + var params = {}; + params['command'] = 'auth'; + if (user && pass) { + params['action'] = 'login'; + params['username'] = user; + params['password'] = pass; + } else { + params['action'] = 'ipauth'; + } + var authReq = new pzHttpRequest(mkdru.pazpar2Path, + function (err) { + alert("Authentication against metasearch gateway failed: " +err); + } + ); + authReq.get(params, + function (data) { + var s = data.getElementsByTagName('status'); + if (s.length && Element_getTextContent(s[0]) == "OK") { + mkdru.realm = data.getElementsByTagName('realm'); + mkdru.pz2Init(); + } else { + alert("Malformed response when authenticating against the metasearch" + + " gateway"); + } + } + ); } }); +})(jQuery);