Core.lua

--- Define the Rotation Builder main Object.
RotationBuilder = {

	-- Technical version of rotation builder.
	version = 1,

	-- If we need to clean up the user installation with this revision.
	needCleanUp = true,

	-- serializer tool for import/export funtionality.
	serializer = nil,

	-- The list of rotations generator.
	defaultRotationGenerator = {},

	-- If we seek a multi-target rotation.
	multiTargetEnabled = false,

	-- TODO Vladilen : We set custom case 1 as enabled by default
	customCase = {
		case1 = true,
		case2 = false,
	},
};

--- Import a rotation.
-- Unserialize a string as a Rotation and import it.
-- @param #string serializedRotation the serialized Rotation to import.
function RotationBuilder:importRotation(serializedRotation)
	if (not self.serializer) then
		-- Initialize the libraries when needed.
		self:initialize();
	end

	-- Deserialize
	local hasWork, addonName, rotationName, deSerialized = self.serializer:Deserialize(serializedRotation);

	-- Verify
	if(hasWork and (addonName == "RotationBuilder")) then
		if (not rotationName) then
			-- No rotation name found.
			print(RotationBuilderUtils:localize('ROB_UI_IMPORT_ERROR1'));
			return
		end
		if (ROB_Rotations[rotationName]) then
			-- A rotation with the same name already exist.
			print(RotationBuilderUtils:localize('ROB_UI_IMPORT_ERROR2')..":"..rotationName);
			return
		end

		local tempRotation = RotationBuilderUtils:restoreTable({}, deSerialized);
		ROB_Rotations[rotationName] = tempRotation;

		-- update rotation list
		ROB_SortRotationList();

		-- update the action list
		ROB_ActionList_Update();

		-- sort spell lists
		ROB_SortSpellLists();

		-- sort spells
		ROB_SortSpells();

		-- update the spells list
		ROB_SpellList_Update();

		-- update rotation modify buttons
		ROB_RotationModifyButtons_UpdateUI();

		-- update rotation ui stuff
		ROB_Rotation_Edit_UpdateUI();

		print(RotationBuilderUtils:localize('ROB_UI_IMPORT_SUCCESS')..":"..rotationName);
	else
		-- Not a rotation builder import.
		print(RotationBuilderUtils:localize('ROB_UI_IMPORT_ERROR3'));
	end
end

--- Export a rotation.
-- Serialize a Rotation as a string for export purpose.
-- @param #string rotationName the name of the rotation to export.
-- @return #string the exported rotation as a String.
function RotationBuilder:exportRotation(rotationName)
	-- Verify.
	-- TODO PEL : We need to localize these messages.
	if ((not rotationName) or (rotationName == "")) then
		print("No rotation name specified for export")
		return
	end

	local tempRotationData = ROB_Rotations[rotationName];
	if (not tempRotationData) then
		print("Rotation name must be the name of an rotation build, and is case-sensitive."..rotationName)
		return
	end

	if (not self.serializer) then
		-- Initialize the libraries when needed.
		self:initialize();
	end

	-- We must clean-up the data before serializing them.
	local toSerialize = RotationBuilderUtils:copyTable(tempRotationData, true);

	--@do-not-package@
	-- Register export information for development purpose.
	ROB_Exports[rotationName] = toSerialize;
	--@end-do-not-package@

	-- Serializing
	local rotation = self.serializer:Serialize("RotationBuilder", rotationName, toSerialize);
	return rotation;
end

--- Register a rotations generator for a class.
-- @param #string className the class for which we want to add a rotation generator.
-- @param #function method the method which will generate the rotation.
function RotationBuilder:addDefaultRotationsGenerator(className, method)
	if(not className or not method) then
		print("className or method is nil.");
		return
	end
	if (self.defaultRotationGenerator[className]) then
		-- TODO PEL : Localized this error message.
		print("Override rotations generator for "..className);
	end

	-- Register the generator.
	self.defaultRotationGenerator[className] = method;
end

--- Load default rotations for a class.
-- @param #String className the name of the class for which we must load default rotations.
function RotationBuilder:loadDefaultRotations(className)
	if (not self.defaultRotationGenerator[className]) then
		-- TODO PEL : Localized this error message.
		print("No data available for "..className);
		return
	end

	-- Load default rotations for this class.
	local defaultRotation = self.defaultRotationGenerator[className]["generator"]();
	for key, value in pairs(defaultRotation) do
		if(not ROB_Rotations[key] or not ROB_Rotations[key]["version"] or ROB_Rotations[key]["version"] < value["version"]) then
			-- The rotation don't exist or is older, then we can import the rotation.
			ROB_Rotations[key] = value;
		end
	end
end

--- Check if this is a newer RotationBuilder add-on and upgrade default rotation if possible.
function RotationBuilder:cleanUpInstallationOnNeed()
	local oldVersion = ROB_Options["version"];
	local newVersion = RotationBuilder["version"];
	if(not oldVersion or (oldVersion < newVersion and (RotationBuilder["needCleanUp"] or oldVersion + 1 < newVersion))) then
		-- We need do clean up RotationBuilder.
		ROB_Options = {};
		ROB_Rotations = {};
		ROB_Exports = {};
		print(RotationBuilderUtils:localize('message/core/fullCleanUp'));
	end
	ROB_Options["version"] = newVersion;
end

--- Find a rotation by its specialization.
-- @param #Int specializationID: the specialization ID for which we seek a rotation.
-- @return #String the name of the rotation.
function RotationBuilder:findRotationBySpecializationID(specializationID)
	if (not ROB_Rotations or not specializationID) then
		-- If no rotation is defined, then return nil.
		return nil;
	end
	local tmpRotation = nil;
	for key, value in pairs(ROB_Rotations) do
		if (value["specID"] == specializationID) then
			if(value["isMultiTarget"] and RotationBuilder["multiTargetEnabled"]) then
				return key;
			end
			if(not value["isMultiTarget"] and not RotationBuilder["multiTargetEnabled"]) then
				return key;
			end
			tmpRotation = key;
		end
	end
	return tmpRotation;
end

function RotationBuilder:isCustomCase1Enable()
	return self.customCase.case1;
end

function RotationBuilder:isCustomCase2Enable()
	return self.customCase.case2;
end

--- Initialize the RotationBuilder Object.
function RotationBuilder:initialize()
	self.serializer = LibStub:GetLibrary("AceSerializer-3.0");
end