// ShareMaestro Export Script
// load("ShareMaestro.ss"); ShareMaestro.ExportData();

var ShareMaestro = {};

ShareMaestro.ExportData = function()
{
	var portNames = getPortfolioNames();
	var dlg = new Dialog("Export to ShareMaestro", 200,60);
	dlg.addOkButton();
	dlg.addCancelButton();
	dlg.addDropList("portname", -1,-1,-1,-1, portNames, "Portfolio:");
	dlg.addTextEdit("filename", -1,-1,-1,-1, "Ouput File:", "", "ShareMaestro.csv");
	if (dlg.show() == Dialog.Cancel)
		return;

	var portName = portNames[dlg.getValue("portname")];
	var fileName = dlg.getValue("filename");

	this.sectorYieldCache = {};

	// parameters for beta calculation
	this.betaIndex = getShare("UKI:UKX");
	this.betaPeriod = 250;	// trading days - roughly 1 year

	var shares = getPortfolio(portName);

	var f = new File(fileName, File.WriteMode);
	this.OutputSummaryData(f);
	for (var i=0; i<shares.length; i++)
		this.OutputShareData(f,shares[i]);
	f.close();

	print("Export complete.");
}

ShareMaestro.OutputSummaryData = function(file)
{
	var str;
	var ukx = getShare("UKI:UKX");	// ftse 100
	var date = ukx.getPrice().date;

	str = "\"" + ukx.getName() + "\"" + ",";
	str += date.getDate() + "/" + (date.getMonth() + 1) + "/" + (date.getYear()+1900) + ",";
	str += ukx.getClose().toFixed(1) + ",,,,,";

	file.writeLine(str);
}

ShareMaestro.OutputShareData = function(file, share)
{
	var str;

/* ===================================================================
	Share Name
   =================================================================== */
	str = "\"" + share.getName() + "\"" + ",";

/* ===================================================================
	Sector Name
   =================================================================== */
	var sectorName = share.getSector();
	str += "\"" + sectorName + "\"" + ",";

/* ===================================================================
	Sector Yield
	- Calculates yield for the sector across the FTSE All Share List
	- dividend for each share in sector calculated using FTSE method
   =================================================================== */
	str += this.GetSectorYield(sectorName).toFixed(2) + ",";

/* ===================================================================
	Yield
	- using year end dividend
	- empty field if no figure
   =================================================================== */
	var div0 = share.getResult(0, Result.Dividend);
	if (div0 != undefined)
		str += (div0/share.getClose()*100).toFixed(2);
	str += ",";

/* ===================================================================
	Close
   =================================================================== */
	str += share.getClose().toFixed(2) + ",";

/* ===================================================================
	Last Price Date
   =================================================================== */
	var date = share.getPrice().date;
	str += date.getDate() + "/" + (date.getMonth() + 1) + "/" + (date.getYear()+1900) + ",";

/* ===================================================================
	EPIC
   =================================================================== */
	str += share.getEPIC() + ",";

/* ===================================================================
	Beta
	Custom beta function (defined below)
	NB - returns undefined for shares not currently trading
   =================================================================== */
	var beta = this.Beta(share, this.betaIndex, this.betaPeriod);
	if (beta != undefined)
		str += beta.toFixed(2);
	str += ",";

/* ===================================================================
	Most Recent Dividend
	- same total div figure as Yield above
 	- empty field if no figure
  =================================================================== */
	if (div0 != undefined)
		str += div0.toFixed(2);
	str += ",";

/* ===================================================================
	1 yr Div Growth %
   =================================================================== */
	var div1 = share.getResult(1, Result.Dividend);
	if (div0 != undefined && div0 != 0 && div1 != undefined)
		str += ((div1 - div0)/div0*100).toFixed(1);
	str += ",";

/* ===================================================================
	2 yr Div Growth %
   =================================================================== */
	var div2 = share.getResult(2, Result.Dividend);
	if (div1 != undefined && div1 != 0 && div2 != undefined)
		str += ((div2 - div1)/div1*100).toFixed(1);
	str += ",";

/* ===================================================================
	3 yr Div Growth %
   =================================================================== */
	var div3 = share.getResult(3, Result.Dividend);
	if (div2 != undefined && div2 != 0 && div3 != undefined)
		str += ((div3 - div2)/div2*100).toFixed(1);
	str += ",";

/* ===================================================================
	2 yr Forecast Div
   =================================================================== */
	if (div2 != undefined)
		str += div2.toFixed(2);
	str += ",";

/* ===================================================================
	2 yr Forecast EPS
   =================================================================== */
	var eps2 = share.getResult(2, Result.EPS);
	if (eps2 != undefined)
		str += eps2.toFixed(2);
	str += ",";

/* ===================================================================
	3 yr Forecast Div
   =================================================================== */
	if (div3 != undefined)
		str += div3.toFixed(2);
	str += ",";

/* ===================================================================
	3 yr Forecast EPS
   =================================================================== */
	var eps3 = share.getResult(3, Result.EPS);
	if (eps3 != undefined)
		str += eps3.toFixed(2);
	str += ",";


	file.writeLine(str);
}

// Helper functions below

ShareMaestro.GetFTSECalcDiv = function(share)
{
	// FTSE style dividend
	// total of dividends over the last year, not the year-end dividend

	// last total year-end dividend
	var divTotal = share.getResult(0,Result.Dividend);

	// look to see if any newer ones in the current year
	var resType = share.getResultArray(1,Result.ResultType);
	var resDiv = share.getResultArray(1,Result.Dividend);
	var type = -1;
	var thisYearsValue = 0;
	for (var i = 0; i < resType.length; i++)
	{
		if (resType[i] == ResultType.Forecast)
			break;
		else if (resType[i] != ResultType.Special)
		{
			type = resType[i];
			thisYearsValue = resDiv[i];
		}
	}
	if (type == -1)
	{
		// no divs for current year
		// just return the year end total for last year
		return divTotal
	}
	else
	{
		// try to find this div type in the previous year
		resType = share.getResultArray(0,Result.ResultType);
		resDiv = share.getResultArray(0,Result.Dividend);

		for (var i = 0; i < resType.length; i++)
		{
			if (resType[i] == type)
			{
				// return the year-end total plus the difference between the 2 years figures
				// up to this point
				return divTotal + (thisYearsValue - resDiv[i]);
			}
		}
		// obviously couldn't find it (e.g. switch from 2 -> 4 divs per year)
		return divTotal;
	}
}

ShareMaestro.GetSectorYield = function(sectorName)
{
	if (!this.sectorYieldCache[sectorName])
	{
		// sector div yield calculation
		// we cache the result in hash for later lookups on the same sector

		var ftseAllShare = getList(List.FTSEAllShare);
		var sectorList = [];
		var totalCap = 0;
		for (var i = 0; i < ftseAllShare.length; i++)
		{
			var item = ftseAllShare[i];
			if (item.getSector() == sectorName)
				sectorList.push(item);
		}
		var sectorYield = 0;
		for (var i = 0; i < sectorList.length; i++)
		{
			var itemDiv = this.GetFTSECalcDiv(sectorList[i]);
			if (!itemDiv) itemDiv = 0;
			var itemClose = sectorList[i].getClose();
			var itemCap = sectorList[i].getCap();
			totalCap += itemCap;

			sectorYield += (itemDiv/itemClose*100)*itemCap;
		}
		sectorYield /= totalCap;
		this.sectorYieldCache[sectorName] = sectorYield;
	}
	return this.sectorYieldCache[sectorName];
}

ShareMaestro.Beta = function(share, index, period)
{
	// both data-sets need to end on the same day
	if (share.getPrice().dateNum != index.getPrice().dateNum)
		return undefined;

	var shareC = share.getCloseArray(period+1);

	// adjust the period for the data we've actually got
	period = shareC.length-1;
	if (period < 20)
		return undefined;

	var indexC = index.getCloseArray(period+1);

	// calculate the deltas
	var X = [];
	var Y = [];

	for (var i=0; i<period; i++)
	{
		X[i] = (indexC[i+1]-indexC[i]) / indexC[i];
		Y[i] = (shareC[i+1]-shareC[i]) / shareC[i];
	}
	
	// calculate the regression slope
	var sumXY = 0, sumX = 0, sumY = 0, sumXX = 0;
	for (var i=0; i<period; i++)
	{
		sumX += X[i];
		sumXX += X[i] * X[i];
		sumXY += X[i] * Y[i];
		sumY += Y[i];
	}
	var sXY = period * sumXY - sumX * sumY;
	var sXX = period * sumXX - sumX * sumX;
	return sXY/sXX;
}