/* *******************************************************************
incCookiesAPI.js
Functions For Client Side Cookies Manipulation
-scott 5/26/06
******************************************************************** */

// -------------------------------------------------------------------
// gfunSetCookie(name, value, expires, path, domain, secure)
// set a cookie value and set its properties
// name - name of the cookie
// value - value of the cookie
// [expires] - expiration date of the cookie (defaults to end of current session)
// [path] - path for which the cookie is valid (defaults to path of calling document)
// [domain] - domain for which the cookie is valid (defaults to domain of calling document)
// [secure] - Boolean value indicating if the cookie transmission requires a secure transmission
// * an argument defaults when it is assigned null as a placeholder
// * a null placeholder is not required for trailing omitted arguments
// -------------------------------------------------------------------
function gfunSetCookie(name, value, expires, path, domain, secure) {
  var curCookie = name + "=" + escape(value) +
      ((expires) ? "; expires=" + expires.toGMTString() : "") +
      ((path) ? "; path=" + path : "") +
      ((domain) ? "; domain=" + domain : "") +
      ((secure) ? "; secure" : "");
  document.cookie = curCookie;
}


// -------------------------------------------------------------------
// gfunGetCookie(name)
// Gets the Value of a Cookie
// name - name of the desired cookie
// * return string containing value of specified cookie or null if cookie does not exist
// -------------------------------------------------------------------
function gfunGetCookie(name) {
	var dc = document.cookie;
	var prefix = name + "=";
	var begin = dc.indexOf("; " + prefix);
	if (begin == -1) {
		begin = dc.indexOf(prefix);
		if (begin != 0) return null;
	}
	else {
		begin += 2;
	}
	
	var end = document.cookie.indexOf(";", begin);
	if (end == -1) end = dc.length;

	return unescape(dc.substring(begin + prefix.length, end));
}


// -------------------------------------------------------------------
// gfunGetSubCookie(sCookieName, sKeyName)
// Gets the Value of a Sub-Cookie
// name - name of the desired cookie
// key - Name of the key inside the cookie for the value
// * return string containing value of specified cookie or null if cookie does not exist
// -------------------------------------------------------------------
function gfunGetSubCookie(sCookieName, sKeyName) {
	var sValue = gfunGetCookie(sCookieName);
	if (sValue == null) return null;
	var nKeyPos = sValue.indexOf(sKeyName + "=");
	
	if (nKeyPos == -1) return null;
	else { // Key Exists
	
		nKeyPos = nKeyPos+sKeyName.length+1;
		
		//Remove Leading Characters
		sValue = sValue.substr(nKeyPos);
		
		// Remove Trailing Information
		var nNextAmp = sValue.indexOf("&");
		var nNextEqual = (nNextAmp > -1) ? sValue.indexOf("=", nNextAmp) : -1;
		
		if (nNextAmp > -1 && nNextEqual > nNextAmp) {
			sValue = sValue.substr(0,nNextEqual);
			var nAmpPos = sValue.lastIndexOf("&");
			sValue = sValue.substr(0,nAmpPos);
		}
		
		return sValue;
	}
}

// -------------------------------------------------------------------
// ******* REQUIRES incStringAPI.js ********
// gfunSetSubCookie(sCookieName, sKeyName, value, expires, path, domain, secure)
// set a cookie value and set its properties
// name - name of the desired cookie
// key - Name of the key inside the cookie for the value
// value - value of the cookie
// [expires] - expiration date of the cookie (defaults to end of current session)
// [path] - path for which the cookie is valid (defaults to path of calling document)
// [domain] - domain for which the cookie is valid (defaults to domain of calling document)
// [secure] - Boolean value indicating if the cookie transmission requires a secure transmission
// * an argument defaults when it is assigned null as a placeholder
// * a null placeholder is not required for trailing omitted arguments
// -------------------------------------------------------------------
function gfunSetSubCookie(sCookieName, sKeyName, value, expires, path, domain, secure) {
  var sSubValue = "&" + sKeyName + "=" + value;
  var sCurValue = gfunGetCookie(sCookieName);
  if (sCurValue == null || sCurValue == "") sCurValue = sSubValue;
  else if (sCurValue.indexOf("&" + sKeyName + "=") == -1) sCurValue += sSubValue;
  else sCurValue = gfunReplaceBetween(sCurValue, "&" + sKeyName + "=", "&", value, false, true, null);

  var curCookie = sCookieName + "=" + escape(sCurValue) +
      ((expires) ? "; expires=" + expires.toGMTString() : "") +
      ((path) ? "; path=" + path : "") +
      ((domain) ? "; domain=" + domain : "") +
      ((secure) ? "; secure" : "");
  document.cookie = curCookie;
}

// -------------------------------------------------------------------
// gfunDeleteCookie(name, path, domain)
// Deletes a Cookie
// name - name of the cookie
// [path] - path of the cookie (must be same as path used to create cookie)
// [domain] - domain of the cookie (must be same as domain used to create cookie)
// * path and domain default if assigned null or omitted if no explicit argument proceeds
// -------------------------------------------------------------------
function gfunDeleteCookie(name, path, domain) {
	if (gfunGetCookie(name)) {
		document.cookie = name + "=" + 
		((path) ? "; path=" + path : "") +
		((domain) ? "; domain=" + domain : "") +
		"; expires=Thu, 01-Jan-70 00:00:01 GMT";
	}
}