webglade

XMDManager.js (17369B)

---

 /**
  * XMD (XML Mab Document Manager)
  *
  * @filename XMDManager.js
  * $LastChangedDate: 2004-12-06 13:08:50 +0100 (Mon, 06 Dec 2004) $
  * @author Fabio Serra <faser@faser.net>
  * @copyright Fabio Serra (The Initial Developer of the Original Code)
  * @license Mozilla Public License Version 1.1
  *
 */
 
 /**
  * Construct a new XMD Manager object
  * @class This class is used to manage the XML resulting from the transformation of Amazon XML
  * response. The XML Mab Document is the data model.
  * @constructor
  * @return A new XMD Manager
  *
 */
 function XMDManager() {
 	/**
 	 * This flag is valid for the current session. It means that when a details (record)
      * has been deleted from the loaded document, it can't be inserted again. In this way I
      * prevent unuseful duplicated records
 	 * @type bool
 	*/
 	this.preventDuplicateDetails = true;
 
 	/**
 	 * Save all primary keys that are going to be processed
      * @type object array
 	*/
 	this.primaryKeys = new Array();
 
 	/**
 	 * Save a reference in array of each details node present in the XML document
      * @type DOM nodes array
 	*/
 	this.hashTable = new Array();
 
 	/**
 	 * This property is used to remember if this document was saved (file or memory is the same)
      * @type bool
 	*/
 	this.wasSaved = false;
 
 	/**
 	 * The name of the current document.
      * @type string
 	*/
 	this.name = "";
 
 	/**
 	 * The full path including the file name and extension if the document has
      * been saved on file system
      * @type string
 	*/
 	this.fullPath = "";
 
 	/**
 	 * The Mab Xml Document
      * @type XML Doc
 	*/
 	this.xmlDoc = this.make();
 }
 
 
 /**
  * Create an empty XML Document to use as a Mab model data
  * @return A new XML Dcoument
  * @type XMLDocument
 */
 XMDManager.prototype.make = function() {
 	var today = new Date();
 	var tsDocumentCreated = Date.parse(today);
 
 	var xmlStr = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n'+
 	'<MABInfo xmlns="http://www.faser.net/mab/NS/MABInfo">\n' +
 	'<MABTSDocumentCreated>' + tsDocumentCreated + '</MABTSDocumentCreated>\n' +
 	'<MABDetails/>\n' +
 	'</MABInfo>';
 
 	var xmlDoc = new DOMParser().parseFromString(xmlStr, 'text/xml');
 
 	return xmlDoc;
 }
 
 /**
  * Build the hashtable for the current document. When a document is merged the
  * hashtable is created by default. This method should be used when an XMD document
  * is loaded from file
  * @return void
  */
 XMDManager.prototype.buildHashTable = function() {
 	//remove all previous key
 	this.hashTable = null;
 	this.hashTable = new Array();
 	//build
 	var details = this.xmlDoc.getElementsByTagName('Details');
 	var pk = "";
 	for(var i=0;i<details.length;i++) {
 		pk = this.getSingleElement(details.item(i),"MABPrimaryKey");
 		if(pk) {this.hashTable[pk] = details.item(i);}
 	}
 }
 
 /**
  * Merge the Details node of the new xml document with the current one.
  * The last xml nodes are inserted at the top of the document
  * @param {XMLDocument} docToMerge the new XML document
  * @param {bool} overwrite means that the new details overwrite the old ones
  * @return object with properties to show how many nodes was merged, duplicated
  * and reloaded
  * @type object
 */
 XMDManager.prototype.merge = function(docToMerge,overwrite) {
 	if(typeof overwrite == "undefined") {overwrite = true;}
 
 	//Check if the new document was created by MAB or come from an Amazon search
 	var bAmazonResult = true;
 	if(this.isValidMABDoc(docToMerge)) {bAmazonResult = false;}
 
 	var mabRootDetails = this.xmlDoc.getElementsByTagName("MABDetails").item(0);
 	var details = docToMerge.getElementsByTagName('Details');
 
 	var node, replacedNode, pk, lastUpdate, oldDetail, mabLabel;
 
 	var today = new Date();
 	var isNewNode = false;
 	var oldNode = false;
 
 	var result = {};
 		result.nrMergedNode = 0;
 		result.nrDuplicatedNode = 0;
 		result.nrReloadedNode = 0;
 
 
 	//LIFO - Insert new records before the old ones
 	var lifo = this.xmlDoc.getElementsByTagName("Details").item(0);
 
 	if(bAmazonResult) {
 		//Default locale if missing
 		var locale = "us";
 		var path = "//Request/Args/Arg[@name='locale']";
 		var xpathResult = docToMerge.evaluate(path,docToMerge,null,XPathResult.ANY_TYPE,null).iterateNext();
 		if(xpathResult != null) { locale = xpathResult.getAttribute("value");}
 		var amazAsin = "";
 	}
 
 	for (var i=0;i<details.length; i++) {
 		//node from the document that I have to process
 		node = details.item(i).cloneNode(true);
 		if(bAmazonResult) {
 			amazAsin = this.getSingleElement(node,"Asin");
 			pk = amazAsin + '_' + locale;
 			//Add mandatory tags for details that come from Amazon
 			this.addMABTag(node,pk);
 		}else{
 			pk = this.getSingleElement(node,"MABPrimaryKey")
 		}
 
 
 		//Check the details date according to the Amazon Licence Agreement (November 5, 2003)
 		//http://forums.prospero.com/n/mb/message.asp?webtag=am-assosdev&msg=91.1&ctx=0
 
 		//Price Information must be refreshed every 24 hours, the other details every 3 months
 		//So, if these info are expired remove them from the XML
 		//The user have to be update the info
 
 		lastUpdate = this.getLastUpdate(node);
 		if(lastUpdate > EXPIRED_LONG) {
 			this.removeExpiredInfo(node);
 		}else if(lastUpdate > EXPIRED_SHORT) {
 			this.removeExpiredPrice(node);
 		}
 
 		//prevent duplicate records
 		isNewNode = this.setPK(pk);
 		oldNode = this.getNodeDetail(pk);
 
 		//The record is new
 		if(isNewNode || (!this.preventDuplicateDetails && !oldNode)) {
 			if(lifo) {
 				lifo.parentNode.insertBefore(node,lifo);
 			}else{
 				mabRootDetails.appendChild(node);
 			}
 
 			this.hashTable[pk] = node;
 			result.nrMergedNode++;
 
 		//The records is currently present in xml doc and I can overwrite it
 		//but avoid to replace MABLabel
 		}else if(overwrite && oldNode) {
 
 			mabLabel = this.getSingleElement(oldNode,"MABLabel");
 
 			//mabRootDetails.replaceChild(node,oldNode.parentNode);
 			mabRootDetails.removeChild(oldNode);
 			replacedNode = mabRootDetails.appendChild(node);
 			this.hashTable[pk] = replacedNode;
 
 			//No comments? Create a new fake one to prevent comment request
 			var comment = this.getSingleElement(replacedNode);
 			if(!comment) {
 				var comElem = this.xmlDoc.createElement("Reviews");
 				replacedNode.appendChild(comElem);
 			}
 
 			//Reset the old Mab Label
 			//replacedNode.getElementsByTagName("MABLabel").item(0).firstChild.nodeValue = mabLabel;
 			result.nrReloadedNode++;
 		//Skip node
 		}else{
 			result.nrDuplicatedNode ++;
 		}
 	}
 	return result;
 }
 
 /**
  * Add mandatory MAB tags to a new detail node coming from an Amazon search
  * @param {xml node} node The node to which append the new MAB tags
  * @param {string} pk The mab items primary key
  * @return void
 */
 XMDManager.prototype.addMABTag = function(node,pk) {
 	//Timestamp
 	var today = new Date();
 	var	ts = Date.parse(today);
 
 	//MAB Status (read | unread)
 	var MABStatus = "unread";
 
 	//Locale
 	var locale = pk.substr((pk.length-2),pk.length);
 
 	var strMabTag = "<MABPrimaryKey>" + pk + "</MABPrimaryKey>\n" +
 	"<MABTSLastUpdate>" + ts + "</MABTSLastUpdate>\n" +
 	"<MABLabel/>\n" +
 	"<MABLocale>" + locale + "</MABLocale>\n" +
 	"<MABStatus>" + MABStatus + "</MABStatus>\n";
 
 	//Append new tag to the passed node
 	innerXML(node,strMabTag);
 }
 
 /**
  * Get all products older than an elapsed time determined by Amazon license
  * @param {int} dayBefore Maximum days that should be passed from the last product update
  * @return object array contains the asinList grouped by locale
  * @type array associative
 */
 XMDManager.prototype.getAllExpiredProducts = function(dayBefore) {
 	if(typeof dayBefore == "undefined") {dayBefore = EXPIRED_SHORT;}
 	var node, lastUpdate, locale, amazAsin;
 	var asinList = {};
 	for(var d in this.hashTable) {
 		node = this.hashTable[d];
 		lastUpdate = this.getLastUpdate(node);
 		if(lastUpdate > dayBefore) {
 			locale =  this.getSingleElement(node,"MABLocale");
 			amazAsin = this.getSingleElement(node,"Asin");
 			if(!locale || !amazAsin) {continue;}
 
 			if(typeof asinList[locale] == "undefined") {
 				asinList[locale] = new Array();
 			}
 
 			asinList[locale].push(amazAsin);
 		}
 	}
 
 	return asinList;
 }
 
 /**
  * Count how many days are passed from the node last update
  * @param {xml node} nodeDetail
  * @return the elapsed days
  * @type int
 */
 XMDManager.prototype.getLastUpdate = function(nodeDetail) {
 	var today = new Date();
 	var dayElapsed = 0;
 	var lastUpdate = this.getSingleElement(nodeDetail,"MABTSLastUpdate");
 	if(lastUpdate) {
 		dayElapsed = Math.round((Date.parse(today) - parseInt(lastUpdate)) / 86400000);
 	}
 
 	return dayElapsed;
 }
 
 /**
  * Remove all tags from a node except the most relevant
  * @param {xml node} nodeDetail an XML node
  * @return void
 */
 XMDManager.prototype.removeExpiredInfo = function(nodeDetail) {
 	var tagExcluded = new Array("Asin","ProductName","Catalog","Authors","Artists","Directors","MABPrimaryKey","MABTSLastUpdate","MABLabel","MABLocale","MABStatus");
 	var clonedNode = new Array();
 	var i, cNode;
 	while(nodeDetail.hasChildNodes()) {
 		for(i=0; i<tagExcluded.length; i++) {
 			if(nodeDetail.lastChild.nodeName == tagExcluded[i]) {
 				cNode = nodeDetail.lastChild.cloneNode(true);
 				clonedNode.push(cNode);
 			}
 		}
 
 		nodeDetail.removeChild(nodeDetail.lastChild);
 	}
 
 	//Write back the excluded tag
 	for(i=0; i<clonedNode.length; i++) {
 		nodeDetail.appendChild(clonedNode[i]);
 	}
 
 	this.wasSaved = false;
 }
 
 /**
  * Remove expired main prices tag
  * @param {node xml} nodeDetail
  * @return void
 */
 XMDManager.prototype.removeExpiredPrice = function(nodeDetail) {
 	var tags = new Array("ListPrice","OurPrice","UsedPrice");
 	var el;
 	for(var i=0; i < tags.length; i++) {
 		el = nodeDetail.getElementsByTagName(tags[i]).item(0);
 		if(el) {nodeDetail.removeChild(el);}
 	}
 
 	this.wasSaved = false;
 }
 
 /**
  * Set the primary key to prevent duplicate
  * @param {string} pk A Mab primary key
  * @return true if a primary key has been added, false if the primary key already exist
  * @type bool
 */
 XMDManager.prototype.setPK = function(pk) {
 	var res = this.checkPK(pk);
 	if(!res) {
 		this.primaryKeys.push(pk);
 		return true;
 	}else{
 		return false;
 	}
 }
 
 /**
  * Check if the primary key has been saved
  * @param {string} pk
  * @return bool
  * @type bool
 */
 XMDManager.prototype.checkPK = function(pk) {
 	for(var i=0;i<this.primaryKeys.length;i++){
 		if(this.primaryKeys[i] == pk) {
 			return true;
 		}
 	}
 	return false;
 }
 
 /**
  * Check if the loaded file is a valid MAB file looking for MABInfo tag
  * @param {XMLDocument} xmlDoc
  * @return bool
  * @type bool
 */
 XMDManager.prototype.isValidMABDoc = function(xmlDoc) {
 	var root = xmlDoc.documentElement.nodeName;
 	var XMDRoot = "MABInfo";
 	if(root == XMDRoot) {
 		return true;
 	}else{
 		return false;
 	}
 }
 
 /**
  *Get a Details node looking for the primary key using the hashtable
  *@param {string} primaryKey The node primary key
  *@return nodeDetail
  *@type XML Node
 */
 XMDManager.prototype.getNodeDetail = function(primaryKey) {
 	if(typeof this.hashTable[primaryKey] == "undefined"){return false;}
 	var nodeDetail = this.hashTable[primaryKey];
 	if(nodeDetail) {
 		return nodeDetail;
 	}else{
 		return false;
 	}
 }
 
 /**
  * Remove a node detail from the XMD Document
  * @param {string} primaryKey The primary key of the node to remove
  * @return bool
  * @type bool
 */
 XMDManager.prototype.removeDetail = function(primaryKey) {
 	var nodeDetail = this.getNodeDetail(primaryKey);
 	if(nodeDetail) {
 		nodeDetail.parentNode.removeChild(nodeDetail);
 		delete this.hashTable[primaryKey];
 		this.wasSaved = false;
 		return true;
 	}else{
 		return false;
 	}
 }
 
 /**
  * Get text from the first node element
  * @param {node xml} nodeDetail
  * @param {string} tagName
  * @return The text contained inside the element
  * @type string
 */
 XMDManager.prototype.getSingleElement = function(nodeDetail,tagName) {
 	if(!nodeDetail) {return false;}
 	var el = nodeDetail.getElementsByTagName(tagName).item(0);
 	if(el && el.hasChildNodes()) {
 		return el.firstChild.nodeValue;
 	}else{
 		return false;
 	}
 }
 
 /**
  * Return an array with the text got from all elements
  * @param {node xml} nodeDetail
  * @param {string} tagName
  * @return array
  * @type array
 */
 XMDManager.prototype.getArrayElement = function(nodeDetail,tagName) {
 	var elArray = new Array();
 	if(!nodeDetail) {return elArray;}
 	var el = nodeDetail.getElementsByTagName(tagName).item(0);
 	if(el) {
 		var node = nodeDetail.getElementsByTagName(tagName);
 		var content;
 		for(var i=0;i<node.length;i++) {
 			content = node.item(i).firstChild.nodeValue;
 			if(content) {elArray[i] = content;}
 		}
 	}
 	return elArray;
 }
 
 /**
  * Check if an element exists inside the xml node
  * @param {node xml} nodeDetail
  * @param {string} tagName
  * @return true if tag exists
  * @type bool
 */
 XMDManager.prototype.tagExists = function(nodeDetail,tagName) {
 	if(!nodeDetail) {return false;}
 	var el = nodeDetail.getElementsByTagName(tagName).item(0);
 	if(el) {
 		return true;
 	}else{
 		return false;
 	}
 }
 
 /**
  * Set a new value text inside the provided tag only for the first child element.
  * If newValue is "none" the child element is removed. If the child element doesn't
  * exists a text node will be created.
  * @param {node xml} node
  * @param {string} tagName
  * @param {string} newValue
  * @return True if something has been modified
  * @type bool
 */
 XMDManager.prototype.setNodeValue = function(node,tagName,newValue) {
 	var el = node.getElementsByTagName(tagName).item(0);
 	if(el) {
 		if(newValue == "none") {
 			if(el.hasChildNodes()) {el.removeChild(el.firstChild);}
 		} else if(el.hasChildNodes()) {
 			el.firstChild.nodeValue = newValue;
 		}else{
 			var text = document.createTextNode(newValue);
 			el.appendChild(text);
 		}
 		return true;
 	}else{
 		return false;
 	}
 }
 
 /**
  * Remove all Details node from the document
  * @return void
 */
 XMDManager.prototype.removeAllDetails = function() {
 	var root = this.xmlDoc.getElementsByTagName("MABDetails").item(0);
 	while(root.hasChildNodes()) {
 		root.removeChild(root.lastChild);
 	}
 }
 
 /**
  * Sort the xml document
  * Unfortunately this sort method is too slow, pratically unusable when there are
  * more than 150 node. TODO (try using XSLT)
  * @param {string} sortType The kind of value to sort (numeric | date | string)
  * @param {string} sortTag The xml tag to use for sorting the node
  * @param {bool} bAscending Ascending or descending sorting
  * @return void
 */
 XMDManager.prototype.sort = function(sortType,sortTag,bAscending) {
 
 	var theBody = this.xmlDoc.getElementsByTagName("MABDetails").item(0);
 
 	var numRows = 0;
 	var theSortedRows = new Array();
 	for (var i in this.hashTable) {
 		theSortedRows[numRows] = this.hashTable[i].cloneNode(true);
 		numRows++;
 	}
 
 	theSortedRows.sort(this.sortCallBack(sortType,sortTag,bAscending));
 
 	//Clear current xml document
 	this.removeAllDetails();
 
 	//recreate
 	for(i=0;i<numRows;i++) {
 		theBody.appendChild(theSortedRows[i])
 	}
 	//rebuild the hashtable
 	this.buildHashTable();
 }
 
 /**
  * Calculate how should be sorted the xml node. Actually the xml document is not re-ordered
  * @param {string} sortType The kind of value to sort (numeric | date | string)
  * @param {string} sortTag The xml tag to use for sorting the node
  * @param {bool} bAscending Ascending or descending sorting
  * @return an array with virtually sorted xml node.
  * @type array
 */
 XMDManager.prototype.virtualSort = function(sortType,sortTag,bAscending) {
 	var numRows = 0;
 	var theSortedRows = new Array();
 	for (var i in this.hashTable) {
 		theSortedRows[numRows] = this.hashTable[i];
 		numRows++;
 	}
 
 	theSortedRows.sort(this.sortCallBack(sortType,sortTag,bAscending));
 
 	return theSortedRows;
 }
 
 /**
  * Callback method used in the sort javascript.
  * @private
  * @param {string} sortType The kind of value to sort (numeric | date | string)
  * @param {string} sortTag The xml tag to use for sorting the node
  * @param {bool} bAscending Ascending or descending sorting
  * @type int
 */
 XMDManager.prototype.sortCallBack = function(sortType,sortTag,bAscending) {
 
 	var fTypeCast = String;
 	var asc = bAscending;
 
 	switch(sortType) {
 		case "numeric":
 			fTypeCast = toNumber;
 			break;
 		case "date":
 			fTypeCast = toYear;
 			break;
 		default:
 			fTypeCast = CaseInsensitiveString;
 	}
 
 	var me = this;
 	return function (a,b) {
 
 		var col1 = me.getSingleElement(a,sortTag);
 		var col2 = me.getSingleElement(b,sortTag);
 
 		var text1 = "";
 		var text2 = "";
 
 		if(col1) {text1 = col1;}
 		if(col2) {text2 = col2;}
 
 		//Sort Tag SalesRank remove decimal separator
 		if(sortTag == "SalesRank") {
 			text1 = text1.replace(/,/g,"");
 			text1 = text1.replace(/\./g,"");
 
 			text2 = text2.replace(/,/g,"");
 			text2 = text2.replace(/\./g,"");
 		}
 
 		if (fTypeCast(text1) < fTypeCast(text2)) {
 			return asc ? -1 : 1;
 		} else if (fTypeCast(text1) > fTypeCast(text2)) {
 			return asc ? 1 : -1;
 		}else{
 			return 0;
 		}
 	};
 }