TinFormFunctions.js

/*
=============COPYRIGHT============ 
Tin Statement Sender - An I-Did-This prototype for Tin Can API 0.95
Copyright (C) 2012  Andrew Downes

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
<http://www.gnu.org/licenses/>.
*/




function getLRSFromQueryString()
{
	var lrs = $.getUrlVar('lrs');
	if (!(lrs == undefined))
	{
		lrs = JSON.parse(urldecode(lrs));
		for (var i=1;i<lrs.length;i++)
		{
			appendLRS();
		}
		$('#lrs').find('.lrs').each(function(index){
			$(this).find('.endpoint').val(lrs[index].endpoint); 
			$(this).find('.basicLogin').val(lrs[index].login);
			$(this).find('.basicPass').val(lrs[index].pass);
		});
	}
}

function getObjectFromQueryString(objectToGet)
{
	var qString = $.getUrlVar(objectToGet);
	
	if (!(qString == undefined))
	{
		return JSON.parse(urldecode(qString));
	}
	else
	{
		return;
	}
}


function ObjectTypeChanged (event)
{
	var elementId = event.data.elementId;

	//Hide all subsections (if they exist)
	$('#' + elementId).find('.activitySubSection').addClass('displayNone');
	$('#' + elementId).find('.agentSubSection').addClass('displayNone');
	//hide Agent add/remove buttons (used for groups)
	$('#' + elementId).find('.agentAdd').addClass('displayNone');
	$('#' + elementId).find('.agentRemove').addClass('displayNone');

	switch($(this).val())
	{
	case 'Agent':
		//display agentsubsection (if found)
		$('#' + elementId).find('.agentSubSection').removeClass('displayNone');
		//hide group
		$('#' + elementId).find('.group').addClass('displayNone');
		//hide extra agents 
		$('#' + elementId).find('.agent').slice(1).addClass('displayNone')
		//If all agents have been removed (in group mode) then add one. 
		if ($('#' + elementId).find('.agent').length < 1)
		{
			appendAgent(elementId);
		}

	break;
	case 'Group':
	//display agentsubsection (if found)
		$('#' + elementId).find('.agentSubSection').removeClass('displayNone');
		//reveal group
		$('#' + elementId).find('.group').removeClass('displayNone');
		//reveal all agents
		$('#' + elementId).find('.agent').removeClass('displayNone');
		//reveal add/remove buttons
		$('#' + elementId).find('.agentAdd').removeClass('displayNone');
		if ($('#' + elementId).find('.agent').length > 1)
		{
			$('#' + elementId).find('.agentRemove').removeClass('displayNone');
		}
	break;	
	case 'Activity':
		//display activitysubsection (if found)
		$('#' + elementId).find('.activitySubSection').removeClass('displayNone');
	break;
	}

}

function appendLanguageMapOnEvent(event)
{

	appendLanguageMap(event.data.elementId, event.data.propertyClass, event.data.loop, event.data.languageMap)
}

function appendLanguageMap(elementId,propertyClass,loop,languageMap)
{	
	var capitalizedPropertyClass = capitaliseFirstLetter(propertyClass);

	loop = typeof loop !== 'undefined' ? loop : 1;

	for (var i=0;i<loop;i++)
	{
		var propertyCount = $('#' + elementId).parent().find('.' + propertyClass).length;
		var language = typeof languageMap[propertyCount] !== 'undefined' ? languageMap[propertyCount] : "";

		$('#' + elementId + capitalizedPropertyClass + 'ButtonHolder').before('\
			<tr class="' + propertyClass + '">\
				<td class="label">\
					<input type="text" name="' + elementId + capitalizedPropertyClass + 'Key' + propertyCount + '" id="' + elementId + capitalizedPropertyClass + 'Key' + propertyCount + '" value="' + language + '" class="'+ propertyClass + 'Key" />\
				</td>\
				<td>\
					<input type="text" name="' + elementId + capitalizedPropertyClass + 'Value' + propertyCount + '" id="' + elementId + capitalizedPropertyClass + 'Value' + propertyCount + '" class="' + propertyClass + 'Value" />\
				</td>\
			</tr>\
		');

		//Show the '-' button 
		$('#' + elementId + capitalizedPropertyClass + 'Remove').removeClass('displayNone');
	}
}

function appendAgentOnEvent(event)
{
	appendAgent(event.data.elementId)
}

function appendAgent(elementId)
{
	var agentsOnlyCount =  $('#' + elementId).find('.agent').length;
	var propertyCount = agentsOnlyCount + $('#' + elementId).find('.group').length;


	var newAgent = $('\
		<div class="agent">\
				<h3>Agent ' + (agentsOnlyCount + 1) + '</h3>\
				<table>\
					<tr>\
						<td class="label">Name:</td>\
						<td>\
						<input type="text" name="' + elementId + 'Name' + propertyCount + '" id="' + elementId + 'Name' + propertyCount + '" class="name"/>\
						</td>\
					</tr>\
					<tr>\
						<td class="label">\
							<select name="' + elementId + 'FunctionalIdentifierType' + propertyCount + '" id="' + elementId + 'FunctionalIdentifierType' + propertyCount + '" class="functionalIdentifierType">\
								<option value="mbox" selected="selected">mbox</option>\
								<option value="mbox_sha1sum">mbox_sha1sum</option>\
								<option value="openid">openid</option>\
								<option value="account">account</option>\
							</select>\
						</td>\
						<td>\
							<input type="text" name="' + elementId + 'FunctionalIdentifier' + propertyCount + '" id="' + elementId + 'FunctionalIdentifier' + propertyCount + '" class="functionalIdentifier"/>\
						</td>\
					</tr>\
					<tr class="agentAccount displayNone">\
						<td class="label">homePage:</td>\
						<td>\
						<input type="text" name="' + elementId + 'AccountHomePage' + propertyCount + '" id="' + elementId + 'AccountHomePage' + propertyCount + '" class="accountHomePage"/>\
						</td>\
					</tr>\
					<tr class="agentAccount displayNone">\
						<td class="label">name:</td>\
						<td>\
						<input type="text" name="' + elementId + 'AccountName' + propertyCount + '" id="' + elementId + 'AccountName' + propertyCount + '" class="accountName"/>\
						</td>\
					</tr>\
				</table>\
			</div>\
	').appendTo('#' + elementId);

	$('#' + elementId + 'FunctionalIdentifierType' + propertyCount).change(function(){
		if ($(this).val() == 'account')
		{
			$(this).closest('table').find('.agentAccount').removeClass('displayNone');
			$('#' + elementId + 'FunctionalIdentifier' + propertyCount).addClass('displayNone');
		}
		else
		{
			$(this).closest('table').find('.agentAccount').addClass('displayNone');
			$('#' + elementId + 'FunctionalIdentifier' + propertyCount).removeClass('displayNone');
		}
	});


	//If this is a group, ensure the removeAgent button is visible if there are more than 1 agent
	if (($('#'+elementId).parent().find('.objectType').val() == 'Group') && (agentsOnlyCount > 0))
	{
		$('#' + elementId  + 'Remove').removeClass('displayNone');
	}



	return newAgent;
}

function appendGroup(elementId)
{
	//Create an Agent
	var Group = appendAgent(elementId);
	var GroupIndex = Group.index($('#'+elementId).find('.agent'));
	//change its class
	Group.removeClass('agent').addClass('group');
	//change its heading
	Group.find('h3').text('Group Details');
	return Group;
}


function appendLRS()
{
	var lrsCount = $('.lrs').length;

	var newLrs = $('\
		<div class="lrs">\
				<h3>LRS '+ (lrsCount + 1) + '</h3>\
				<table>\
					<tr>\
						<td class="label">Endpoint:</td>\
						<td>\
						<input type="text" name="endpoint'+ lrsCount + '" id="endpoint'+ lrsCount + '" class="required endpoint"/>\
						</td>\
					</tr>\
					<tr>\
						<td class="label">Basic Login:</td>\
						<td>\
						<input type="text" name="basicLogin'+ lrsCount + '" id="basicLogin'+ lrsCount + '" class="required basicLogin" />\
						</td>\
					</tr>\
					<tr>\
						<td class="label">Basic Password:</td>\
						<td>\
						<input type="text" name="basicPass'+ lrsCount + '" id="basicPass'+ lrsCount + '" class="required basicPass"/>\
						</td>\
					</tr>\
				</table>\
			</div>\
	').appendTo('#lrs');

	//Show the '-LRS' button if there is now more than 1 LRS
	if (lrsCount > 0)
	{
		$('#lrsLrsRemove').removeClass('displayNone');
	}
	return newLrs;
}


function removeProperty(event)
{	
	//get paremters
	var elementId = event.data.elementId;
	var propertyClass = event.data.propertyClass;

	//get and count elements
	var propertyArray = $('#' + elementId).find('.' + propertyClass),
	propertyCount = propertyArray.length;

	//Hide the '-' button if this function will reduce us to the minimum
	if (propertyCount < (event.data.minimum + 2))
	{
		$('#' + elementId).parent().find('.' +  propertyClass + 'Remove').addClass('displayNone');
	}

	//start at the top and loop through LRSes
	propertyArray.each(function(index){
		//if lrs fields are empty or we have reached last lrs
		if (index == (propertyCount-1))
		{
			//TODO: add Are you sure?
			$(this).remove();
		}
		else if (areAllInputsEmpty($(this)))
		{
			//shuffle all values up one item
			bubbleInputValuesUp(propertyArray.slice(index));
			//remove the last item
			$(propertyArray[propertyCount-1]).remove();
		}
	});
}

//Checks if all inputs within a Jquery Object are empty
function areAllInputsEmpty(jqueryObjectToTest)
{
	var allEmpty = true;
	jqueryObjectToTest.find("input[type=text]").each(function(index){
		if (!($(this).val() == ""))
		{
			allEmpty = false;
		}
	});

	//TODO: check other input types and selects

	return allEmpty;

}

function bubbleInputValuesUp(objectArray)
{
	//first pass - Get all values
	var valuesArray = new Array();	
	objectArray.each(function(objectArrayIndex){
		//if not first item
		if (!(objectArrayIndex==0))
		{
			valuesArray[objectArrayIndex] = new Array();	
			$(this).find("input[type=text]").each(function(inputIndex){
				valuesArray[objectArrayIndex][inputIndex] = $(this).val();
			});
		}
	});

	//second pass - Set values
	var objectArrayLength  = objectArray.length;
	objectArray.each(function(objectArrayIndex){
		//if not last item
		if (!(objectArrayIndex==(objectArrayLength-1)))
		{
			valuesArray[objectArrayIndex] = new Array();	
			$(this).find("input[type=text]").each(function(inputIndex){
				$(this).val(valuesArray[objectArrayIndex + 1][inputIndex]);
			});
		}
	});

}

function getActor(jQueryAgent,objectType)
{
	//default to agent
	objectType = typeof objectType !== 'undefined' ? objectType : 'Agent';
	var rtnActor;
	var rtnActorFunctionalIdentifierType = jQueryAgent.find('.functionalIdentifierType').val();
	if (rtnActorFunctionalIdentifierType == 'account')
	{
		rtnActor= new TinCan[objectType]({
			name : jQueryAgent.find('.name').val(),
			account: {
				name:jQueryAgent.find('.accountHomePage').val(),
				homePage:jQueryAgent.find('.accountName').val()
			}
		});
	}
	else if (rtnActorFunctionalIdentifierType == 'mbox')
	{
		rtnActor= new TinCan[objectType]({
			name : jQueryAgent.find('.name').val(),
			mbox : jQueryAgent.find('.functionalIdentifier').val()
		});
	}
	else
	{
		rtnActor= new TinCan[objectType]({
		name : jQueryAgent.find('.name').val()
		});
		rtnActor[rtnActorFunctionalIdentifierType] = jQueryAgent.find('.functionalIdentifier').val();
	}
	rtnActor.objectType = objectType;
	return rtnActor;
}


//=====================UTILITY FUNCTIONS==============

function getLangFromMapInGBOrDefault (languageMap){
	var defaultLang;
	for (var lang in languageMap) {
	    defaultLang = lang;
	    break;
	}
	return (languageMap['en-GB']) ? languageMap['en-GB'] : languageMap[lang];
}


//removes any empty properties 
function deleteEmptyProperties(objectToTest)
{

    if (typeof objectToTest=="object"){
        for (i in objectToTest) {
            if (objectToTest[i] == null || objectToTest[i] == "" || (JSON.stringify(objectToTest[i])=="{}")) {
                delete objectToTest[i];
            }
            else {
                deleteEmptyProperties(objectToTest[i]);
            }
        }
    }
	return objectToTest;
}

function capitaliseFirstLetter(string)
{
    return string.charAt(0).toUpperCase() + string.slice(1);
}

function urldecode(str) {
   return decodeURIComponent((str+'').replace(/\+/g, '%20'));
}

$.extend({
  getUrlVars: function(){
    var vars = [], hash;
    var hashes = window.location.href.slice(window.location.href.indexOf('?') + 1).split('&');
    for(var i = 0; i < hashes.length; i++)
    {
      hash = hashes[i].split('=');
      vars.push(hash[0]);
      vars[hash[0]] = hash[1];
    }
    return vars;
  },
  getUrlVar: function(name){
    return $.getUrlVars()[name];
  }
});